Summary:

Add inline help text for hosting services in Admin ADD REPOSITORY page.

Review Request #10890 — Created Feb. 6, 2020 and updated March 7, 2020, 11:49 a.m.

Information
Owner:	xiaole2
Repository:	Review Board
Branch:	master
Bugs:
Depends On:	10872
Reviewers
Groups:	reviewboard
People:

Description

Create docs_url and summary attributes in class HostingService and SCMTools. 
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 with class="hosting-help-text" in the template for the RepositoryForm 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 with class="repo-help-text" in the template for the RepositoryForm 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.

Testing Done

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	Author
Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
modify the coding format, remove trailing space	XiaoleZ
Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ
updatethe formate	XiaoleZ
remove trailing space for repositoryform.es6.js	XiaoleZ
remove unicode(), replace html() with text(), add tag <a>	XiaoleZ
clean code	XiaoleZ
change repositoryform.js	XiaoleZ
remove trailing space	XiaoleZ
add ;	XiaoleZ
implementating scmtools	XiaoleZ
rebase from the master/setup repoHelp show() condition	XiaoleZ
fix line too long	XiaoleZ

Screenshots

Files

Issues

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	Feb. 9, 2020, 6:22 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 6, 2020, 6:57 p.m.
E501 line too long (111 > 79 characters)	reviewbot	Feb. 6, 2020, 6:57 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 6, 2020, 7:01 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 6, 2020, 7:01 p.m.
E501 line too long (113 > 79 characters)	reviewbot	Feb. 6, 2020, 7:01 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 6, 2020, 7:01 p.m.
E501 line too long (113 > 79 characters)	reviewbot	Feb. 6, 2020, 7:02 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 6, 2020, 7:03 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 6, 2020, 7:03 p.m.
E501 line too long (116 > 79 characters)	reviewbot	Feb. 6, 2020, 7:03 p.m.
E501 line too long (123 > 79 characters)	reviewbot	Feb. 6, 2020, 7:03 p.m.
E501 line too long (127 > 79 characters)	reviewbot	Feb. 6, 2020, 7:03 p.m.
E501 line too long (129 > 79 characters)	reviewbot	Feb. 6, 2020, 7:03 p.m.
E501 line too long (127 > 79 characters)	reviewbot	Feb. 6, 2020, 7:04 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 6, 2020, 7:04 p.m.
E501 line too long (120 > 79 characters)	reviewbot	Feb. 6, 2020, 7:04 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 6, 2020, 7:05 p.m.
E501 line too long (107 > 79 characters)	reviewbot	Feb. 6, 2020, 7:05 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 6, 2020, 7:05 p.m.
E501 line too long (107 > 79 characters)	reviewbot	Feb. 6, 2020, 7:05 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 6, 2020, 7:06 p.m.
E501 line too long (107 > 79 characters)	reviewbot	Feb. 6, 2020, 7:06 p.m.
E302 expected 2 blank lines, found 1	reviewbot	Feb. 6, 2020, 7:06 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 6, 2020, 7:07 p.m.
E501 line too long (113 > 79 characters)	reviewbot	Feb. 6, 2020, 7:07 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 6, 2020, 7:07 p.m.
E501 line too long (117 > 79 characters)	reviewbot	Feb. 6, 2020, 7:07 p.m.
W293 blank line contains whitespace	reviewbot	Feb. 6, 2020, 7:08 p.m.
E501 line too long (117 > 79 characters)	reviewbot	Feb. 6, 2020, 7:08 p.m.
These will need to all be localized using ugettext_lazy() (often aliased as _() -- see the imports in each file).	chipx86	Feb. 9, 2020, 6:22 p.m.
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	Feb. 9, 2020, 6:21 p.m.
.toggle() isn't safe to use. You want an explicit hide() or show().	chipx86	Feb. 9, 2020, 6:22 p.m.
E225 missing whitespace around operator	reviewbot	Feb. 9, 2020, 6:36 p.m.
E225 missing whitespace around operator	reviewbot	Feb. 9, 2020, 6:34 p.m.
E225 missing whitespace around operator	reviewbot	Feb. 9, 2020, 6:34 p.m.
E225 missing whitespace around operator	reviewbot	Feb. 9, 2020, 6:33 p.m.
E225 missing whitespace around operator	reviewbot	Feb. 9, 2020, 6:33 p.m.
E225 missing whitespace around operator	reviewbot	Feb. 9, 2020, 6:33 p.m.
E225 missing whitespace around operator	reviewbot	Feb. 9, 2020, 6:33 p.m.
E225 missing whitespace around operator	reviewbot	Feb. 9, 2020, 6:32 p.m.
Col: 40 Missing semicolon.	reviewbot	Feb. 9, 2020, 6:31 p.m.
Col: 76 Missing semicolon.	reviewbot	Feb. 9, 2020, 6:31 p.m.
Col: 81 Missing semicolon.	reviewbot	Feb. 9, 2020, 6:31 p.m.
Anything inside a _(...) must be a pure string literal, no string formatting allowed. This is because the localization text …	chipx86	Feb. 11, 2020, 11:07 a.m.
You'll just want to use _(...), not unicode(_(...)). In fact, this is a syntax error on Python 3 (unicode is …	chipx86	Feb. 11, 2020, 11:53 a.m.
We're not going to want HTML in this. We might be rendering to HTML in the case of this form, …	chipx86	Feb. 11, 2020, 7:09 p.m.
I don't think we need this variable. The code for the form should be responsible for determining how we're representating/linking …	chipx86	Feb. 11, 2020, 6:18 p.m.
You'll want to use %s instead of + for building strings.	chipx86	Feb. 11, 2020, 5:22 p.m.
Col: 34 Missing semicolon.	reviewbot	Feb. 11, 2020, 7:11 p.m.
Col: 26 Missing semicolon.	reviewbot	Feb. 11, 2020, 7:11 p.m.
E501 line too long (93 > 79 characters)	reviewbot	March 7, 2020, 11:49 a.m.

