Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion content/docs-project/contribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@ into other languages, writing tutorials to help new users, or just
expressing your opinion about suggested changes.

For information on our use of XML in the documentation, see our
[Documentation Format and Transformation](docsformat.html) page.
[Documentation Format and Transformation](docsformat.html) page. For
markup conventions and prose style, see the [Documentation Style
Guide](style-guide.html).

If you need inspiration for something to work on, look at our
[STATUS](https://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/STATUS)
Expand Down
3 changes: 3 additions & 0 deletions content/docs-project/docsformat.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@ example of the format with extensive comments is also available in
[mod_template.txt](mod_template.txt). (Ordinarily, the file extension
will be `xml`. It is changed here to make online viewing simpler.)

For detailed conventions on which markup elements to use and when, see the
[Documentation Style Guide](style-guide.html).

Various formatting syntax can be used such as:

<table border="1">
Expand Down
8 changes: 8 additions & 0 deletions content/docs-project/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ love to have your help too.

- [I'd like to build the manual from local source](#build)

- [I want to follow the documentation style conventions](#style)

- [I'd like to join the docs team mailing list](#ml)

- [I want to help translate the documentation](#translate)
Expand Down Expand Up @@ -62,6 +64,12 @@ docs-build directory and run the relevant build scripts to produce all of the
relevant transformations. Please see [docs build](docsformat.html) for
more information.

# Style Guide {#style}

When writing or editing documentation, please follow the conventions in our
[Documentation Style Guide](style-guide.html). It covers inline markup,
directive syntax definitions, prose style, and formatting standards.

# The docs mailing list {#ml}

The discussion surrounding the documentation project happens on the
Expand Down
Loading