======================= Nextcloud Documentation =======================
|build| |netlify|
.. |build| image:: https://img.shields.io/github/actions/workflow/status/nextcloud/documentation/sphinxbuild.yml?branch=master&style=flat-square :alt: Build Status
.. |netlify| image:: https://img.shields.io/badge/Netlify-powered-00C7B7?style=flat-square&logo=netlify :target: https://www.netlify.com :alt: Netlify
Documentation is published on Style Guide _ for formatting and style conventions.
Manuals -------
This repository hosts three manuals:
- Users' Manual
- Administration Manual
- Developers Manual
stable-branches are for the respective release (e.g. 14.0 or 15.0), master is the latest version.
Wrap prose lines at 120 characters where practical. Long URLs, code
examples, and table cells may exceed this limit. See the
Style Guide _
for full guidance.
.. 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 _
Spelling and Capitalization Conventions
---------------------------------------
As this grows it may be moved to its own page.
- Nextcloud App Store
- synchronize
- Web (Web page, Web site)
License
-------
All documentation in this repository is licensed under the Creative Commons
Attribution 3.0 Unported license (
CC BY 3.0_).
.. _CC BY 3.0: https://creativecommons.org/licenses/by/3.0/deed.en_US
Style
-----
Source files are written using the
Sphinx Documentation Generator
_. The syntax follows the reStructuredText
_ style, and can also be edited
from GitHub.
Structure
---------
Of course, think about structure. Keep in mind that we try NOT to move or rename
pages once they are created! Lots of external sources link to our documentation,
including the indexing by search engines of course. So once you create a page with a certain
name, it has to stay in that location and with that name. Think of it as API stability
- we have to ensure things stay as they are as much as possible. Renaming or moving
is only allowed in exceptional circumstances and only when a redirect is put in place.
Editing
-------
Contributing to the documentation requires a GitHub account. Make sure you are
working in the correct branch for your version of Nextcloud or client apps.
If your edits pertain to multiple manual versions, be prepared to backport as
needed.
To edit a document, you can edit the .rst files on your local system, or work
directly on GitHub. The latter is only suitable for small fixes and improvements
because substantial editing efforts can better be controlled on your local PC.
.. tip::
If you're getting to know our documentation syntax,
give Documatt Snippets
_ a try. This online editor is a great way
to practice with reStructuredText and Sphinx, and it provides a more accurate
preview of your work than GitHub does.
The best way is to install a complete Sphinx build environment and work on your
local PC. You will be able to make your own local builds, which is the fastest
and best way to preview for errors. Sphinx will report syntax errors, missing
images, and formatting errors. The GitHub preview is not complete and misses
many mistakes. Create a new branch against the master or stable branch you are
editing, make your edits, then push your new branch to GitHub and open a new PR.
To edit on GitHub, fork the repository (see top-right of the screen, under
your username). You will then be able to make changes easily. Once done,
you can create a pull request and get the changes reviewed and back into
the official repository.
When editing either on your own local PC or on GitHub, be sure to sign of
commits, to certify adherence to the Developer Certificate of Origin,
see https://github.com/probot/dco . Your commit messages need to have,
the name and email address of the contributor.
Signed-off-by: Awesome Contributor
If using the command line and your name and email are configured, you can use
git commit -s -m 'Commit message'
In both settings be sure that your email address matches that in your GitHub profile,
which if you have privacy enabled will be [email protected]
Translations
------------
Help translate the documentation _.
For developers that want to ease the translation process, please read
this documentation _.
Building
--------
Nightly Automated Build Steps
=============================
- Fetch sources
1. git clone https://github.com/nextcloud/documentation.git
2. cd documentation
3. git checkout
- Install
1. pip3 install -r requirements.txt
2. make all
Building HTML
=============
Using pipenv
^^^^^^^^^^^^
- Install
pipenv - https://pipenv.readthedocs.io/en/latest/
Change into the environment: pipenv shell
Install the dependencies pip install -r requirements.txt
Now you can use make ... to build all the stuff - for example make html to build the HTML flavor of all manuals The build assets will be put into the individual documentation subdirectories like developer_manual/_build/html/com
To change into this environment you need to run
pipenv shell to launch the shell and to exit you can use either exit or Ctrl + D.
Using venv
^^^^^^^^^^
- Install
python3-venv
Only once: Create a venv (typically inside this repository): python -m venv venv
Activate the environment (inside this repository): source venv/bin/activate
Install the dependencies pip install -r requirements.txt
Now you can use make ... to build all the stuff - for example make html to build the HTML flavor of all manuals The build assets will be put into the individual documentation subdirectories like developer_manual/_build/html/com
Building translated versions
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Only available in user_manual:
- Build the english version as described above before
- Create translation files:
../build/change_file_extension.sh
Create German ( de) version: make html-lang-de
Find the HTML files in _build/html/de/index.html
Before building another language you have to delete the complete _build directory
Autobuilding
^^^^^^^^^^^^
When editing the documentation installing
sphinx-autobuild though pip can be helpful. This will watch file changes and automatically reload the html preview:
- Install
pip install sphinx-autobuild
When building the developer documentation make sure to execute make openapi-spec in the repository root
Enter the documentation section cd user_manual
Watch for file changes make SPHINXBUILD=sphinx-autobuild html
Open http://127.0.0.1:8000 in the browser and start editing
Building PDF
============
Building inside docker
^^^^^^^^^^^^^^^^^^^^^^
- Create a docker::
docker run --platform linux/amd64 --volume .:/docs --interactive --tty --name nextcloud-docs ghcr.io/nextcloud/continuous-integration-documentation:documentation-15 bash
Change into the documentation directory: cd /docs
Only once: Create a venv: python -m venv venv
Activate the environment: source venv/bin/activate
Install the dependencies pip install -r requirements.txt
Change into the documentation of choice (admin, developer, user): cd /docs/user_manual
To build the English version: make latexpdf
To build the translated version (only available in user_manual): 1. Create translation files: ../build/change_file_extension.sh
2. Create German (de) version: make latexpdf-lang-de
3. Find the file in _build/latex/Nextcloud_User_Manual.pdf
4. Before building another language you have to delete the complete _build directory
Building locally
^^^^^^^^^^^^^^^^
.. note:: Because of the many dependencies LaTeX and the other tools bring in, it is not recommended to install the tools locally.
- Follow instructions for "Building HTML" above
- Install
latexmk and texlive-latex-extra - https://pipenv.readthedocs.io/en/latest/
Create a Python environment (typically inside this repository): pipenv --python 3.9
Change into the environment: pipenv shell
Install the dependencies pip install -r requirements.txt
Now you can use make ... to build all the stuff - for example make pdf to build the PDF flavor of all manuals
Using the VSCode DevContainer
=============================
This repository contains a full-featured
VSCode DevContainer _.
You can use it in your local development environment or via GitHub Codespaces _.
Just open the container an use one of the commands from above to build the project. For example make to build the full
documentation, make html to build the HTML documentation or make pdf to build the PDF documentation. You can also use
make SPHINXBUILD=sphinx-autobuild html in combination with port forwarding _
to watch file changes and automatically reload the html preview.
.. _CC BY 3.0: https://creativecommons.org/licenses/by/3.0/deed.en_US
.. _
Xcode command line tools`: https://stackoverflow.com/questions/9329243/xcode-install-command-line-tools