Open Stack

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 12/07/15 18:34, Andreas Jaeger wrote:
> Lana, Anne, thanks for the feedback.
> 
> Here's a reworked proposal,
> 
> Andreas
> 
> RST include file policy
> 
> Include files using the ":include:" directive should be used for
> smaller content that is duplicated in several files (note that this
> is something that should be avoided in general).
> 
> For include files, give the files the suffix ".txt" instead of the
> usual ".rst".
> 
> Note that when including files that use headings for section 
> structure, the master file needs to include it at the same level 
> since heading markup is not relative.
> 
> For structuring files, split them up and use a toctree to reference
> the files. If files get too large, it is often a sign that the
> information is not presented properly and therefore the file should
> be reworked instead of split artifically in smaller files using
> includes.
> 
> Files can be shared between guides as separate top-level files,
> like it's done for glossary and support appendix already.
> 

+1

Nice work, Andreas :)

L

- -- 
Lana Brindley
Technical Writer
Rackspace Cloud Builders Australia
http://lanabrindley.com
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1

iQEcBAEBAgAGBQJVpXcmAAoJELppzVb4+KUybZgH/j0RcWyJayBWmUcP5wBiKYd1
UUDQTO59XbUMneD+w9Fes9LAjzULRMWASBX69nm4g7jxKkj//yLDkX9rCd5dC+j5
9Ph6MNOhuRi+1GrX+CjtgiP/Z1EFmlktzeGtWK+17wVe5b78G/tZ6XDh8wfFkymZ
R7oI+zfTGdgitHeMX5DLwgWQQPAeGKLIGagoPRl2aEBwRxQ7oCfwl4sCyS2zvPwv
SHyVZooEI0pxlUiaUgxVxom85kFpwQ9x8zrsVara2+c7XHpCMEMTUWV5yLXlNncN
tE8lU3gV6JrF8gXiNT28Cq+4bBguOgetVGfrDwJXqpB4MBhe0WMJCwV1v73Ego0=
=3032
-----END PGP SIGNATURE-----