|
|
| (5 intermediate revisions by 3 users not shown) |
| Line 1: |
Line 1: |
| | + | Read the new content in the [http://docs.openstack.org/contributor-guide/docs-structure.html the Documentation Contributor Guide]. |
| | + | |
| | {{OpenStack_Documentation_Navbar}} | | {{OpenStack_Documentation_Navbar}} |
| − | {{OpenStack_Conventions_Navbar}}
| |
| − |
| |
| − | This page handles the structure of books - how to name and arrange files and directories.
| |
| − |
| |
| − | __TOC__
| |
| − |
| |
| − | == Source file names ==
| |
| − |
| |
| − | For file names, use bk_, ch_, section_, and app_ at the beginning of the file name to indicate the type of file it is in the hierarchy of the build.
| |
| − |
| |
| − | == Directory structure ==
| |
| − | For further organization, you can use subdirectories to organize the files by a particular grouping such as project or topic.
| |
| − |
| |
| − | Common practice are:
| |
| − | * A figures subdirectory that includes all images (both SVG source and PNG).
| |
| − | * A samples subdirectory that contains source code samples or configuration file samples.
| |
| − | * A subdirectory per chapter where all sections are in the subdirectory, the ch_ file itself is in the top level directory.
| |
| − |
| |
| − | == Book check list ==
| |
| − |
| |
| − | Use the following check list for books:
| |
| − |
| |
| − | {| class="wikitable"
| |
| − | |-
| |
| − | ! Task !! Description !! Complete?
| |
| − | |-
| |
| − | | pom.xml file || Your pom.xml file uses the latest (non-SNAPSHOT) cloud-doc plugin version and is configured correctly. To find the version number of the latest plugin, go to [https://github.com/rackerlabs/clouddocs-maven-plugin#release-notes Clouddocs Maven Plugin Release Notes]. ||
| |
| − | |-
| |
| − | | TOC || Your pom.xml file configures a TOC for your book. ||
| |
| − | |-
| |
| − | | Glossary || Embed the shared glossary and mark terms with the <glossterm> tag in your document. ||
| |
| − | |-
| |
| − | | Preface || Your book has a preface. ||
| |
| − | |-
| |
| − | | Doc history || The preface includes the doc history. Also make sure that you have included a revision entry for your latest changes. ||
| |
| − | |-
| |
| − | | Title || Title is correct. ||
| |
| − | |-
| |
| − | | Code samples || Code samples are in separate files and included in chapter, section, or appendix file. ||
| |
| − | |-
| |
| − | | Chunking || Chapters and appendices are in separate files and included in the book file. ||
| |
| − | |-
| |
| − | | Source file names || Source file names use file naming conventions. Book files = bk_*; Chapter files = ch_*; Appendix files = app_*; Section files = section_*. ||
| |
| | | | |
| − | |}
| |
| | ---- | | ---- |
| | [[Category:Documentation]] | | [[Category:Documentation]] |