flake8 failed.

JSHint passed.

flake8

reviewboard/hostingsvcs/assembla.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
reviewboard/hostingsvcs/assembla.py (Diff revision 1)
Show all issues
```
E501 line too long (111 > 79 characters)
```
reviewboard/hostingsvcs/beanstalk.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
reviewboard/hostingsvcs/beanstalk.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
reviewboard/hostingsvcs/beanstalk.py (Diff revision 1)
Show all issues
```
E501 line too long (113 > 79 characters)
```
reviewboard/hostingsvcs/bitbucket.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
reviewboard/hostingsvcs/bitbucket.py (Diff revision 1)
Show all issues
```
E501 line too long (113 > 79 characters)
```
reviewboard/hostingsvcs/codebasehq.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
reviewboard/hostingsvcs/codebasehq.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
reviewboard/hostingsvcs/codebasehq.py (Diff revision 1)
Show all issues
```
E501 line too long (116 > 79 characters)
```
reviewboard/hostingsvcs/fake.py (Diff revision 1)
Show all issues
```
E501 line too long (123 > 79 characters)
```
reviewboard/hostingsvcs/fake.py (Diff revision 1)
Show all issues
```
E501 line too long (127 > 79 characters)
```
reviewboard/hostingsvcs/fake.py (Diff revision 1)
Show all issues
```
E501 line too long (129 > 79 characters)
```
reviewboard/hostingsvcs/fake.py (Diff revision 1)
Show all issues
```
E501 line too long (127 > 79 characters)
```
reviewboard/hostingsvcs/fedorahosted.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
reviewboard/hostingsvcs/fedorahosted.py (Diff revision 1)
Show all issues
```
E501 line too long (120 > 79 characters)
```
reviewboard/hostingsvcs/gerrit.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
reviewboard/hostingsvcs/gerrit.py (Diff revision 1)
Show all issues
```
E501 line too long (107 > 79 characters)
```
reviewboard/hostingsvcs/github.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
reviewboard/hostingsvcs/github.py (Diff revision 1)
Show all issues
```
E501 line too long (107 > 79 characters)
```
reviewboard/hostingsvcs/gitlab.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
reviewboard/hostingsvcs/gitlab.py (Diff revision 1)
Show all issues
```
E501 line too long (107 > 79 characters)
```
reviewboard/hostingsvcs/gitorious.py (Diff revision 1)
Show all issues
```
E302 expected 2 blank lines, found 1
```
reviewboard/hostingsvcs/gitorious.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
reviewboard/hostingsvcs/gitorious.py (Diff revision 1)
Show all issues
```
E501 line too long (113 > 79 characters)
```
reviewboard/hostingsvcs/sourceforge.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
reviewboard/hostingsvcs/sourceforge.py (Diff revision 1)
Show all issues
```
E501 line too long (117 > 79 characters)
```
reviewboard/hostingsvcs/unfuddle.py (Diff revision 1)
Show all issues
```
W293 blank line contains whitespace
```
reviewboard/hostingsvcs/unfuddle.py (Diff revision 1)
Show all issues
```
E501 line too long (117 > 79 characters)
```

