This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
documentation [2016/02/03 19:48] Christopher Price |
documentation [2016/03/16 00:00] (current) Aric Gardner |
||
---|---|---|---|
Line 42: | Line 42: | ||
For release documents specific to a project, the documentation should be created in the projects' release directory. | For release documents specific to a project, the documentation should be created in the projects' release directory. | ||
- | * Release Documentation: ''<repo>/docs/release/'' | + | * Release Documentation: ''<repo>/docs/release-notes/'' |
* Should be the directory where any release specific documentation (release notes) is produced | * Should be the directory where any release specific documentation (release notes) is produced | ||
Line 55: | Line 55: | ||
* Guides to validate project specific features can be included | * Guides to validate project specific features can be included | ||
* Note this document will be compiled into OPNFVDOCS 'configguide' | * Note this document will be compiled into OPNFVDOCS 'configguide' | ||
+ | * NOTE: see [[documentation:configguide]]. | ||
* [[documentation:userguide|User Guide]]: ''<repo>/docs/userguide'' | * [[documentation:userguide|User Guide]]: ''<repo>/docs/userguide'' | ||
Line 61: | Line 62: | ||
* Can be the place for sotring typical scenario as an example | * Can be the place for sotring typical scenario as an example | ||
* Note this document will be compiled into OPNFVDOCS 'userguide' | * Note this document will be compiled into OPNFVDOCS 'userguide' | ||
- | |||
===== Documentation projects ===== | ===== Documentation projects ===== | ||
[[documentation:opnfvdocs|OPNFV Documentation Project]] | [[documentation:opnfvdocs|OPNFV Documentation Project]] |