tree: cbfc078a7111fae11fc34381bee71a18c1597a2f [path history] [tgz]
  1. README.md
  2. apex_cli.md
  3. apex_development_setup.md
  4. application_development.md
  5. application_packages.md
  6. autometrics.md
  7. compatibility.md
  8. control_tuples.md
  9. development_best_practices.md
  10. favicon.ico
  11. images/
  12. index.md
  13. operator_development.md
  14. security.md
docs/README.md

Apex Documentation

Apex documentation repository for content available on http://apex.apache.org/docs/

Documentation is written in Markdown format and statically generated into HTML using MkDocs. All documentation is located in the docs directory, and mkdocs.yml file describes the navigation structure of the published documentation.

Authoring

New pages can be added under docs or related sub-category, and a reference to the new page must be added to the mkdocs.yml file to make it availabe in the navigation. Embedded images are typically added to images folder at the same level as the new page.

When creating or editing pages, it can be useful to see the live results, and how the documents will appear when published. Live preview feature is available by running the following command at the root of the repository:

mkdocs serve

For additional details see writing your docs guide.

Site Configuration

Guides on applying site-wide configuration and themeing are available on the MkDocs site.