Change Summary:

fix the code format, remove the trailing space

Commits:

	Summary	Author
-	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
+	change tip to rb-c-tip, remove comment out code	XiaoleZ

Diff:

Revision 2 (+6 -32)

Show changes

	reviewboard/static/rb/css/pages/newReviewRequest.less
	reviewboard/static/rb/css/ui/tips.less
	reviewboard/static/rb/js/newReviewRequest/views/preCommitView.es6.js

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Status: Discarded

Change Summary:

will create a new review. too much format issue

Status: Re-opened

Testing Done:

Testing locally, but it gives me a undesired form.

Commits:

	Summary	Author
-	change tip to rb-c-tip, remove comment out code	XiaoleZ
+	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
+	modify the coding format, remove trailing space	XiaoleZ

Diff:

Revision 3 (+580 -52)

Show changes

	reviewboard/hostingsvcs/assembla.py
	reviewboard/hostingsvcs/beanstalk.py
	reviewboard/hostingsvcs/bitbucket.py
	reviewboard/hostingsvcs/codebasehq.py
	reviewboard/hostingsvcs/fake.py
	reviewboard/hostingsvcs/fedorahosted.py
	reviewboard/hostingsvcs/forms.py
	reviewboard/hostingsvcs/gerrit.py
	6 more

Added Files:

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

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 each `hosting service`
	~	Create `hosting_inline_help_text` attribute in class `HostingService`.
	+
	+	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 with `class="hosting_inline_help_text"` in the template for the `RepositoryForm` 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	Author
-	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
-	modify the coding format, remove trailing space	XiaoleZ
+	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
+	modify the coding format, remove trailing space	XiaoleZ
+	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
+	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ

Depends On:

+	10872 - Add a CSS component for tip

Diff:

Revision 4 (+653 -281)

Show changes

	reviewboard/hostingsvcs/assembla.py
	reviewboard/hostingsvcs/beanstalk.py
	reviewboard/hostingsvcs/bitbucket.py
	reviewboard/hostingsvcs/codebasehq.py
	reviewboard/hostingsvcs/fake.py
	reviewboard/hostingsvcs/fedorahosted.py
	reviewboard/hostingsvcs/gerrit.py
	reviewboard/hostingsvcs/github.py
	7 more

Removed Files:

Added Files:

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

remove [WIP] for the title

Summary:

-	WIP Add inline help text for hosting services.
+	Add inline help text for hosting services in Admin ADD REPOSITORY page.

Show all issues

Good start!

I still want to see this as two attributes: summary and docs_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.

reviewboard/hostingsvcs/assembla.py (Diff revision 4)

Show all issues

These will need to all be localized using ugettext_lazy() (often aliased as _() -- see the imports in each file).

reviewboard/hostingsvcs/assembla.py (Diff revision 4)

Show all issues

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. See reviewboard/__init__.py for the definition of that function.

reviewboard/static/rb/js/admin/repositoryform.es6.js (Diff revision 4)
Show all issues
```
.toggle() isn't safe to use. You want an explicit hide() or show().
```

Change Summary:


Splite inline_help_text into two attributes(summary + support_docs). 
Set docs_url as another attribute (use from reviewboard import get_manual_url())
Change toggle() into hide() and show()
Use ugettext_lazy() as _() for text

Commits:

	Summary	Author
-	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
-	modify the coding format, remove trailing space	XiaoleZ
-	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
-	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
+	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
+	modify the coding format, remove trailing space	XiaoleZ
+	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
+	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
+	split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ

Diff:

Revision 5 (+1035 -431)

Show changes

	reviewboard/hostingsvcs/assembla.py
	reviewboard/hostingsvcs/beanstalk.py
	reviewboard/hostingsvcs/bitbucket.py
	reviewboard/hostingsvcs/codebasehq.py
	reviewboard/hostingsvcs/fake.py
	reviewboard/hostingsvcs/fedorahosted.py
	reviewboard/hostingsvcs/gerrit.py
	reviewboard/hostingsvcs/github.py
	8 more

Checks run (2 failed)

flake8 failed.

JSHint failed.

flake8

