This repository is no longer accepting new issues and PRs. If you want to make or suggest a change to the documentation, you need to create an issue or a PR in the new docs repository at: https://github.com/owncloud/docs.
ownCloud Documentation
This repository stores the official documentation for ownCloud. Here, you will find all the information that you need to contribute to the official documentation.
The documentation is published on https://doc.owncloud.org and https://doc.owncloud.com. A documentation Wiki is available for tips, tricks, edge cases, and anyone who wants to contribute more easily, without having to learn Git and Sphinx.
Manuals
This repository hosts three manuals:
- Users' Manual
- Administration Manual
- Developers Manual
Please work in the appropriate branch.
- Stable8 is 8.0
- Stable8.1 is 8.1
- Stable8.2 is 8.2
- Stable9 is 9.0
- Stable9.1 is 9.1
- Master is 9.2
Note
configuration_server/config_sample_php_parameters.rst is auto-generated from the core
config.sample.php file; changes to this file must be made in core https://github.com/owncloud/core/tree/master/config
How To Create An Issue
For detailed information on how to create an issue in the documentation repository, please refer to the "How To Create An Issue" guide.
This process overrides all previous practices, and aims to formalize and simplify the process of creating requests for change within the ownCloud documentation.
Issues should no longer be created in any of the other ownCloud repositories. Doing so makes it too difficult and time-intensive to stay on top of all the requests for change relating to documentation.
Whatβs more, issues created in other repositories may be closed without being actioned (though more than likely theyβll be gently requested to be recreated within this repository).
Style Guide
For detailed information, please refer to the ownCloud Style Guide. Otherwise, source files are written using the Sphinx Documentation Generator. The syntax follows the reStructuredText style, and can also be edited from GitHub.
License
All documentation in this repository is licensed under the Creative Commons Attribution 3.0 Unported license. You can find a local copy of the license in LICENSE.
Contributing
To know how to contribute to this repository, please refer to the contributing guide.
Building The Documentation
For detailed information, please refer to the build guide.
Importing Files
For detailed information, please refer to the importing files guide.