Skip to content

Latest commit

 

History

History
27 lines (18 loc) · 1.46 KB

README.md

File metadata and controls

27 lines (18 loc) · 1.46 KB

ownCloud Documentation (v2)

This project is a port of the ownCloud documentation, that was previously generated using Sphinx-Doc, to Antora. Fundamentally, not that much has changed.

All of the same information is still available. However, here’s what has changed:

  1. The platform (and tools) used to build the documentation, which is Antora.
  2. The file format that the documentation is written in, which is AsciiDoc.
  3. The UI & UX of the documentation

Contributing to the Docs

If you've been contributing to the previous version of ownCloud's documentation, which used reStructuredText and Sphinx-Doc, here’s how to get started contributing to the new version of the documentation.

You need to do a few things to contribute to the documentation:

  1. Install Antora.
  2. Learn the AsciiDoc file format's basics.
  3. Update your toolset so that it supports both AsciiDoc and Antora.
  4. Learn how to build the docs.
  5. Create meaningful commits and a PR with your changes.

Styling the Docs

If you want to change the look and feel of the ownCloud documentation, you can find all the information that you need in the docs-ui repository.