.. _filename-conv:

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 <https://support.google.com/webmasters/answer/76329>`_.

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.


|

This documentation, is a derivative of `RST conventions <https://docs.openstack.org/doc-contrib-guide/rst-conv.html>`_ by OpenStack, used under CC BY.