-
-
I wonder if mentioning Extension Hooks by name this early is more confusing than useful. Maybe something more like: "Review Board's functionality can be enhanced by installing a Review Board Extension. Writing and installing an Extension is an excellent way to tailor Review Board for your exact needs."
-
When you say "conventions", it reminds me - we should mention that we've designed the framework to follow many of Django's conventions.
-
We should mention that when an extension is disabled, tables for models are not dropped. The user would have to use ./reviewboard/manage.py evolve --purge In order to generate evolutions to drop those tables.
Documentation of the extension system
Review Request #2950 — Created March 10, 2012 and submitted
This is the start of documentation for the extension system. I have focused on documenting the status for version 1.7+.
Repeatedly rendered as html while writing. Quick proofreading done.
Description | From | Last Updated |
---|---|---|
I wonder if mentioning Extension Hooks by name this early is more confusing than useful. Maybe something more like: "Review … |
mike_conley | |
When you say "conventions", it reminds me - we should mention that we've designed the framework to follow many of … |
mike_conley | |
We should mention that when an extension is disabled, tables for models are not dropped. The user would have to … |
mike_conley | |
Two blank lines before each section. |
chipx86 | |
"an" Extension. And I'm not sure we need to capitalize Extension everywhere, unless we're referring specifically to the Extension class... |
mike_conley | |
I think there should be a comma after minimum. |
AM ammok | |
Should have a space before the <..> in links. Same for all others. |
chipx86 | |
Might be nice to do "" instead of "sample_extension". Or put it in italics, actually, since that's how the the … |
chipx86 | |
Two blank lines. |
chipx86 | |
Two blank lines. |
chipx86 | |
- Seems like this line was swapped with the next. - Add a comma between 'information' and 'see' |
AM ammok | |
"For" ? |
chipx86 | |
One blank line between each of these. Same for others in the class. |
chipx86 | |
easy to use -> easy-to-use |
mike_conley | |
Two blank lines. |
chipx86 | |
Another thing we could mention, is that evolve is also run programmatically. That way, an extension's models can change over … |
mike_conley | |
When referencing filenames or directories, use :file:`..` |
chipx86 | |
Two blank lines. |
chipx86 | |
This is fine for development installs, but people developing against a Review Board install are likely to use rb-site. In … |
chipx86 | |
I'd say just nuke this if we don't have content yet. |
chipx86 | |
For some documentation on template hooks see: http://code.google.com/p/reviewboard/wiki/Building_Extensions#Adding_a_Template_Hook |
CI cim1 | |
No blank line. |
chipx86 | |
Two blank lines. |
chipx86 | |
Wrapping is funky here. |
chipx86 | |
Two blank lines. |
chipx86 | |
:guilabel:`Configure` |
chipx86 | |
is created? I think we mean "should be created". |
mike_conley | |
:file:`admin_urls.py` |
chipx86 | |
:file: |
chipx86 | |
Two blank lines. |
chipx86 | |
We should link to it. |
chipx86 | |
Should be capitalized. Here and the next entry. Also, only one space. |
chipx86 | |
Use `` for the module name. |
chipx86 | |
Two blank lines. |
chipx86 | |
Alignment is wrong. |
chipx86 | |
:guilabel:`Database` |
chipx86 | |
extensions => extension's |
AM ammok | |
:file: |
chipx86 | |
Link to it. |
chipx86 | |
Two blank lines. |
chipx86 | |
:file: |
chipx86 | |
Two blank lines. |
chipx86 | |
Alignment is wrong. |
chipx86 | |
:file: |
chipx86 | |
Two blank lines. |
chipx86 | |
Two blank lines. |
chipx86 | |
Only one blank line needed. |
chipx86 | |
Two blank lines. |
chipx86 | |
This is only one part of the puzzle - install_requires will ensure that certain packages are installed in order to … |
mike_conley | |
:file: |
chipx86 | |
Two blank lines. |
chipx86 | |
We should be linking to the docs instead of just listing the module. Same at other places. |
chipx86 | |
:file: |
chipx86 | |
Same here about linking. |
chipx86 | |
We should mention that this is part of the Review Board tree, and will require a checkout. (Really, we should … |
chipx86 |
- Change Summary:
-
Added documentation of admin sites, configuration, python eggs. Still need to document Hooks. Updated description and testing done.
- Description:
-
~ This is the start of documentation for the extension system. I have focused on documenting the status for version 1.7+, and assumed /r/2888 and /r/2907 will be part of the codebase.
~ This is the start of documentation for the extension system. I have focused on documenting the status for version 1.7+.
This is currently a WIP
- Testing Done:
-
~ Repeatedly rendered as html while writing. Minimal proofreading done so far.
~ Repeatedly rendered as html while writing. Quick proofreading done.
-
Continues to look good.
-
"an" Extension. And I'm not sure we need to capitalize Extension everywhere, unless we're referring specifically to the Extension class...
-
-
Another thing we could mention, is that evolve is also run programmatically. That way, an extension's models can change over time. The developer just needs to update their model definitions...I don't think they need to enable/disable the extension to trigger the evolve, but you should double-check.
-
-
This is only one part of the puzzle - install_requires will ensure that certain packages are installed in order to make the extension install successful - but it doesn't describe how we can have extensions be dependent on one another. A "requirements" list can be declared in the Extension class that gives the names of extensions that must be enabled in order for this extension to be enabled.
-
The docs look great in general. You're going to see the same few comments from me listed a dozen times each. Just some stylistic stuff, and we should also be better at linking to external docs when we talk about them.
-
-
-
Might be nice to do "<extensiondir>" instead of "sample_extension". Or put it in italics, actually, since that's how the the docs typically indicate something that's to be replaced.
-
-
-
-
-
-
-
-
This is fine for development installs, but people developing against a Review Board install are likely to use rb-site. In that case: rb-site manage /path/to/site evolve -- --purge
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
We should mention that this is part of the Review Board tree, and will require a checkout. (Really, we should turn this generator into a management command, or otherwise make it available externally.)
- Change Summary:
-
Updated based on the reviews.
- Description:
-
This is the start of documentation for the extension system. I have focused on documenting the status for version 1.7+.
- - This is currently a WIP