From 2b6fc9ae2bd7e79d510b7a9dd39111d0587daa66 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marius=20Blu=CC=88m?= Date: Tue, 17 Jan 2017 13:26:48 +0100 Subject: [PATCH] Update Branches & App(s) Store MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Marius Blüm --- README.rst | 38 +++++++++++++++++++------------------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/README.rst b/README.rst index 14b034a7d..bad93d367 100644 --- a/README.rst +++ b/README.rst @@ -4,8 +4,8 @@ Nextcloud Documentation Documentation is published on ``_. -The `documentation Wiki `_ is -available for tips, tricks, edge cases, and anyone who wants to contribute more +The `documentation Wiki `_ is +available for tips, tricks, edge cases, and anyone who wants to contribute more easily, without having to learn Git and Sphinx. See the `Style Guide `_ for formatting and style conventions. @@ -17,9 +17,9 @@ This repository hosts four 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, and master is version 9.1. +* **Developers Manual** + +Please work in the appropriate branch: ``stable9`` is 9.0, ``stable10`` is 10.0, ``stable11`` is 11.0 and ``master`` is version 12.0. Please wrap lines at 80 characters. @@ -31,7 +31,7 @@ Spelling and Capitalization Conventions As this grows it may be moved to its own page. -* Nextcloud Apps Store +* Nextcloud App Store * synchronize * Web (Web page, Web site) @@ -54,24 +54,24 @@ from GitHub. 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 +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. +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. -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. +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, +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.