mirror of
https://github.com/nextcloud/documentation.git
synced 2026-01-03 02:09:45 +07:00
04555bf481
There’s more explanation here than there are changes to the docs! But, in the interest of fully explaining *why*: I had a frustrating and time-consuming experience attempting to *unsuccessfully* get macOS 10.11.x-10.13.x to mount WebDAV shares. The opening “Note” of “Accessing files using macOS” re Finder’s “series of implementation problems” is valuable. While my rewrite does *not* employ stronger language to *dissuade* Mac users from wrestling Finder, I’m convinced it should. I understand that docs maintainers probably want to avoid negative commentary re product manufacturers for many reasons, but the alternative to tight-lipped disclosure is user disillusionment. The opening warning would serve Apple folk better if it more-plainly warned of the high likelihood of Finder failure and more-thoroughly offered, even recommended, alternative apps to successfully achieve WebDAV access. Though Cyberduck instructions follow *later* in the article, it benefits the Mac user *here* (and other users in their respective sections) as they will likely seek out and focus specifically, perhaps *only*, on these instructions which are so clearly titled for and targeted at them: “Accessing files using **macOS**.” Unfortunately — even though these steps *should* work — they probably will *not*. Readers, exacerbated, may only find the Cyberduck info later, after returning to the instructions for further illumination, feeling slighted it wasn’t there to begin with. Recommending the open source Cyberduck as a candidate to replace Finder’s failures is helpful. Understandably, there may be resistance to mentioning commercial apps at the risk of perceived endorsement, but I have. I also added another open source app. Arming readers with more knowledge, more details, and more tools *up front* secures a higher rate of informed execution and success. Nuts and bolts: I offer minor reordering of graphics and text to hopefully present a clearer flow of the existing steps. That includes changing example.com/nextcloud to cloud.nextcloud.com as most people who have registered domains can easily add subdomains. Subdomains can also efficiently by reverse proxied to internal servers *without* opening external ports visible to hackers. Call it subliminal security reinforcement. I optimized the original “osx_webdav1.png,” compressing it from 381K to 94K, with negligible visual loss. And I created a new screenshot to replace the existing osx_webdav2.png “Connect to Server” image which graphically matches the sample text URL. (The existing sample URL and its screenshot don’t match.) Finally, the original osx_webdav2.png dialog box had been reduced in size, introducing minor but visible blur. The new optimized version is actual-size-crisp and only 16K, vs the original’s 66K. (I don’t see where to attach these new graphics. I’m new to pull requests, and hope in subsequent steps I can.)
======================= Nextcloud Documentation ======================= Documentation is published on `<https://docs.nextcloud.com>`_. To edit it yourself, you need to tinker a bit with Git and Sphinx. See the `Style Guide <https://github.com/nextcloud/documentation/blob/master/style_guide.rst>`_ for formatting and style conventions. Manuals ------- This repository hosts three manuals: * **Users' Manual** * **Administration Manual** * **Developers Manual** Please work in the appropriate branch: ``stable``-branches are for the respective release (e.g. 14.0 or 15.0), ``master`` is the latest version. Please wrap lines at 80 characters. .. 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/nextcloud/server/tree/master/config>`_ 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 <https://www.sphinx-doc.org/en/master/>`_. The syntax follows the `reStructuredText <http://docutils.sourceforge.net/rst.html>`_ style, and can also be edited 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 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. 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. Building -------- 1. Install `pipenv` - https://pipenv.readthedocs.io/en/latest/ 2. Create a Python 2 environment (typically inside this repository): `pipenv --two` 3. Change into the environment: `pipenv shell` 4. Install the dependencies `pip2 install -r requirements.txt` 5. Now you can use `make ...` to build all the stuff - for example `make html` to build the HTML flavor of all manuals 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`. Icons ----- To compile and update the icons list in the designer manual, you will also need 1. inkscape 2. sass 3. unzip 4. wget .. _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