Opened on 08/16/2017 at 02:47:04 PM
Closed on 12/16/2017 at 09:42:57 AM
#5521 closed change (fixed)
Restructure CMS documentation to make it easier to use and extend
| Reported by: | kvas | Assignee: | ire |
|---|---|---|---|
| Priority: | Unknown | Milestone: | |
| Module: | Sitescripts | Keywords: | |
| Cc: | ire, juliandoucette, jsonesen, wspee | Blocked By: | |
| Blocking: | Platform: | Unknown / Cross platform | |
| Ready: | yes | Confidential: | no |
| Tester: | Unknown | Verified working: | no |
| Review URL(s): | |||
Description
Background
Even though the functionality of CMS is relatively well documented, the included README file is not comprehensive enough for new users or for understanding all details of the intended behavior. At the same time, the content of README is too long and detailed for a readme file. Most people would expect README to give just the basic overview of the software.
Both of these problems can be solved by creating additional documentation pages. Not so basic parts of README could then be moved to such pages and extended with additional details and examples.
What to change
Restructure existing documentation in the README to allow for future growth and extension:
- Create docs/ folder in the root folder.
- Split the non-basic parts (DETERMINE WHICH ONES) of the README out into separate pages in the docs/ folder and link them from the README.
Attachments (0)
Change History (5)
comment:1 Changed on 08/18/2017 at 07:50:07 AM by ire
comment:2 Changed on 12/04/2017 at 09:39:08 AM by ire
- Owner set to ire
- Ready set
comment:3 Changed on 12/04/2017 at 10:16:02 AM by ire
- Review URL(s) modified (diff)
- Status changed from new to reviewing
comment:4 Changed on 12/15/2017 at 04:51:02 PM by abpbot
A commit referencing this issue has landed:
Issue 5521 - Restructure CMS documentation to make it easier to use and extend
comment:5 Changed on 12/16/2017 at 09:42:57 AM by ire
- Resolution set to fixed
- Status changed from reviewing to closed
@kvas : Sounds great to me! How should we proceed?