From 26b2bcdd464f194c06f806a2e340c955678b0c75 Mon Sep 17 00:00:00 2001 From: Matthew Setter Date: Wed, 11 Sep 2019 11:40:56 +0200 Subject: [PATCH] Fix build errors (#1754) * Fix up incorrect header levels Some of the headers were at inconsistent nesting levels within the structure of the page that they were one, others were not included with the correct level offset. Both of these situations are corrected in this change. * Update references to totp user is not found response examples The include link to the JSON example was corrected and the XML example file was updated to keep consistency with the JSON example as well as the section. The last thing that I want to have happen is to have confusion at some future point as to whether the XML file should be there, is incorrectly linked, etc, all because of a minor name difference. * Fix missing attribute reference warnings There were a number of places where either the attribute wasn't defined, wasn't being passed on to an included file, or was being incorrectly interpreted as an attribute. This change corrects all of these problems. * Remove unnecessary custom ids These aren't necessary, as ones exactly the same will be generated by Antora. --- .../encryption_configuration_quick_guide.adoc | 2 +- .../configuration/files/encryption/index.adoc | 2 +- .../configuration/server/occ_command.adoc | 4 +- .../windows-network-drive_configuration.adoc | 1 + .../installation/installation_wizard.adoc | 1 - .../pages/installation/ubuntu_18_04.adoc | 2 +- ...t-valid.xml => totp-user-is-not-found.xml} | 0 .../webdav_api/core_curl_request.adoc | 7 +- .../pages/core/apis/ocs-share-api.adoc | 68 +++++++++---------- .../core/apis/ocs-totp-validation-api.adoc | 18 ++--- .../groups/custom_groups_endpoints.adoc | 3 +- .../groups/group_membership_endpoints.adoc | 1 + .../pages/webdav_api/tags.adoc | 5 -- 13 files changed, 55 insertions(+), 59 deletions(-) rename modules/developer_manual/examples/core/apis/ocs/totp-validation/responses/xml/{totp-user-is-not-valid.xml => totp-user-is-not-found.xml} (100%) diff --git a/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration_quick_guide.adoc b/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration_quick_guide.adoc index 71597d869f..6ac8865c85 100644 --- a/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration_quick_guide.adoc +++ b/modules/admin_manual/pages/configuration/files/encryption/encryption_configuration_quick_guide.adoc @@ -2,7 +2,7 @@ :toc: right :toclevels: 1 -include::encryption-types.adoc[leveloffset=2] +include::encryption-types.adoc[leveloffset=+1] include::enable-encryption.adoc[leveloffset=+1] diff --git a/modules/admin_manual/pages/configuration/files/encryption/index.adoc b/modules/admin_manual/pages/configuration/files/encryption/index.adoc index 9ea2102324..06933664a1 100644 --- a/modules/admin_manual/pages/configuration/files/encryption/index.adoc +++ b/modules/admin_manual/pages/configuration/files/encryption/index.adoc @@ -83,7 +83,7 @@ This is, potentially, exploitable by anyone with administrator access to your se For more information, read: https://owncloud.org/blog/how-owncloud-uses-encryption-to-protect-your-data/[How ownCloud uses encryption to protect your data]. ==== -include::encryption-types.adoc[leveloffset=+1] +include::encryption-types.adoc[leveloffset=+2] [[before-enabling-encryption]] == Before Enabling Encryption diff --git a/modules/admin_manual/pages/configuration/server/occ_command.adoc b/modules/admin_manual/pages/configuration/server/occ_command.adoc index 3500d0b31f..ccff9b4e6f 100644 --- a/modules/admin_manual/pages/configuration/server/occ_command.adoc +++ b/modules/admin_manual/pages/configuration/server/occ_command.adoc @@ -3310,7 +3310,7 @@ You can run migration steps with the `migrations` command. {occ-command-example-prefix} migrations:execute ---- -===== Arguments +==== Arguments [width="100%",cols="20%,70%",] |=== @@ -3318,7 +3318,7 @@ You can run migration steps with the `migrations` command. | `version` | The version to execute. |=== -===== Example +==== Example This example executes the migration step for the core app: diff --git a/modules/admin_manual/pages/enterprise/external_storage/windows-network-drive_configuration.adoc b/modules/admin_manual/pages/enterprise/external_storage/windows-network-drive_configuration.adoc index e248a3e016..2e30a69a1a 100644 --- a/modules/admin_manual/pages/enterprise/external_storage/windows-network-drive_configuration.adoc +++ b/modules/admin_manual/pages/enterprise/external_storage/windows-network-drive_configuration.adoc @@ -11,6 +11,7 @@ :smb2-url: https://en.wikipedia.org/wiki/Server_Message_Block#SMB_2.0 :smbclient-manpage-url: https://www.samba.org/samba/docs/man/manpages-3/smbclient.1.html :wannacry-ransomware-attack-url: https://en.wikipedia.org/wiki/WannaCry_ransomware_attack +:wnd-config-path: enterprise/external_storage/windows-network-drive_configuration.adoc == Introduction diff --git a/modules/admin_manual/pages/installation/installation_wizard.adoc b/modules/admin_manual/pages/installation/installation_wizard.adoc index 8e330b8367..450c16fcd4 100644 --- a/modules/admin_manual/pages/installation/installation_wizard.adoc +++ b/modules/admin_manual/pages/installation/installation_wizard.adoc @@ -171,7 +171,6 @@ For PostgreSQL: Click Finish Setup, and you’re ready to start using your new ownCloud server. -[[post-installation-steps]] == Post-Installation Steps Now we will look at some important post-installation steps. For hardened diff --git a/modules/admin_manual/pages/installation/ubuntu_18_04.adoc b/modules/admin_manual/pages/installation/ubuntu_18_04.adoc index aac7725cab..cf2069646d 100644 --- a/modules/admin_manual/pages/installation/ubuntu_18_04.adoc +++ b/modules/admin_manual/pages/installation/ubuntu_18_04.adoc @@ -207,7 +207,7 @@ include::{examplesdir}installation/ubuntu/18.04/configure-log-rotation.sh[] ==== Finalise the Installation -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}installation/ubuntu/18.04/finalise-install.sh[] ---- diff --git a/modules/developer_manual/examples/core/apis/ocs/totp-validation/responses/xml/totp-user-is-not-valid.xml b/modules/developer_manual/examples/core/apis/ocs/totp-validation/responses/xml/totp-user-is-not-found.xml similarity index 100% rename from modules/developer_manual/examples/core/apis/ocs/totp-validation/responses/xml/totp-user-is-not-valid.xml rename to modules/developer_manual/examples/core/apis/ocs/totp-validation/responses/xml/totp-user-is-not-found.xml diff --git a/modules/developer_manual/pages/_partials/webdav_api/core_curl_request.adoc b/modules/developer_manual/pages/_partials/webdav_api/core_curl_request.adoc index 781853bd0b..287bd26bab 100644 --- a/modules/developer_manual/pages/_partials/webdav_api/core_curl_request.adoc +++ b/modules/developer_manual/pages/_partials/webdav_api/core_curl_request.adoc @@ -1,12 +1,11 @@ -[subs="attributes+"] -[source,console] -.... +[source,console,subs="attributes+"] +---- curl --silent \ -X {request_method} \ ifdef::request_data_file[] --data "@{request_data_file}" \ endif::[] - -u {username}:{password} \ + -u {oc-examples-username}:{oc-examples-password} \ 'http://localhost/{request_base_path}/{request_path_suffix}' \ | xmllint --format - .... diff --git a/modules/developer_manual/pages/core/apis/ocs-share-api.adoc b/modules/developer_manual/pages/core/apis/ocs-share-api.adoc index d755fa362f..7e1d6b3c8a 100644 --- a/modules/developer_manual/pages/core/apis/ocs-share-api.adoc +++ b/modules/developer_manual/pages/core/apis/ocs-share-api.adoc @@ -112,7 +112,7 @@ include::{examplesdir}core/scripts/responses/shares/list-share-details-success.j Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/list-share-details.sh[] ---- @@ -120,7 +120,7 @@ include::{examplesdir}core/scripts/curl/list-share-details.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/list-share-details.php[] ---- @@ -128,7 +128,7 @@ include::{examplesdir}core/scripts/php/list-share-details.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/list-share-details.rb[] ---- @@ -136,7 +136,7 @@ include::{examplesdir}core/scripts/ruby/list-share-details.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/list-share-details.go[] ---- @@ -175,7 +175,7 @@ include::{examplesdir}core/scripts/go/list-share-details.go[] Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/get-share-info.sh[] ---- @@ -183,7 +183,7 @@ include::{examplesdir}core/scripts/curl/get-share-info.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/get-share-info.php[] ---- @@ -191,7 +191,7 @@ include::{examplesdir}core/scripts/php/get-share-info.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/get-share-info.rb[] ---- @@ -199,7 +199,7 @@ include::{examplesdir}core/scripts/ruby/get-share-info.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/get-share-info.go[] ---- @@ -207,7 +207,7 @@ include::{examplesdir}core/scripts/go/get-share-info.go[] Kotlin:: + -- -[source,kotlin,subs="attributes+"] +[source,kotlin] ---- include::{examplesdir}core/scripts/kotlin/get-share-info.kt[] ---- @@ -215,7 +215,7 @@ include::{examplesdir}core/scripts/kotlin/get-share-info.kt[] Java:: + -- -[source,java,subs="attributes+"] +[source,java] ---- include::{examplesdir}core/scripts/java/get-share-info.java[] ---- @@ -231,7 +231,7 @@ NOTE: The Java and Kotlin examples use https://github.com/square/okhttp[the squa Success:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/responses/shares/get-share-info-success.xml[] ---- @@ -239,7 +239,7 @@ include::{examplesdir}core/scripts/responses/shares/get-share-info-success.xml[] Failure:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/responses/shares/get-share-info-failure.xml[] ---- @@ -293,7 +293,7 @@ Success:: + -- .Pending share was successfully accepted -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/responses/shares/accept-pending-share-success.xml[] ---- @@ -302,7 +302,7 @@ Failure:: + -- .The share id does not exist. -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/responses/shares/accept-pending-share-failure.xml[] ---- @@ -316,7 +316,7 @@ include::{examplesdir}core/scripts/responses/shares/accept-pending-share-failure Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/accept-pending-share.sh[] ---- @@ -324,7 +324,7 @@ include::{examplesdir}core/scripts/curl/accept-pending-share.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/accept-pending-share.php[] ---- @@ -332,7 +332,7 @@ include::{examplesdir}core/scripts/php/accept-pending-share.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/accept-pending-share.rb[] ---- @@ -340,7 +340,7 @@ include::{examplesdir}core/scripts/ruby/accept-pending-share.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/accept-pending-share.go[] ---- @@ -423,7 +423,7 @@ a| Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/decline-pending-share.sh[] ---- @@ -431,7 +431,7 @@ include::{examplesdir}core/scripts/curl/decline-pending-share.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/decline-pending-share.php[] ---- @@ -439,7 +439,7 @@ include::{examplesdir}core/scripts/php/decline-pending-share.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/decline-pending-share.rb[] ---- @@ -447,7 +447,7 @@ include::{examplesdir}core/scripts/ruby/decline-pending-share.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/decline-pending-share.go[] ---- @@ -540,7 +540,7 @@ XML containing the share ID (int) of the newly created share Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/create-share.sh[] ---- @@ -548,7 +548,7 @@ include::{examplesdir}core/scripts/curl/create-share.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/create-share.php[] ---- @@ -556,7 +556,7 @@ include::{examplesdir}core/scripts/php/create-share.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/create-share.rb[] ---- @@ -564,7 +564,7 @@ include::{examplesdir}core/scripts/ruby/create-share.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/create-share.go[] ---- @@ -699,7 +699,7 @@ Remove the given share. Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/delete-share.sh[] ---- @@ -707,7 +707,7 @@ include::{examplesdir}core/scripts/curl/delete-share.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/delete-share.php[] ---- @@ -715,7 +715,7 @@ include::{examplesdir}core/scripts/php/delete-share.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/delete-share.rb[] ---- @@ -723,7 +723,7 @@ include::{examplesdir}core/scripts/ruby/delete-share.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/delete-share.go[] ---- @@ -795,7 +795,7 @@ NOTE: Only one of the update parameters can be specified at once. Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/update-share.sh[] ---- @@ -803,7 +803,7 @@ include::{examplesdir}core/scripts/curl/update-share.sh[] PHP:: + -- -[source,php,subs="attributes+"] +[source,php] ---- include::{examplesdir}core/scripts/php/update-share.php[] ---- @@ -811,7 +811,7 @@ include::{examplesdir}core/scripts/php/update-share.php[] Ruby:: + -- -[source,ruby,subs="attributes+"] +[source,ruby] ---- include::{examplesdir}core/scripts/ruby/update-share.rb[] ---- @@ -819,7 +819,7 @@ include::{examplesdir}core/scripts/ruby/update-share.rb[] Go:: + -- -[source,go,subs="attributes+"] +[source,go] ---- include::{examplesdir}core/scripts/go/update-share.go[] ---- diff --git a/modules/developer_manual/pages/core/apis/ocs-totp-validation-api.adoc b/modules/developer_manual/pages/core/apis/ocs-totp-validation-api.adoc index aa6d79c3bb..90339d6f3d 100644 --- a/modules/developer_manual/pages/core/apis/ocs-totp-validation-api.adoc +++ b/modules/developer_manual/pages/core/apis/ocs-totp-validation-api.adoc @@ -47,7 +47,7 @@ This API requires {2fa-app-url}[the 2-Factor Authentication app] to be installed Curl:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/scripts/curl/ocs/validate-totp.sh[] ---- @@ -77,7 +77,7 @@ If the user was not found, then: JSON:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/apis/ocs/totp-validation/responses/json/totp-is-valid.json[] ---- @@ -86,7 +86,7 @@ include::{examplesdir}core/apis/ocs/totp-validation/responses/json/totp-is-valid XML:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/apis/ocs/totp-validation/responses/json/totp-is-valid.json[] ---- @@ -100,7 +100,7 @@ include::{examplesdir}core/apis/ocs/totp-validation/responses/json/totp-is-valid JSON:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/apis/ocs/totp-validation/responses/xml/totp-is-valid.xml[] ---- @@ -109,7 +109,7 @@ include::{examplesdir}core/apis/ocs/totp-validation/responses/xml/totp-is-valid. XML:: + -- -[source,console,subs="attributes+"] +[source,console] ---- include::{examplesdir}core/apis/ocs/totp-validation/responses/xml/totp-is-valid.xml[] ---- @@ -123,18 +123,18 @@ include::{examplesdir}core/apis/ocs/totp-validation/responses/xml/totp-is-valid. JSON:: + -- -[source,console,subs="attributes+"] +[source,console] ---- -include::{examplesdir}core/apis/ocs/totp-validation/responses/json/totp-user-is-not-valid.json[] +include::{examplesdir}core/apis/ocs/totp-validation/responses/json/totp-user-is-not-found.json[] ---- -- XML:: + -- -[source,console,subs="attributes+"] +[source,console] ---- -include::{examplesdir}core/apis/ocs/totp-validation/responses/xml/totp-user-is-not-valid.xml[] +include::{examplesdir}core/apis/ocs/totp-validation/responses/xml/totp-user-is-not-found.xml[] ---- -- ==== diff --git a/modules/developer_manual/pages/webdav_api/groups/custom_groups_endpoints.adoc b/modules/developer_manual/pages/webdav_api/groups/custom_groups_endpoints.adoc index 25af61c7c4..1e3619db87 100644 --- a/modules/developer_manual/pages/webdav_api/groups/custom_groups_endpoints.adoc +++ b/modules/developer_manual/pages/webdav_api/groups/custom_groups_endpoints.adoc @@ -1,7 +1,8 @@ === List Groups :page-partial: -:request_method: PROPFIND +:request_base_path: remote.php/dav/customgroups/groups :request_data_file: list-custom-groups.xml +:request_method: PROPFIND :request_path_suffix: // this page is included via groups.adoc diff --git a/modules/developer_manual/pages/webdav_api/groups/group_membership_endpoints.adoc b/modules/developer_manual/pages/webdav_api/groups/group_membership_endpoints.adoc index f5b6c048bb..fc9b6082ef 100644 --- a/modules/developer_manual/pages/webdav_api/groups/group_membership_endpoints.adoc +++ b/modules/developer_manual/pages/webdav_api/groups/group_membership_endpoints.adoc @@ -1,5 +1,6 @@ == Group Membership :page-partial: +:request_base_path: /remote.php/dav/customgroups/users // this page is included via groups.adoc // some variables like request_base_path used in includes here are defined there diff --git a/modules/developer_manual/pages/webdav_api/tags.adoc b/modules/developer_manual/pages/webdav_api/tags.adoc index 408989ebfc..87960951b4 100644 --- a/modules/developer_manual/pages/webdav_api/tags.adoc +++ b/modules/developer_manual/pages/webdav_api/tags.adoc @@ -242,7 +242,6 @@ curl -u username:password -X PROPFIND \ "http://localhost/remote.php/dav/systemtags-relations/files/4" | xmllint --format - .... -[[response-2]] === Response [source,xml] @@ -332,7 +331,6 @@ curl -u username:password -X PUT \ "http://localhost/remote.php/dav/systemtags-relations/files/4/6" .... -[[response-3]] === Response If the request is successful, no response body will be returned, but an @@ -342,7 +340,6 @@ successful, then either an `HTTP/1.1 404 Not Found` or an returned if the file or folder doesn’t exist. A 409 status is returned if the tag has already been assigned to that file or folder. -[[unassign-a-tag-from-a-file]] == Unassign a Tag From a File [cols=",,",options="header",] @@ -362,7 +359,6 @@ curl --silent --verbose -u username:password -X DELETE \ "http://localhost/remote.php/dav/systemtags-relations/files/4/6" .... -[[response-4]] === Response If the request is successful, no response body will be returned, but an @@ -451,7 +447,6 @@ curl --silent --verbose -u username:password -X REPORT \ "http://localhost/remote.php/webdav/" | xmllint --format - .... -[[response-5]] === Response A successful response which you can see an example of below, along with