85107272be
Based off conversation at the PTG, we agreed it would be beneficial to ensure the contrib-guide is clearly marked as the doc contrib guide outside of the title. This change includes a redirect. Change-Id: I5abf915f0b94a482afa961e6b86364c26aae5d79
940 B
940 B
File naming and structure
File naming conventions
To indicate the hierarchical type of files for filenames:
- Follow a page-based, topical approach to file naming and do not apply any special prefixes.
- Use hyphens as space delimiters for search optimization.
For example,
technical-considerations-multi-site.rst.
Directory structure
For better organization, use subdirectories to organize the files by a particular grouping such as project or topic.
Common practices include:
- Figure subdirectory includes images (both PNG and SVG source files).
- Sample subdirectory contains samples of source code and configuration files.
- Chapter subdirectory stores all sections included in one chapter with the parent file located in the top-level directory.