Summary

Add documentation for custom review request fields.

Review Request #9298 — Created Oct. 20, 2017 and submitted Oct. 24, 2017, 4:25 p.m.

Information

Owner

david

Repository

Review Board

Branch

release-3.0.x

Bugs

Depends On

Blocks

9310

Commit

2bd3a68...

Reviewers

Groups

reviewboard

People

Description

This change adds some more complete documentation for adding new review request
fields, which is likely to be a very common use case for extensions.

Testing Done

Built HTML and looked through the output.

Issues

Description	From	Last Updated
This looks great. It would be nice to show sample usage for each of the built-in types, though, to help …	chipx86	Oct. 20, 2017, 10:47 p.m.
You can use :js:class: here.	chipx86	Oct. 20, 2017, 10:42 p.m.
Should be in Title Casing.	chipx86	Oct. 20, 2017, 10:42 p.m.
Can we link these to the definitions on the base class?	chipx86	Oct. 20, 2017, 10:42 p.m.

flake8 passed.

JSHint passed.

The issue has been resolved. Show all issues

This looks great. It would be nice to show sample usage for each of the built-in types, though, to help cut back on questions or problems as people go to play with these. Ideally, we'd have a small section on the usage for each of these.

Also ideally, we'd have a section on crafting a completely custom field, since that's probably going to come up somewhere. Maybe less beneficial compared to the sample usages for the built-in types, but would be good to have.

david Oct. 20, 2017, 10:52 p.m.

There are so many directions that a completely custom field might go in that I'm not sure a sample is really that useful. That said, the example with selectize is probably a good enough start for anyone who actually has the skills to do something crazy.

docs/manual/extending/extensions/review-request-fields.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
You can use :js:class: here.
```
docs/manual/extending/extensions/review-request-fields.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Should be in Title Casing.
```
docs/manual/extending/extensions/review-request-fields.rst (Diff revision 1)
The issue has been resolved. Show all issues
```
Can we link these to the definitions on the base class?
```

Commit:

4e5bdf85d52e112c259e453faac501d0f9b3063e

2bd3a68e90d8c9349b4b9ed9c792c011909b1933

Diff:

Revision 2 (+188 -12)

Show changes

	docs/manual/extending/index.rst
	docs/manual/extending/extensions/review-request-fields.rst
	docs/manual/extending/extensions/hooks/review-request-fields-hook.rst
	docs/manual/extending/extensions/hooks/review-request-fieldsets-hook.rst

Checks run (2 succeeded)

flake8 passed.

JSHint passed.

Ship it!

```
Ship It!
```

Status:: Completed
Change Summary:: Pushed to release-3.0.x (e1a23c0)