flake8
passed.
JSHint
passed.
Add documentation for integrations.
Review Request #9322 — Created Oct. 24, 2017 and submitted
This change adds documentation for the top-level integrations UI, as
well as configuration docs for the three integrations shipped in
rb-integrations: CircleCI, Slack, and Travis CI.
- Built HTML and checked the output.
- Spell check.
| Description | From | Last Updated |
|---|---|---|
|
Looks good overall. Some small comments to reduce the density of some paragraphs (people tend to skim). Would you be … |
 chipx86
|
|
|
Maybe swap these? The order here will dictate navigation order in the sidebar (and maybe we'll want to rethink some … |
chipx86
|
|
|
Maybe break "We recommend creating ..." into its own paragraph, since people tend to skim. Might be worth putting this … |
chipx86
|
|
|
Can we reference the RBTools docs here? |
chipx86
|
|
|
Can we also add a section showing an example configuration? I wouldn't know where to begin without seeing one. |
chipx86
|
|
|
In another review I brought up adding a glossary.rst term for CI. Can we have that item cover both CI … |
chipx86
|
|
|
The "should not include any secrets" bit is important enough to stand out as a .. warning:: |
chipx86
|
-
-
Looks good overall. Some small comments to reduce the density of some paragraphs (people tend to skim).
Would you be up to adding screenshots showing the integrations page and some configuration for Travis/CI, so people can get a visual as they're setting things up?
-
docs/manual/admin/index.rst (Diff revision 1) Maybe swap these? The order here will dictate navigation order in the sidebar (and maybe we'll want to rethink some of the existing order here...)
-
docs/manual/admin/integrations/circle-ci.rst (Diff revision 1) Maybe break "We recommend creating ..." into its own paragraph, since people tend to skim. Might be worth putting this into a
.. note::. -
docs/manual/admin/integrations/circle-ci.rst (Diff revision 1) Can we reference the RBTools docs here?
-
docs/manual/admin/integrations/travis-ci.rst (Diff revision 1) Can we also add a section showing an example configuration? I wouldn't know where to begin without seeing one.
-
docs/manual/admin/integrations/travis-ci.rst (Diff revision 1) In another review I brought up adding a glossary.rst term for CI. Can we have that item cover both CI and Continuous Integration, and use
:term:here? Just for those who might be in here and don't understand what this is. -
docs/manual/admin/integrations/travis-ci.rst (Diff revision 1) The "should not include any secrets" bit is important enough to stand out as a
.. warning::
Commit: |
|
||||
|---|---|---|---|---|---|
Diff: |
Revision 2 (+286 -1) |
Checks run (2 succeeded)
flake8
passed.
JSHint
passed.