From dd0a42a20dff3dd27329f2542a0c92587b60b131 Mon Sep 17 00:00:00 2001 From: peterdamian Date: Thu, 30 Nov 2017 17:22:57 -0500 Subject: [PATCH 1/2] Rewrite a couple of small sections, clarify that images cannot have captions. --- .../installation/source_installation.rst | 16 +++++++++++++--- style_guide.rst | 5 +++-- user_manual/files/access_webdav.rst | 19 +++++++++---------- 3 files changed, 25 insertions(+), 15 deletions(-) diff --git a/admin_manual/installation/source_installation.rst b/admin_manual/installation/source_installation.rst index 7928ae1f3..8561ef795 100644 --- a/admin_manual/installation/source_installation.rst +++ b/admin_manual/installation/source_installation.rst @@ -35,11 +35,21 @@ archive `_. Installing on Windows (virtual machine) --------------------------------------- -If you are using Windows, the easiest way to get Nextcloud up an running is using our Virtual Machine. The VM is mainly maintainted by Tech and Me and are offered in several different versions. The main version is for VMware version 10 and comes in different sizes. The standard size is 20 GB, but you can also download a 500 GB and a 1 TB version. Tech and Me also provides a Hyper-V version for all Hyper-V users. +If you are using Windows, the easiest way to get Nextcloud up and running is +using a `Nextcloud virtual machine (VM) `_. +The VMs are maintained by `Tech and Me `_ and +several different versions are offered. The main version is for VMware version +10 and it comes in different sizes. The standard size is 20 GB but you can also +download a 500 GB or a 1 TB version. Tech and Me also provides a Hyper-V +version for Hyper-V users. -You can find complete instructions and downloads here: https://github.com/nextcloud/vm or here https://www.techandme.se/nextcloud-vm/ +For complete instructions and downloads see: -Of course you can also install it on other OSes than Windows and you are not limited to any OS really as long as your hypervisor can mount OVA, VMDK, or VHD. +- https://github.com/nextcloud/vm +- https://www.techandme.se/nextcloud-vm/ + +.. note:: You can install the VM on OSes other than Windows as long as +your hypervisor can mount OVA, VMDK, or VHD VM formats. .. _snaps_label: diff --git a/style_guide.rst b/style_guide.rst index 83b5bb925..030dcfc1f 100644 --- a/style_guide.rst +++ b/style_guide.rst @@ -119,8 +119,9 @@ form on the Nextcloud admin page, narrow your Web browser to fold the fields into a smaller space, because a long skinny graphic is not very readable. Think square. -All images must have alt tags, which are brief and descriptive, and figure -numbers. Sphinx RST markup does not have a tag for figure numbers, so you must +Both images and figures must have brief and descriptive alt tags and all +figures must have captions with figure numbers. Sphinx RST markup does not +have a tag for figure numbers, so you must use the caption element. You may use simple numbering like "Figure 1, Figure 2", or add a caption. Captions must follow a blank line and be italicized, like this example:: diff --git a/user_manual/files/access_webdav.rst b/user_manual/files/access_webdav.rst index e0e626421..9642674f5 100644 --- a/user_manual/files/access_webdav.rst +++ b/user_manual/files/access_webdav.rst @@ -11,20 +11,19 @@ recommended way of connecting client devices to your Nextcloud servers. Nextcloud Desktop and mobile clients ------------------------------------ -The recommended method for keeping your desktop PC synchronized with your -Nextcloud server is by using the `Nextcloud/ownCloud sync clients -`_. You can configure the client -to save files in any local directory you want, and you choose which directories -on the Nextcloud server to sync with. The client displays the current connection -status and logs all activity, so you always know which remote files have been -downloaded to your PC, and you can verify that files created and updated on your -local PC are properly synchronized with the server. +The recommended way to synchronize a desktop PC with a Nextcloud server is by +using `Nextcloud/ownCloud sync clients `_. You can configure the +client to save files in any local directory and you can choose which +directories on the Nextcloud server to sync with. The client displays the +current connection status and logs all activity, so you always know which +remote files have been downloaded to your PC and you can verify that files +created and updated on your local PC are properly synchronized with the server. -The recommended method for syncing your Nextcloud server with Android and +The recommended way to synchronize Nextcloud server with Android and Apple iOS devices is by using the `mobile apps `_. -To connect to your Nextcloud server with the mobile apps, use the +To connect your mobile app to a Nextcloud server use the base URL and folder only:: example.com/nextcloud From 68514fa20fdefdbfcaea6b47142a2f17f724d3cc Mon Sep 17 00:00:00 2001 From: peterdamian Date: Thu, 30 Nov 2017 18:44:25 -0500 Subject: [PATCH 2/2] Use macOS where applicable, other minor changes --- admin_manual/index.rst | 2 +- admin_manual/installation/source_installation.rst | 2 +- admin_manual/issues/general_troubleshooting.rst | 2 +- developer_manual/app/settings.rst | 2 +- developer_manual/general/debugging.rst | 2 +- user_manual/files/access_webdav.rst | 10 +++++----- user_manual/files/desktop_mobile_sync.rst | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/admin_manual/index.rst b/admin_manual/index.rst index 1a9d54036..38e6b4578 100644 --- a/admin_manual/index.rst +++ b/admin_manual/index.rst @@ -5,7 +5,7 @@ Introduction Welcome to the Nextcloud Server Administration Guide. This guide describes administration tasks for Nextcloud, the flexible open source file synchronization and sharing solution. Nextcloud includes the Nextcloud server, which runs on -Linux, client applications for Microsoft Windows, Mac OS X and Linux, and mobile +Linux, client applications for Microsoft Windows, macOS and Linux, and mobile clients for the Android and Apple iOS operating systems. Current editions of Nextcloud manuals are always available online at diff --git a/admin_manual/installation/source_installation.rst b/admin_manual/installation/source_installation.rst index 8561ef795..ab4997b0f 100644 --- a/admin_manual/installation/source_installation.rst +++ b/admin_manual/installation/source_installation.rst @@ -59,7 +59,7 @@ Installing via Snap packages A snap is a zip file containing an application together with its dependencies, and a description of how it should safely be run on your system, especially the different ways it should talk to other software. Most importantly snaps are -designed to be secure, sandboxed, containerised applications isolated from the +designed to be secure, sandboxed, containerized applications isolated from the underlying system and from other applications. To install the Nextcloud Snap Package, run the following command in a terminal:: diff --git a/admin_manual/issues/general_troubleshooting.rst b/admin_manual/issues/general_troubleshooting.rst index 295a2f4cb..0a7bd8588 100644 --- a/admin_manual/issues/general_troubleshooting.rst +++ b/admin_manual/issues/general_troubleshooting.rst @@ -240,7 +240,7 @@ Troubleshooting contacts & calendar Service discovery ^^^^^^^^^^^^^^^^^ -Some clients - especially on iOS/Mac OS X - have problems finding the proper +Some clients - especially on iOS/macOS - have problems finding the proper sync URL, even when explicitly configured to use it. If you want to use CalDAV or CardDAV clients together with Nextcloud it is diff --git a/developer_manual/app/settings.rst b/developer_manual/app/settings.rst index 5e9a6c3c3..d4663af81 100644 --- a/developer_manual/app/settings.rst +++ b/developer_manual/app/settings.rst @@ -145,7 +145,7 @@ would be the final relative path. /** @var $l \OCP\IL10N */ /** @var $_ array */ - script('myappid', 'admin'); // adds a Javascript file + script('myappid', 'admin'); // adds a JavaScript file style('survey_client', 'admin'); // adds a CSS file ?> diff --git a/developer_manual/general/debugging.rst b/developer_manual/general/debugging.rst index d3c727bc7..13c4a68c4 100644 --- a/developer_manual/general/debugging.rst +++ b/developer_manual/general/debugging.rst @@ -74,7 +74,7 @@ For debugging scripts on the command line, like ``occ`` or unit tests, set the ` Debugging JavaScript -------------------- -By default all Javascript files in Nextcloud are minified (compressed) into a single file without whitespace. To prevent this, see Debug mode. +By default all JavaScript files in Nextcloud are minified (compressed) into a single file without whitespace. To prevent this, see Debug mode. Debugging HTML and templates diff --git a/user_manual/files/access_webdav.rst b/user_manual/files/access_webdav.rst index 9642674f5..915152f88 100644 --- a/user_manual/files/access_webdav.rst +++ b/user_manual/files/access_webdav.rst @@ -4,7 +4,7 @@ Accessing Nextcloud files using WebDAV Nextcloud fully supports the WebDAV protocol, and you can connect and synchronize with your Nextcloud files over WebDAV. In this chapter you will learn how to -connect Linux, Mac OS X, Windows, and mobile devices to your Nextcloud server via +connect Linux, macOS, Windows, and mobile devices to your Nextcloud server via WebDAV. Before we get into configuring WebDAV, let's take a quick look at the recommended way of connecting client devices to your Nextcloud servers. @@ -41,7 +41,7 @@ If you prefer, you may also connect your desktop PC to your Nextcloud server by using the WebDAV protocol rather than using a special client application. Web Distributed Authoring and Versioning (WebDAV) is a Hypertext Transfer Protocol (HTTP) extension that makes it easy to create, read, and edit files on Web -servers. With WebDAV you can access your Nextcloud shares on Linux, Mac OS X and +servers. With WebDAV you can access your Nextcloud shares on Linux, macOS and Windows in the same way as any remote network share, and stay synchronized. .. note:: In the following examples, You must adjust **example.com/** to the @@ -203,7 +203,7 @@ To access files through the macOS Finder: 2. Specify the address of the server in the **Server Address** field. .. image:: ../images/osx_webdav1.png - :alt: Screenshot of entering your Nextcloud server address on Mac OS X + :alt: Screenshot of entering your Nextcloud server address on macOS For example, the URL used to connect to the Nextcloud server from the macOS Finder is:: @@ -216,7 +216,7 @@ To access files through the macOS Finder: The device connects to the server. -For added details about how to connect to an external server using Mac OS X, +For added details about how to connect to an external server using macOS, check the `vendor documentation `_ . @@ -307,7 +307,7 @@ Accessing files using Cyberduck `Cyberduck `_ is an open source FTP and SFTP, WebDAV, OpenStack Swift, and Amazon S3 browser designed for file transfers on -Mac OS X and Windows. +macOS and Windows. .. note:: This example uses Cyberduck version 4.2.1. diff --git a/user_manual/files/desktop_mobile_sync.rst b/user_manual/files/desktop_mobile_sync.rst index 6dbdd1470..2be9dbcee 100644 --- a/user_manual/files/desktop_mobile_sync.rst +++ b/user_manual/files/desktop_mobile_sync.rst @@ -3,7 +3,7 @@ Desktop and mobile synchronization ================================== For synchronizing files with your desktop computer, we recommend using the -`Nextcloud Sync Client`_ for Windows, Mac OS X and Linux. +`Nextcloud Sync Client`_ for Windows, macOS and Linux. The Nextcloud Desktop Sync Client enables you to connect to your Nextcloud Server.