reviewboard/hostingsvcs/codebasehq.py (Diff revision 5)
Show all issues
```
E225 missing whitespace around operator
```
reviewboard/hostingsvcs/fake.py (Diff revision 5)
Show all issues
```
E225 missing whitespace around operator
```
reviewboard/hostingsvcs/fake.py (Diff revision 5)
Show all issues
```
E225 missing whitespace around operator
```
reviewboard/hostingsvcs/gerrit.py (Diff revision 5)
Show all issues
```
E225 missing whitespace around operator
```
reviewboard/hostingsvcs/github.py (Diff revision 5)
Show all issues
```
E225 missing whitespace around operator
```
reviewboard/hostingsvcs/gitlab.py (Diff revision 5)
Show all issues
```
E225 missing whitespace around operator
```
reviewboard/hostingsvcs/sourceforge.py (Diff revision 5)
Show all issues
```
E225 missing whitespace around operator
```
reviewboard/hostingsvcs/unfuddle.py (Diff revision 5)
Show all issues
```
E225 missing whitespace around operator
```

JSHint

reviewboard/static/rb/js/admin/repositoryform.es6.js (Diff revision 5)
Show all issues
```
Col: 40
 Missing semicolon.
```
reviewboard/static/rb/js/admin/repositoryform.es6.js (Diff revision 5)
Show all issues
```
Col: 76
 Missing semicolon.
```
reviewboard/static/rb/js/admin/repositoryform.es6.js (Diff revision 5)
Show all issues
```
Col: 81
 Missing semicolon.
```

Change Summary:

fix code style

Commits:

	Summary	Author
-	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
-	modify the coding format, remove trailing space	XiaoleZ
-	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
-	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
-	split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ
+	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
+	modify the coding format, remove trailing space	XiaoleZ
+	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
+	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
+	split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ
+	updatethe formate	XiaoleZ

Diff:

Revision 6 (+1046 -442)

Show changes

	reviewboard/hostingsvcs/assembla.py
	reviewboard/hostingsvcs/beanstalk.py
	reviewboard/hostingsvcs/bitbucket.py
	reviewboard/hostingsvcs/codebasehq.py
	reviewboard/hostingsvcs/fake.py
	reviewboard/hostingsvcs/fedorahosted.py
	reviewboard/hostingsvcs/gerrit.py
	reviewboard/hostingsvcs/github.py
	8 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

remove a trailing space in repositoryform.es6.js

Commits:

	Summary	Author
-	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
-	modify the coding format, remove trailing space	XiaoleZ
-	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
-	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
-	split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ
-	updatethe formate	XiaoleZ
+	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
+	modify the coding format, remove trailing space	XiaoleZ
+	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
+	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
+	split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ
+	updatethe formate	XiaoleZ
+	remove trailing space for repositoryform.es6.js	XiaoleZ

Diff:

Revision 7 (+1047 -443)

Show changes

	reviewboard/hostingsvcs/assembla.py
	reviewboard/hostingsvcs/beanstalk.py
	reviewboard/hostingsvcs/bitbucket.py
	reviewboard/hostingsvcs/codebasehq.py
	reviewboard/hostingsvcs/fake.py
	reviewboard/hostingsvcs/fedorahosted.py
	reviewboard/hostingsvcs/gerrit.py
	reviewboard/hostingsvcs/github.py
	8 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

reviewboard/hostingsvcs/assembla.py (Diff revision 7)

Show all issues

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.

reviewboard/hostingsvcs/assembla.py (Diff revision 7)

Show all issues

You'll just want to use _(...), not unicode(_(...)).
In fact, this is a syntax error on Python 3 (unicode is not a usable keyword).

reviewboard/hostingsvcs/assembla.py (Diff revision 7)

Show all issues

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.

xiaole2 Feb. 11, 2020, 11:52 a.m.

I wonder what API we are using? how to add it in the API? does the file means the data already in the API?
We want to the plain text for the summary. And in the RepositoryForm.js we render this text in HTML-based?

chipx86 Feb. 11, 2020, 2:33 p.m.

Review Board exposes an API that's used by a number of things, including Review Board itself, third-party clients, automation scripts, etc. This all lives in reviewboard/webapi/. As part of this project, in an upcoming step, I'm going to have you add a field in the API to show the summary (this would live in reviewboard/webapi/resources/hosting_service.py). This would allow clients of the API to list all hosting services and see their summaries (alongside the information we already provide).

