From 1c098ea19293db42dc014ad9cdc50152f4db5a3d Mon Sep 17 00:00:00 2001 From: Morris Jobke Date: Wed, 19 Jul 2017 16:54:18 +0200 Subject: [PATCH] Fix developer manual Signed-off-by: Morris Jobke --- developer_manual/android_library/examples.rst | 10 ++-- developer_manual/client_apis/OCS/index.rst | 10 ++-- developer_manual/client_apis/WebDAV/index.rst | 52 +++++++++---------- developer_manual/general/codingguidelines.rst | 10 ++-- developer_manual/general/devenv.rst | 3 +- 5 files changed, 43 insertions(+), 42 deletions(-) diff --git a/developer_manual/android_library/examples.rst b/developer_manual/android_library/examples.rst index d9be7cbc6..e5f767b3a 100644 --- a/developer_manual/android_library/examples.rst +++ b/developer_manual/android_library/examples.rst @@ -90,7 +90,7 @@ Code example // do your stuff here } } - … + // … } Read folder @@ -121,7 +121,7 @@ Code example // do your stuff here } } - … + // … } Read file @@ -148,7 +148,7 @@ Code example // do your stuff here } } - … + // … } Delete file or folder @@ -174,7 +174,7 @@ Code example // do your stuff here } } - … + // … } @@ -279,7 +279,7 @@ Code example // do your stuff here } } - … + // … } Read shared items by link diff --git a/developer_manual/client_apis/OCS/index.rst b/developer_manual/client_apis/OCS/index.rst index 891bee88a..8a6c5a612 100644 --- a/developer_manual/client_apis/OCS/index.rst +++ b/developer_manual/client_apis/OCS/index.rst @@ -1,4 +1,4 @@ -.. _webdavindex: +.. _ocsapiindex: ========= OCS API's @@ -9,9 +9,9 @@ This document provides a quick overview of the OCS API endpoints supported in Ne All requests need to provide authentication information, either as a Basic Auth header or by passing a set of valid session cookies, if not stated otherwise. ----- +-------------------------- Testing requests with curl ----- +-------------------------- All OCS requests can be easily tested out using :code:`curl` by specifying the request method (:code:`GET`, :code:`PUT`, etc) and setting a request body where needed. @@ -66,9 +66,9 @@ This request returns the available metadata of a user. Admin users can see the i ----- +---------------- Capabilities API ----- +---------------- Clients can obtain capabilities provided by the Nextcloud server and its apps via the capabilities OCS API. diff --git a/developer_manual/client_apis/WebDAV/index.rst b/developer_manual/client_apis/WebDAV/index.rst index 2672bded4..b970b8157 100644 --- a/developer_manual/client_apis/WebDAV/index.rst +++ b/developer_manual/client_apis/WebDAV/index.rst @@ -7,17 +7,17 @@ WebDAV Client API's This document provides a quick overview of the WebDAV operations supported in Nextcloud, to keep things readable it won't go into many details for each operation, further information for each operation can be found in the corresponding rfc where applicable ----- +------------- WebDAV Basics ----- +------------- The base url for all WebDAV operations for a Nextcloud instance is :code:`/remote.php/dav`. All requests need to provide authentication information, either as a Basic Auth header or by passing a set of valid session cookies. ----- +-------------------------- Testing requests with curl ----- +-------------------------- All WebDAV requests can be easily tested out using :code:`curl` by specifying the request method (:code:`GET`, :code:`PROPFIND`, :code:`PUT`, etc) and setting a request body where needed. @@ -39,9 +39,9 @@ For example: you can perform a :code:`PROPFIND` request to find files in a folde ' ----- +-------------------------- Listing Folders (rfc4918_) ----- +-------------------------- The contents of a folder can be listed by sending a :code:`PROPFIND` request to the folder. @@ -49,9 +49,9 @@ The contents of a folder can be listed by sending a :code:`PROPFIND` request to PROPFIND remote.php/dav/files/user/path/to/folder -~~~~ +~~~~~~~~~~~~~~~~~~~~~ Requesting properties -~~~~ +~~~~~~~~~~~~~~~~~~~~~ By default, a :code:`PROPFIND` request will only return a small number of properties for each file: last modified date, file size, whether it's a folder, etag and mime type. @@ -98,15 +98,15 @@ The following properties are supported: - :code:`{http://owncloud.org/ns}has-preview` - :code:`{http://owncloud.org/ns}size` Unlike :code:`getcontentlength`, this property also works for folders reporting the size of everything in the folder. -~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Getting properties for just the folder -~~~~ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ You can request properties of a folder without also getting the folder contents by adding a :code:`Depth: 0` header to the request. ----- +----------------- Downloading files ----- +----------------- A file can be downloaded by sending a :code:`GET` request to the WebDAV url of the file. @@ -114,9 +114,9 @@ A file can be downloaded by sending a :code:`GET` request to the WebDAV url of t GET remote.php/dav/files/user/path/to/file ----- +--------------- Uploading files ----- +--------------- A file can be uploading by sending a :code:`PUT` request to the file and sending the raw file contents as the request body. @@ -126,9 +126,9 @@ A file can be uploading by sending a :code:`PUT` request to the file and sending Any existing file will be overwritten by the request. ----- +--------------------------- Creating folders (rfc4918_) ----- +--------------------------- A folder can be created by sending a :code:`MKCOL` request to the folder. @@ -136,9 +136,9 @@ A folder can be created by sending a :code:`MKCOL` request to the folder. MKCOL remote.php/dav/files/user/path/to/new/folder ----- +------------------------------------- Deleting files and folders (rfc4918_) ----- +------------------------------------- A file or folder can be created by sending a :code:`DELETE` request to the file or folder. @@ -148,9 +148,9 @@ A file or folder can be created by sending a :code:`DELETE` request to the file When deleting a folder, it's contents will be deleted recursively. ----- +----------------------------------- Moving files and folders (rfc4918_) ----- +----------------------------------- A file or folder can be moved by sending a :code:`MOVE` request to the file or folder and specifying the destination in the :code:`Destination` header as full url. @@ -161,9 +161,9 @@ A file or folder can be moved by sending a :code:`MOVE` request to the file or f The overwrite behavior of the move can be controlled by setting the :code:`Overwrite` head to :code:`T` or :code:`F` to enable or disable overwriting respectively. ----- +------------------------------------ Copying files and folders (rfc4918_) ----- +------------------------------------ A file or folder can be copied by sending a :code:`COPY` request to the file or folder and specifying the destination in the :code:`Destination` header as full url. @@ -174,9 +174,9 @@ A file or folder can be copied by sending a :code:`COPY` request to the file or The overwrite behavior of the copy can be controlled by setting the :code:`Overwrite` head to :code:`T` or :code:`F` to enable or disable overwriting respectively. ----- +------------------ Settings favorites ----- +------------------ A file or folder can be marked as favorite by sending a :code:`PROPPATCH` request to the file or folder and setting the :code:`oc-favorite` property @@ -194,9 +194,9 @@ A file or folder can be marked as favorite by sending a :code:`PROPPATCH` reques Setting the :code:`oc:favorite` property to 1 marks a file as favorite, setting it to 0 un-marks it as favorite. ----- +----------------- Listing favorites ----- +----------------- Favorites for a user can be retrieved by sending a :code:`REPORT` request and specifying :code:`oc:favorite` as a filter diff --git a/developer_manual/general/codingguidelines.rst b/developer_manual/general/codingguidelines.rst index 51c5695ea..eeeef1dd5 100644 --- a/developer_manual/general/codingguidelines.rst +++ b/developer_manual/general/codingguidelines.rst @@ -31,11 +31,11 @@ The most important labels and their meaning: * #needs info - this issue needs further information from the reporter, see :doc:`../bugtracker/triaging` * #high #medium #low signify how important the bug is. * Tags showing the state of the issue or PR, numbered 0-4: - * #0 - Needs triage - ready to start development on this - * #1 - To develop - ready to start development on this - * #2 - Developing - development in progress - * #3 - To Review - ready for review - * #4 - To Release - reviewed PR that awaits unfreeze of a branch to get merged + * #0 - Needs triage - ready to start development on this + * #1 - To develop - ready to start development on this + * #2 - Developing - development in progress + * #3 - To Review - ready for review + * #4 - To Release - reviewed PR that awaits unfreeze of a branch to get merged * Feature tags: #feature: something. These tags indicate the features across apps and components which are impacted by the issue or which the PR is related to If you want a label not in the list above, please first discuss on the mailing list. diff --git a/developer_manual/general/devenv.rst b/developer_manual/general/devenv.rst index 6f062822e..199a1f9df 100644 --- a/developer_manual/general/devenv.rst +++ b/developer_manual/general/devenv.rst @@ -21,9 +21,10 @@ Get the source There are two ways to obtain Nextcloud sources: * Using the `stable version `_ -.. TODO ON RELEASE: Update version number above on release * Using the development version from `GitHub`_ which will be explained below. +.. TODO ON RELEASE: Update version number above on release + To check out the source from `GitHub`_ you will need to install Git (see `Setting up Git `_ from the GitHub help) Gather information about server setup