Add inline help text for hosting services in Admin ADD REPOSITORY page.
Review Request #10890 — Created Feb. 6, 2020 and updated
Create
docs_url
andsummary
attributes in classHostingService
andSCMTools
.Fill details in each hosting services (not include Kiln On Demand and Review Board Gateway, because right now we don't have references provided by ReviewBoard Manual.
Hosting Servive:
$hostingHelp
is a new paragraph withclass="hosting-help-text"
in the template for theRepositoryForm
javascript file. By default,$hostingHelp
will nonvisiable. When users select a hosting service, the inline text will show up.SCMTools:
$repoHelp
is a new paragraph withclass="repo-help-text"
in the template for theRepositoryForm
javascript file. Only when a user click 'custom' as the hosting service,$repoHelp
will visiable. When users select a repo type, the inline text will show up.
Tested in Google Chrome, Firefox and Safari. Inline Text of each hosting service displays correctly in the page.
Tested./tests/runtests.py reviewboard.webapi.tests.test_hosting_service
successfully.
Summary | ID | Author |
---|---|---|
1b72a08149f11e6c10cfe2ede34c6b5c6ff81f59 | XiaoleZ | |
ff9892ee229fcf88e61a52d1c1585f1ca6640da4 | XiaoleZ | |
8b11f3fb2b0b57c56d2c52a756dabd3540f410d9 | XiaoleZ | |
514034994660be775f6422f2d8feb9a3c298a988 | XiaoleZ | |
0a771b3367d344f5af053ce91074542aa2c8ed89 | XiaoleZ | |
d38b3e429225957b79c37d669c1887d7eb2d89e0 | XiaoleZ | |
1f67103471963d3ac64207f41429c3bf21091099 | XiaoleZ | |
e3def9304b6606ae125bf87f0f438028c3939dfe | XiaoleZ | |
6493e05ae787c418b4e4f5c53028411432269814 | XiaoleZ | |
5e407cd4f7180441074e93dd7bfb0789df9ae26d | XiaoleZ | |
1072019e93f36385a7a546e600db7cc7a13f5188 | XiaoleZ | |
07f64c66475ae1d56f98929e2df30950991868ac | XiaoleZ | |
abdbba5ffd7473bc678e4c1582c8ed6b5bc363a2 | XiaoleZ | |
9f18351952ca41754e2db9fcd7e062f88e83d222 | XiaoleZ | |
ba902da46f1edde681e2b4188f6ae08baa5f1c59 | XiaoleZ |
Description | From | Last Updated |
---|---|---|
Good start! I still want to see this as two attributes: summary and docs_url. The form should be able to … |
chipx86 | |
W293 blank line contains whitespace |
reviewbot | |
E501 line too long (111 > 79 characters) |
reviewbot | |
W293 blank line contains whitespace |
reviewbot | |
W293 blank line contains whitespace |
reviewbot | |
E501 line too long (113 > 79 characters) |
reviewbot | |
W293 blank line contains whitespace |
reviewbot | |
E501 line too long (113 > 79 characters) |
reviewbot | |
W293 blank line contains whitespace |
reviewbot | |
W293 blank line contains whitespace |
reviewbot | |
E501 line too long (116 > 79 characters) |
reviewbot | |
E501 line too long (123 > 79 characters) |
reviewbot | |
E501 line too long (127 > 79 characters) |
reviewbot | |
E501 line too long (129 > 79 characters) |
reviewbot | |
E501 line too long (127 > 79 characters) |
reviewbot | |
W293 blank line contains whitespace |
reviewbot | |
E501 line too long (120 > 79 characters) |
reviewbot | |
W293 blank line contains whitespace |
reviewbot | |
E501 line too long (107 > 79 characters) |
reviewbot | |
W293 blank line contains whitespace |
reviewbot | |
E501 line too long (107 > 79 characters) |
reviewbot | |
W293 blank line contains whitespace |
reviewbot | |
E501 line too long (107 > 79 characters) |
reviewbot | |
E302 expected 2 blank lines, found 1 |
reviewbot | |
W293 blank line contains whitespace |
reviewbot | |
E501 line too long (113 > 79 characters) |
reviewbot | |
W293 blank line contains whitespace |
reviewbot | |
E501 line too long (117 > 79 characters) |
reviewbot | |
W293 blank line contains whitespace |
reviewbot | |
E501 line too long (117 > 79 characters) |
reviewbot | |
These will need to all be localized using ugettext_lazy() (often aliased as _() -- see the imports in each file). |
chipx86 | |
It's important not to hard-code the full path to the manual. Use reviewboard.get_manual_url() as the base of the URL instead. … |
chipx86 | |
.toggle() isn't safe to use. You want an explicit hide() or show(). |
chipx86 | |
E225 missing whitespace around operator |
reviewbot | |
E225 missing whitespace around operator |
reviewbot | |
E225 missing whitespace around operator |
reviewbot | |
E225 missing whitespace around operator |
reviewbot | |
E225 missing whitespace around operator |
reviewbot | |
E225 missing whitespace around operator |
reviewbot | |
E225 missing whitespace around operator |
reviewbot | |
E225 missing whitespace around operator |
reviewbot | |
Col: 40 Missing semicolon. |
reviewbot | |
Col: 76 Missing semicolon. |
reviewbot | |
Col: 81 Missing semicolon. |
reviewbot | |
Anything inside a _(...) must be a pure string literal, no string formatting allowed. This is because the localization text … |
chipx86 | |
You'll just want to use _(...), not unicode(_(...)). In fact, this is a syntax error on Python 3 (unicode is … |
chipx86 | |
We're not going to want HTML in this. We might be rendering to HTML in the case of this form, … |
chipx86 | |
I don't think we need this variable. The code for the form should be responsible for determining how we're representating/linking … |
chipx86 | |
You'll want to use %s instead of + for building strings. |
chipx86 | |
Col: 34 Missing semicolon. |
reviewbot | |
Col: 26 Missing semicolon. |
reviewbot | |
E501 line too long (93 > 79 characters) |
reviewbot |
- Change Summary:
-
fix the code format, remove the trailing space
- Commits:
-
Summary ID Author 6e041e667ff739f34161b329fdcfc8295dd790fc XiaoleZ d63df935491bb1c3dbe6f51dd8a794ba44aaced1 XiaoleZ
Checks run (2 succeeded)
- Status:
- Re-opened
- Testing Done:
-
+ Testing locally, but it gives me a undesired form.
- Commits:
-
Summary ID Author d63df935491bb1c3dbe6f51dd8a794ba44aaced1 XiaoleZ 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ - Diff:
-
Revision 3 (+580 -52)
- Added Files:
Checks run (2 succeeded)
- Change Summary:
-
Create hosting-inline-help-text attribute in HostingService, fill details in each hosting service, and update the template in
RepositoryForm
. - Description:
-
~ Introduce attributes into
HostingService
and fill them in eachhosting service
~ Create
hosting_inline_help_text
attribute in classHostingService
.+ + Fill details in each hosting services (not include Kiln On Demand and Review Board Gateway, because right now we don't have references provided by ReviewBoard Manual.
+ + $inlineHelpText
is a new paragraph withclass="hosting_inline_help_text"
in the template for theRepositoryForm
javascript file. By default,$inlineHelpText
will nonvisiable. When users select a hosting service, the inline text will show up. - Testing Done:
-
~ Testing locally, but it gives me a undesired form.
~ Tested in Google Chrome and Firefox. Inline Text of each hosting service displays correctly in the page.
- Commits:
-
Summary ID Author 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ 6cb402906f926367ee30ffe61f73aa17d04ce5f6 XiaoleZ 7f93220ec2ee97ebb9fa47f23e88f44454bff4ff XiaoleZ - Depends On:
-
- Diff:
Revision 4 (+653 -281)
- Removed Files:
- Added Files:
Checks run (2 succeeded)
flake8 passed.JSHint passed.
-
-
Good start!
I still want to see this as two attributes:
summary
anddocs_url
. The form should be able to handle either, both, or none of those values, and should have a standard link (probably as a paragraph following the summary) for linking to the documentation. -
These will need to all be localized using
ugettext_lazy()
(often aliased as_()
-- see the imports in each file). -
It's important not to hard-code the full path to the manual. Use
reviewboard.get_manual_url()
as the base of the URL instead. Seereviewboard/__init__.py
for the definition of that function. -
- Change Summary:
-
- Splite inline_help_text into two attributes(
summary
+support_docs
). - Set
docs_url
as another attribute (usefrom reviewboard import get_manual_url()
) - Change toggle() into hide() and show()
- Use
ugettext_lazy() as _()
for text
- Splite inline_help_text into two attributes(
- Commits:
-
Summary ID Author 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ 6cb402906f926367ee30ffe61f73aa17d04ce5f6 XiaoleZ 7f93220ec2ee97ebb9fa47f23e88f44454bff4ff XiaoleZ 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ 6cb402906f926367ee30ffe61f73aa17d04ce5f6 XiaoleZ 7f93220ec2ee97ebb9fa47f23e88f44454bff4ff XiaoleZ 8242552d4f4691d61596b590906154783ea0a3c7 XiaoleZ - Diff:
-
Revision 5 (+1035 -431)
Checks run (2 failed)
flake8
JSHint
- Change Summary:
-
fix code style
- Commits:
-
Summary ID Author 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ 6cb402906f926367ee30ffe61f73aa17d04ce5f6 XiaoleZ 7f93220ec2ee97ebb9fa47f23e88f44454bff4ff XiaoleZ 8242552d4f4691d61596b590906154783ea0a3c7 XiaoleZ 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ 6cb402906f926367ee30ffe61f73aa17d04ce5f6 XiaoleZ 7f93220ec2ee97ebb9fa47f23e88f44454bff4ff XiaoleZ 8242552d4f4691d61596b590906154783ea0a3c7 XiaoleZ b703e2486808e1c198ca85311a75bb0eeefea6b2 XiaoleZ - Diff:
-
Revision 6 (+1046 -442)
Checks run (2 succeeded)
- Change Summary:
-
remove a trailing space in repositoryform.es6.js
- Commits:
-
Summary ID Author 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ 6cb402906f926367ee30ffe61f73aa17d04ce5f6 XiaoleZ 7f93220ec2ee97ebb9fa47f23e88f44454bff4ff XiaoleZ 8242552d4f4691d61596b590906154783ea0a3c7 XiaoleZ b703e2486808e1c198ca85311a75bb0eeefea6b2 XiaoleZ 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ 6cb402906f926367ee30ffe61f73aa17d04ce5f6 XiaoleZ 7f93220ec2ee97ebb9fa47f23e88f44454bff4ff XiaoleZ 8242552d4f4691d61596b590906154783ea0a3c7 XiaoleZ b703e2486808e1c198ca85311a75bb0eeefea6b2 XiaoleZ e91a5a5ccb7b8fdf722ad29c8450652bedb2af23 XiaoleZ - Diff:
-
Revision 7 (+1047 -443)
Checks run (2 succeeded)
-
-
Anything inside a
_(...)
must be a pure string literal, no string formatting allowed. This is because the localization text scanner is going to look for strings inside of_(...)
and include those directly. So we can't ever use% ...
here.In the case of a URL, there's nothing to localize anyway, so we don't need to use
_(...)
, but the above applies to the other strings. -
You'll just want to use
_(...)
, notunicode(_(...))
.In fact, this is a syntax error on Python 3 (
unicode
is not a usable keyword). -
We're not going to want HTML in this. We might be rendering to HTML in the case of this form, but there's no guarantee that we'll be using this for HTML. For instance, we'll want to provide this in the API, which isn't HTML-based.
We also don't need to use
%s
here for the name. Just including "Assembla" verbatim is fine. -
I don't think we need this variable. The code for the form should be responsible for determining how we're representating/linking to the URL, not this class.
-
- Change Summary:
-
remove unicode(), replace html() with text(), add tag <a>
- Description:
-
~ Create
hosting_inline_help_text
attribute in classHostingService
.~ Create
docs_url
andsummary
attributes in classHostingService
.Fill details in each hosting services (not include Kiln On Demand and Review Board Gateway, because right now we don't have references provided by ReviewBoard Manual.
$inlineHelpText
is a new paragraph withclass="hosting_inline_help_text"
in the template for theRepositoryForm
javascript file. By default,$inlineHelpText
will nonvisiable. When users select a hosting service, the inline text will show up. - Testing Done:
-
~ Tested in Google Chrome and Firefox. Inline Text of each hosting service displays correctly in the page.
~ Tested in Google Chrome, Firefox and Safari. Inline Text of each hosting service displays correctly in the page.
+ Tested ./tests/runtests.py reviewboard.webapi.tests.test_hosting_service
successfully. - Commits:
-
Summary ID Author 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ 6cb402906f926367ee30ffe61f73aa17d04ce5f6 XiaoleZ 7f93220ec2ee97ebb9fa47f23e88f44454bff4ff XiaoleZ 8242552d4f4691d61596b590906154783ea0a3c7 XiaoleZ b703e2486808e1c198ca85311a75bb0eeefea6b2 XiaoleZ e91a5a5ccb7b8fdf722ad29c8450652bedb2af23 XiaoleZ 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ 6cb402906f926367ee30ffe61f73aa17d04ce5f6 XiaoleZ 7f93220ec2ee97ebb9fa47f23e88f44454bff4ff XiaoleZ 8242552d4f4691d61596b590906154783ea0a3c7 XiaoleZ b703e2486808e1c198ca85311a75bb0eeefea6b2 XiaoleZ e91a5a5ccb7b8fdf722ad29c8450652bedb2af23 XiaoleZ e5949471c53b9657c8e3dc524852a55238e6e1a3 XiaoleZ bd7a239ad3794236edec692506ad9ab96ca09427 XiaoleZ 1553bc047b737bda55e18c64c5445c46083ac4c5 XiaoleZ 7d4c990c50f7c9f1667dbfca7d0fe1421097055c XiaoleZ - Diff:
-
Revision 8 (+1066 -640)
- Removed Files:
- Added Files:
- Change Summary:
-
add ; in
repositoryform.es6.js
- Commits:
-
Summary ID Author 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ 6cb402906f926367ee30ffe61f73aa17d04ce5f6 XiaoleZ 7f93220ec2ee97ebb9fa47f23e88f44454bff4ff XiaoleZ 8242552d4f4691d61596b590906154783ea0a3c7 XiaoleZ b703e2486808e1c198ca85311a75bb0eeefea6b2 XiaoleZ e91a5a5ccb7b8fdf722ad29c8450652bedb2af23 XiaoleZ e5949471c53b9657c8e3dc524852a55238e6e1a3 XiaoleZ bd7a239ad3794236edec692506ad9ab96ca09427 XiaoleZ 1553bc047b737bda55e18c64c5445c46083ac4c5 XiaoleZ 7d4c990c50f7c9f1667dbfca7d0fe1421097055c XiaoleZ 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ 6cb402906f926367ee30ffe61f73aa17d04ce5f6 XiaoleZ 7f93220ec2ee97ebb9fa47f23e88f44454bff4ff XiaoleZ 8242552d4f4691d61596b590906154783ea0a3c7 XiaoleZ b703e2486808e1c198ca85311a75bb0eeefea6b2 XiaoleZ e91a5a5ccb7b8fdf722ad29c8450652bedb2af23 XiaoleZ e5949471c53b9657c8e3dc524852a55238e6e1a3 XiaoleZ bd7a239ad3794236edec692506ad9ab96ca09427 XiaoleZ 1553bc047b737bda55e18c64c5445c46083ac4c5 XiaoleZ 7d4c990c50f7c9f1667dbfca7d0fe1421097055c XiaoleZ c48807c335087689e3343ccfcb06845c868de0bf XiaoleZ - Diff:
-
Revision 9 (+1068 -642)
Checks run (2 succeeded)
- Change Summary:
-
Add inline help for SCMTools
- Description:
-
~ Create
docs_url
andsummary
attributes in classHostingService
.~ Create
docs_url
andsummary
attributes in classHostingService
andSCMTools
.Fill details in each hosting services (not include Kiln On Demand and Review Board Gateway, because right now we don't have references provided by ReviewBoard Manual.
~ $inlineHelpText
is a new paragraph withclass="hosting_inline_help_text"
in the template for theRepositoryForm
javascript file. By default,$inlineHelpText
will nonvisiable. When users select a hosting service, the inline text will show up.~ -
Hosting Servive:
$hostingHelp
is a new paragraph withclass="hosting-help-text"
in the template for theRepositoryForm
javascript file. By default,$hostingHelp
will nonvisiable. When users select a hosting service, the inline text will show up.
+ -
SCMTools:
$repoHelp
is a new paragraph withclass="repo-help-text"
in the template for theRepositoryForm
javascript file. Only when a user click 'custom' as the hosting service,$repoHelp
will visiable. When users select a repo type, the inline text will show up.
-
- Commits:
-
Summary ID Author 2a6ccd1291ce4a7ee0e6daa476581746918ec8db XiaoleZ 6f7e5929a9e6e17194154ead49c1851c70b9d6b1 XiaoleZ 6cb402906f926367ee30ffe61f73aa17d04ce5f6 XiaoleZ 7f93220ec2ee97ebb9fa47f23e88f44454bff4ff XiaoleZ 8242552d4f4691d61596b590906154783ea0a3c7 XiaoleZ b703e2486808e1c198ca85311a75bb0eeefea6b2 XiaoleZ e91a5a5ccb7b8fdf722ad29c8450652bedb2af23 XiaoleZ e5949471c53b9657c8e3dc524852a55238e6e1a3 XiaoleZ bd7a239ad3794236edec692506ad9ab96ca09427 XiaoleZ 1553bc047b737bda55e18c64c5445c46083ac4c5 XiaoleZ 7d4c990c50f7c9f1667dbfca7d0fe1421097055c XiaoleZ c48807c335087689e3343ccfcb06845c868de0bf XiaoleZ 1b72a08149f11e6c10cfe2ede34c6b5c6ff81f59 XiaoleZ ff9892ee229fcf88e61a52d1c1585f1ca6640da4 XiaoleZ 8b11f3fb2b0b57c56d2c52a756dabd3540f410d9 XiaoleZ 514034994660be775f6422f2d8feb9a3c298a988 XiaoleZ 0a771b3367d344f5af053ce91074542aa2c8ed89 XiaoleZ d38b3e429225957b79c37d669c1887d7eb2d89e0 XiaoleZ 1f67103471963d3ac64207f41429c3bf21091099 XiaoleZ e3def9304b6606ae125bf87f0f438028c3939dfe XiaoleZ 6493e05ae787c418b4e4f5c53028411432269814 XiaoleZ 5e407cd4f7180441074e93dd7bfb0789df9ae26d XiaoleZ 1072019e93f36385a7a546e600db7cc7a13f5188 XiaoleZ 07f64c66475ae1d56f98929e2df30950991868ac XiaoleZ abdbba5ffd7473bc678e4c1582c8ed6b5bc363a2 XiaoleZ 9f18351952ca41754e2db9fcd7e062f88e83d222 XiaoleZ - Diff:
-
Revision 10 (+1295 -663)
- Removed Files:
- Added Files:
- Change Summary:
-
fix line too long
- Commits:
-
Summary ID Author 1b72a08149f11e6c10cfe2ede34c6b5c6ff81f59 XiaoleZ ff9892ee229fcf88e61a52d1c1585f1ca6640da4 XiaoleZ 8b11f3fb2b0b57c56d2c52a756dabd3540f410d9 XiaoleZ 514034994660be775f6422f2d8feb9a3c298a988 XiaoleZ 0a771b3367d344f5af053ce91074542aa2c8ed89 XiaoleZ d38b3e429225957b79c37d669c1887d7eb2d89e0 XiaoleZ 1f67103471963d3ac64207f41429c3bf21091099 XiaoleZ e3def9304b6606ae125bf87f0f438028c3939dfe XiaoleZ 6493e05ae787c418b4e4f5c53028411432269814 XiaoleZ 5e407cd4f7180441074e93dd7bfb0789df9ae26d XiaoleZ 1072019e93f36385a7a546e600db7cc7a13f5188 XiaoleZ 07f64c66475ae1d56f98929e2df30950991868ac XiaoleZ abdbba5ffd7473bc678e4c1582c8ed6b5bc363a2 XiaoleZ 9f18351952ca41754e2db9fcd7e062f88e83d222 XiaoleZ 1b72a08149f11e6c10cfe2ede34c6b5c6ff81f59 XiaoleZ ff9892ee229fcf88e61a52d1c1585f1ca6640da4 XiaoleZ 8b11f3fb2b0b57c56d2c52a756dabd3540f410d9 XiaoleZ 514034994660be775f6422f2d8feb9a3c298a988 XiaoleZ 0a771b3367d344f5af053ce91074542aa2c8ed89 XiaoleZ d38b3e429225957b79c37d669c1887d7eb2d89e0 XiaoleZ 1f67103471963d3ac64207f41429c3bf21091099 XiaoleZ e3def9304b6606ae125bf87f0f438028c3939dfe XiaoleZ 6493e05ae787c418b4e4f5c53028411432269814 XiaoleZ 5e407cd4f7180441074e93dd7bfb0789df9ae26d XiaoleZ 1072019e93f36385a7a546e600db7cc7a13f5188 XiaoleZ 07f64c66475ae1d56f98929e2df30950991868ac XiaoleZ abdbba5ffd7473bc678e4c1582c8ed6b5bc363a2 XiaoleZ 9f18351952ca41754e2db9fcd7e062f88e83d222 XiaoleZ ba902da46f1edde681e2b4188f6ae08baa5f1c59 XiaoleZ - Diff:
-
Revision 11 (+1297 -665)