The JavaScript for the repository form will render this text. It will treat it as plain text, not HTML (so, you'd use .text(...) to set it on an element instead of .html(...)).

chipx86 Feb. 11, 2020, 2:49 p.m.

Oh, and you may want to see the documentation (and example payloads) for the API, to get a sense of what kind of stuff we expose.

reviewboard/hostingsvcs/assembla.py (Diff revision 7)

Show all issues

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.

xiaole2 Feb. 11, 2020, 11:52 a.m.

So I need to determine how to link the url in repositoryform.js?
If it has docs_url, then render the information as About %s repository in Review Board

chipx86 Feb. 11, 2020, 2:33 p.m.

I would just call the link something like "Learn More", but yes. repositoryform.js would be responsible for building the <a> tag for this, plugging in the docs URL.

reviewboard/hostingsvcs/assembla.py (Diff revision 7)

Show all issues

You'll want to use %s instead of + for building strings.

Change Summary:

remove unicode(), replace html() with text(), add tag <a>

Description:

~		Create `hosting_inline_help_text` attribute in class `HostingService`.
	~	Create `docs_url` and `summary` attributes in class `HostingService`.

		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 with `class="hosting_inline_help_text"` in the template for the `RepositoryForm` 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	Author
-	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
-	modify the coding format, remove trailing space	XiaoleZ
-	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
-	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
-	split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ
-	updatethe formate	XiaoleZ
-	remove trailing space for repositoryform.es6.js	XiaoleZ
+	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
+	modify the coding format, remove trailing space	XiaoleZ
+	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
+	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
+	split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ
+	updatethe formate	XiaoleZ
+	remove trailing space for repositoryform.es6.js	XiaoleZ
+	remove unicode(), replace html() with text(), add tag <a>	XiaoleZ
+	clean code	XiaoleZ
+	change repositoryform.js	XiaoleZ
+	remove trailing space	XiaoleZ

Diff:

Revision 8 (+1066 -640)

Show changes

	reviewboard/hostingsvcs/assembla.py
	reviewboard/hostingsvcs/beanstalk.py
	reviewboard/hostingsvcs/bitbucket.py
	reviewboard/hostingsvcs/codebasehq.py
	reviewboard/hostingsvcs/fake.py
	reviewboard/hostingsvcs/gerrit.py
	reviewboard/hostingsvcs/github.py
	reviewboard/hostingsvcs/gitlab.py
	9 more

Removed Files:

Added Files:

Checks run (1 failed, 1 succeeded)

flake8 passed.

JSHint failed.

JSHint

reviewboard/static/rb/js/admin/repositoryform.es6.js (Diff revision 8)
Show all issues
```
Col: 34
 Missing semicolon.
```
reviewboard/static/rb/js/admin/repositoryform.es6.js (Diff revision 8)
Show all issues
```
Col: 26
 Missing semicolon.
```

Change Summary:

add ; in repositoryform.es6.js

Commits:

	Summary	Author
-	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
-	modify the coding format, remove trailing space	XiaoleZ
-	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
-	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
-	split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ
-	updatethe formate	XiaoleZ
-	remove trailing space for repositoryform.es6.js	XiaoleZ
-	remove unicode(), replace html() with text(), add tag <a>	XiaoleZ
-	clean code	XiaoleZ
-	change repositoryform.js	XiaoleZ
-	remove trailing space	XiaoleZ
+	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
+	modify the coding format, remove trailing space	XiaoleZ
+	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
+	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
+	split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ
+	updatethe formate	XiaoleZ
+	remove trailing space for repositoryform.es6.js	XiaoleZ
+	remove unicode(), replace html() with text(), add tag <a>	XiaoleZ
+	clean code	XiaoleZ
+	change repositoryform.js	XiaoleZ
+	remove trailing space	XiaoleZ
+	add ;	XiaoleZ

Diff:

Revision 9 (+1068 -642)

Show changes

	reviewboard/hostingsvcs/assembla.py
	reviewboard/hostingsvcs/beanstalk.py
	reviewboard/hostingsvcs/bitbucket.py
	reviewboard/hostingsvcs/codebasehq.py
	reviewboard/hostingsvcs/fake.py
	reviewboard/hostingsvcs/gerrit.py
	reviewboard/hostingsvcs/github.py
	reviewboard/hostingsvcs/gitlab.py
	9 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Change Summary:

Add inline help for SCMTools

Description:

~		Create `docs_url` and `summary` attributes in class `HostingService`.
	~	Create `docs_url` and `summary` attributes in class `HostingService` and `SCMTools`.

		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 with `class="hosting_inline_help_text"` in the template for the `RepositoryForm` 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 with `class="hosting-help-text"` in the template for the `RepositoryForm` 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 with `class="repo-help-text"` in the template for the `RepositoryForm` 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	Author
-	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
-	modify the coding format, remove trailing space	XiaoleZ
-	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
-	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
-	split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ
-	updatethe formate	XiaoleZ
-	remove trailing space for repositoryform.es6.js	XiaoleZ
-	remove unicode(), replace html() with text(), add tag <a>	XiaoleZ
-	clean code	XiaoleZ
-	change repositoryform.js	XiaoleZ
-	remove trailing space	XiaoleZ
-	add ;	XiaoleZ
+	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
+	modify the coding format, remove trailing space	XiaoleZ
+	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
+	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
+	split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ
+	updatethe formate	XiaoleZ
+	remove trailing space for repositoryform.es6.js	XiaoleZ
+	remove unicode(), replace html() with text(), add tag <a>	XiaoleZ
+	clean code	XiaoleZ
+	change repositoryform.js	XiaoleZ
+	remove trailing space	XiaoleZ
+	add ;	XiaoleZ
+	implementating scmtools	XiaoleZ
+	rebase from the master/setup repoHelp show() condition	XiaoleZ

Diff:

Revision 10 (+1295 -663)

Show changes

	reviewboard/hostingsvcs/assembla.py
	reviewboard/hostingsvcs/beanstalk.py
	reviewboard/hostingsvcs/bitbucket.py
	reviewboard/hostingsvcs/codebasehq.py
	reviewboard/hostingsvcs/fake.py
	reviewboard/hostingsvcs/gerrit.py
	reviewboard/hostingsvcs/github.py
	reviewboard/hostingsvcs/gitlab.py
	17 more

Removed Files:

Added Files:

Checks run (1 failed, 1 succeeded)

flake8 failed.

JSHint passed.

flake8

reviewboard/scmtools/clearcase.py (Diff revision 10)
Show all issues
```
E501 line too long (93 > 79 characters)
```

Change Summary:

fix line too long

Commits:

	Summary	Author
-	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
-	modify the coding format, remove trailing space	XiaoleZ
-	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
-	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
-	split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ
-	updatethe formate	XiaoleZ
-	remove trailing space for repositoryform.es6.js	XiaoleZ
-	remove unicode(), replace html() with text(), add tag <a>	XiaoleZ
-	clean code	XiaoleZ
-	change repositoryform.js	XiaoleZ
-	remove trailing space	XiaoleZ
-	add ;	XiaoleZ
-	implementating scmtools	XiaoleZ
-	rebase from the master/setup repoHelp show() condition	XiaoleZ
+	Introduce attributes into HostingService and fill them in each hosting service	XiaoleZ
+	modify the coding format, remove trailing space	XiaoleZ
+	Create hosting-inline-help-text attribute in HostingService, and fill details in each hosting services. Update template for the RepositoryForm file	XiaoleZ
+	Remove extra () for import, and remove InlineHelpTextBase Class(wrong direction)	XiaoleZ
+	split inline_help_text into two attributes, change toggle() into hide() and show()	XiaoleZ
+	updatethe formate	XiaoleZ
+	remove trailing space for repositoryform.es6.js	XiaoleZ
+	remove unicode(), replace html() with text(), add tag <a>	XiaoleZ
+	clean code	XiaoleZ
+	change repositoryform.js	XiaoleZ
+	remove trailing space	XiaoleZ
+	add ;	XiaoleZ
+	implementating scmtools	XiaoleZ
+	rebase from the master/setup repoHelp show() condition	XiaoleZ
+	fix line too long	XiaoleZ

Diff:

Revision 11 (+1297 -665)

Show changes

	reviewboard/hostingsvcs/assembla.py
	reviewboard/hostingsvcs/beanstalk.py
	reviewboard/hostingsvcs/bitbucket.py
	reviewboard/hostingsvcs/codebasehq.py
	reviewboard/hostingsvcs/fake.py
	reviewboard/hostingsvcs/gerrit.py
	reviewboard/hostingsvcs/github.py
	reviewboard/hostingsvcs/gitlab.py
	17 more

Checks run (2 succeeded)

flake8 passed.

JSHint passed.