How to Contribute to the ownCloud Documentation

We welcome all helpful contributions to the ownCloud documentation, whether they’re reporting issues, adding new material, or writing tips and tricks.

If you wish to contribute to the official Administration, User, Desktop Client, and Mobile Apps manuals, you must:

  • First, have a GitHub account.

  • Second, fork the official repositories, write your material, and create a pull request.

The ownCloud documentation is written in the AsciiDoc file format and is powered by the Antora documentation platform. When contributing to the documentation, please follow our Best Practices and Tips guide.

  • The Administration, Developer and User manuals are in the owncloud/docs repository on GitHub. Read the documentation for instructions on setting up your build environment and becoming familiar with the file format and the build system that powers the documentation.

  • The documentation for the Desktop Sync Client is in the doc directory of the Desktop Client repo. See its README for instructions.

  • The documentation of the Android app is in the user_manual directory of the Android App repo. See its README for instructions.

  • The documentation of the iOS app is in the user_manual directory of the iOS App repo. See its README for instructions.

Reporting Documentation Errors

If you find errors or omissions in the Administration, Developer, User, Desktop Client, and Mobile Apps manuals, we encourage you to report them. Please follow this template when reporting documentation errors:

  1. First, search the respective repository for matching or similar issues.

  2. If an issue is not available, open a new one in the respective repository.

  3. Link to the error that you want to see fixed. Please be aware that there are multiple release versions of most of the manuals, so please be specific as to which version needs correcting, and if the issue is in the HTML or PDF version.

  4. Quote the particular error.

  5. Provide the correct solution (if you know it) and any links to supporting references. If you don’t know the answer that is OK.

  6. Provide screenshots if they add useful information.

  7. Provide your web browser, its version, and your operating system & version.

Reporting Documentation Suggestions

If you don’t have a specific problem or contribution, but wish to offer a suggestion, open an issue in the appropriate repository.