{"id":13807728,"url":"https://github.com/nextcloud/documentation","last_synced_at":"2025-05-13T23:05:31.063Z","repository":{"id":9111768,"uuid":"60901479","full_name":"nextcloud/documentation","owner":"nextcloud","description":"📘 Nextcloud documentation","archived":false,"fork":false,"pushed_at":"2025-05-12T12:08:09.000Z","size":154700,"stargazers_count":533,"open_issues_count":315,"forks_count":1985,"subscribers_count":34,"default_branch":"master","last_synced_at":"2025-05-12T12:39:23.333Z","etag":null,"topics":["documentation","hacktoberfest","manual","nextcloud","sphinx"],"latest_commit_sha":null,"homepage":"https://docs.nextcloud.com","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nextcloud.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"COPYING","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2016-06-11T10:09:11.000Z","updated_at":"2025-05-12T12:08:12.000Z","dependencies_parsed_at":"2025-05-05T04:37:10.225Z","dependency_job_id":null,"html_url":"https://github.com/nextcloud/documentation","commit_stats":{"total_commits":11297,"total_committers":743,"mean_commits":"15.204576043068641","dds":0.5906877932194388,"last_synced_commit":"99afc3178185b841b0978e53491cf169f3b8741e"},"previous_names":[],"tags_count":15,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nextcloud%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nextcloud%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nextcloud%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nextcloud%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nextcloud","download_url":"https://codeload.github.com/nextcloud/documentation/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254040684,"owners_count":22004593,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["documentation","hacktoberfest","manual","nextcloud","sphinx"],"created_at":"2024-08-04T01:01:29.587Z","updated_at":"2025-05-13T23:05:26.046Z","avatar_url":"https://github.com/nextcloud.png","language":"JavaScript","readme":"=======================\nNextcloud Documentation\n=======================\n\nDocumentation is published on `\u003chttps://docs.nextcloud.com\u003e`_.\nTo edit it yourself, you need to tinker a bit with Git and Sphinx.\nSee the `Style Guide \u003chttps://github.com/nextcloud/documentation/blob/master/style_guide.rst\u003e`_ for formatting and style conventions.\n\nManuals\n-------\n\nThis repository hosts three manuals:\n\n* **Users' Manual**\n* **Administration Manual**\n* **Developers Manual**\n\nPlease work in the appropriate branch: ``stable``-branches are for the respective release (e.g. 14.0 or 15.0), ``master`` is the latest version.\n\nPlease wrap lines at 80 characters.\n\n.. note:: ``configuration_server/config_sample_php_parameters.rst`` is auto-generated from the core\n   config.sample.php file; changes to this file must be made in core `\u003chttps://github.com/nextcloud/server/tree/master/config\u003e`_\n\nSpelling and Capitalization Conventions\n---------------------------------------\n\nAs this grows it may be moved to its own page.\n\n* Nextcloud App Store\n* synchronize\n* Web (Web page, Web site)\n\nLicense\n-------\n\nAll documentation in this repository is licensed under the Creative Commons\nAttribution 3.0 Unported license (`CC BY 3.0`_).\n\n.. _CC BY 3.0: https://creativecommons.org/licenses/by/3.0/deed.en_US\n\nStyle\n-----\n\nSource files are written using the `Sphinx Documentation Generator\n\u003chttps://www.sphinx-doc.org/en/master/\u003e`_. The syntax follows the `reStructuredText\n\u003chttp://docutils.sourceforge.net/rst.html\u003e`_ style, and can also be edited\nfrom GitHub.\n\nStructure\n---------\n\nOf course, think about structure. Keep in mind that we try NOT to move or rename\npages once they are created! Lots of external sources link to our documentation,\nincluding the indexing by search engines of course. So once you create a page with a certain\nname, it has to stay in that location and with that name. Think of it as API stability\n- we have to ensure things stay as they are as much as possible. Renaming or moving\nis only allowed in exceptional circumstances and only when a redirect is put in place.\n\nEditing\n-------\n\nContributing to the documentation requires a GitHub account. Make sure you are\nworking in the correct branch for your version of Nextcloud or client apps.\nIf your edits pertain to multiple manual versions, be prepared to backport as\nneeded.\n\nTo edit a document, you can edit the .rst files on your local system, or work\ndirectly on GitHub. The latter is only suitable for small fixes and improvements\nbecause substantial editing efforts can better be controlled on your local PC.\n\nThe best way is to install a complete Sphinx build environment and work on your\nlocal PC. You will be able to make your own local builds, which is the fastest\nand best way to preview for errors. Sphinx will report syntax errors, missing\nimages, and formatting errors. The GitHub preview is not complete and misses\nmany mistakes. Create a new branch against the master or stable branch you are\nediting, make your edits, then push your new branch to GitHub and open a new PR.\n\nTo edit on GitHub, fork the repository (see top-right of the screen, under\nyour username). You will then be able to make changes easily. Once done,\nyou can create a pull request and get the changes reviewed and back into\nthe official repository.\n\nWhen editing either on your own local PC or on GitHub, be sure to sign of\ncommits, to certify adherence to the Developer Certificate of Origin,\nsee https://github.com/probot/dco . Your commit messages need to have,\nthe name and email address of the contributor.\n\n  Signed-off-by: Awesome Contributor \u003cawesome.contributor@reach.me\u003e\n\nIf using the command line and your name and email are configured, you can use\n\n  git commit -s -m 'Commit message'\n\nIn both settings be sure that your email address matches that in your GitHub profile,\nwhich if you have privacy enabled will be github.username@users.noreply.github.com\n\n\nTranslations\n------------\n\n`Help translate the documentation \u003chttps://www.transifex.com/nextcloud/nextcloud-user-documentation/dashboard/\u003e`_.\n\nFor developers that want to ease the translation process, please read `this documentation \u003chttps://docs.transifex.com/integrations/sphinx-doc\u003e`_.\n\nBuilding\n--------\n\nNightly Automated Build Steps\n=============================\n\n1.  **Fetch sources**\n   1.  ``git clone https://github.com/nextcloud/documentation.git``\n   2.  ``cd documentation``\n   3.  ``git checkout \u003cbranch name\u003e``\n2.  **Install**\n   1.  ``npm install svgexport -g --unsafe-perm=true``\n   2.  ``pip3 install -r requirements.txt``\n   3.  ``make all``\n\n\nBuilding HTML\n=============\n\nUsing pipenv\n^^^^^^^^^^^^\n\n1. Install ``pipenv`` - https://pipenv.readthedocs.io/en/latest/\n2. Change into the environment: ``pipenv shell``\n3. Install the dependencies ``pip install -r requirements.txt``\n4. Now you can use ``make ...`` to build all the stuff - for example ``make html`` to build the HTML flavor of all manuals\n   The build assets will be put into the individual documentation subdirectories like ``developer_manual/_build/html/com``\n\nTo 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``.\n\nUsing venv\n^^^^^^^^^^\n\n1. Install ``python3-venv``\n2. Only once: Create a venv (typically inside this repository): ``python -m venv venv``\n3. Activate the environment (inside this repository): ``source venv/bin/activate``\n4. Install the dependencies ``pip install -r requirements.txt``\n5. Now you can use ``make ...`` to build all the stuff - for example ``make html`` to build the HTML flavor of all manuals\n   The build assets will be put into the individual documentation subdirectories like ``developer_manual/_build/html/com``\n\nAutobuilding\n^^^^^^^^^^^^\n\nWhen editing the documentation installing ``sphinx-autobuild`` though pip can be helpful. This will watch file changes and automatically reload the html preview:\n\n1. Install ``pip install sphinx-autobuild``\n2. When building the developer documentation make sure to execute ``make openapi-spec`` in the repository root\n3. Enter the documentation section ``cd user_manual``\n4. Watch for file changes ``make SPHINXBUILD=sphinx-autobuild html``\n5. Open http://127.0.0.1:8000 in the browser and start editing\n\nBuilding PDF\n============\n\n1. Follow instructions for \"Building HTML\" above\n2. Install ``latexmk`` and ``texlive-latex-extra`` - https://pipenv.readthedocs.io/en/latest/\n3. Create a Python environment (typically inside this repository): ``pipenv --python 3.9``\n4. Change into the environment: ``pipenv shell``\n5. Install the dependencies ``pip install -r requirements.txt``\n6. Now you can use ``make ...`` to build all the stuff - for example ``make pdf`` to build the PDF flavor of all manuals\n\nUsing the VSCode DevContainer\n=============================\n\nThis repository contains a full-featured `VSCode DevContainer \u003chttps://code.visualstudio.com/docs/devcontainers/containers\u003e`_.\nYou can use it in your local development environment or via `GitHub Codespaces \u003chttps://github.com/features/codespaces\u003e`_.\nJust open the container an use one of the commands from above to build the project. For example ``make`` to build the full\ndocumentation, ``make html`` to build the HTML documentation or ``make pdf`` to build the PDF documentation. You can also use\n``make SPHINXBUILD=sphinx-autobuild html`` in combination with `port forwarding \u003chttps://code.visualstudio.com/docs/devcontainers/containers#_forwarding-or-publishing-a-port\u003e`_\nto  watch file changes and automatically reload the html preview.\n\nIcons\n-----\n\nTo compile and update the icons list in the designer manual, you will also need\n\n1. inkscape\n2. sass\n3. unzip\n4. wget\n\n.. _CC BY 3.0: https://creativecommons.org/licenses/by/3.0/deed.en_US\n.. _`Xcode command line tools`: https://stackoverflow.com/questions/9329243/xcode-install-command-line-tools\n","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnextcloud%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnextcloud%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnextcloud%2Fdocumentation/lists"}