Make docsite documentation headers consistent

[acozine]

ISSUE TYPE

• Documentation Report

COMPONENT NAME

docsite

ANSIBLE VERSION

2.5

SUMMARY

Headers in the current documentation are inconsistent - some use overline, some don't; they use different characters (#### or ****** or =======) to mark headers. It's easier to edit existing documentation or add new documentation if we follow a consistent standard.

Proposed standard:

# with overline, for parts
* with overline, for chapters
=, for sections
-, for subsections
^, for subsubsections
", for paragraphs

ACCEPTANCE

• confirm standard and agree on what constitutes a "part" a "chapter" etc.
• edit files in docsite/rst to use consistent header notation
• edit style guide to include header notation standards
• create template for future docs that demonstrates header notation standards

[ansibot]

Files identified in the description:

• docs

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[ansibot]

@acozine Greetings! Thanks for taking the time to open this issue. In order for the community to handle your issue effectively, we need a bit more information.

Here are the items we could not find in your description:

• ansible version

Please set the description of this issue with this template:
https://raw.githubusercontent.com/ansible/ansible/devel/.github/ISSUE_TEMPLATE.md

click here for bot help

[ansibot]

cc @dharmabumstead
click here for bot help

[ansibot]

Files identified in the description:

• docs/docsite/.gitignore

If these files are inaccurate, please update the component name section of the description or use the !component bot command.

click here for bot help

[elizabethqiu]

Can I help with this?

[acozine]

@elizabethqiu thanks for the offer - yes, we would welcome your help! Feel free to open a Pull Request or join the #ansible-docs channel on freenode IRC to ask any questions that come up. We have documentation on how to contribute to our documentation. You can also review our Style Guide.

[HarshalGupta1098]

can I help with this?

[gundalow]

can I help with this?

@HarshalGupta1098 That would be great. I'd suggest just doing one file per Pull Request to start with so you can get used to the process.

https://github.com/ansible/ansible/tree/devel/docs/docsite/rst corresponds to https://docs.ansible.com/ansible-core/devel/

Feel free to ask here if you have any questions.

[samccann]

Most of these have been fixed. Look for new individual issues for the few that remain and thanks all for the help!