Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions antora.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ prerelease: true
start_page: ROOT:index.adoc
nav:
- modules/ROOT/partials/nav.adoc
- modules/developer/partials/nav.adoc

asciidoc:
attributes:
Expand All @@ -23,6 +24,9 @@ asciidoc:
# https://github.com/owncloud/ocis-charts/tree/master/charts/ocis/docs
s-path: 'deployment/services/s-list'

# same as s-path but for the developer documentation
s-dev-path: 'services/s-list'

# the name of the sub directory that defines the sources folder used in the compose deployment examples
ocis_wopi: ocis_full

Expand Down Expand Up @@ -66,6 +70,7 @@ asciidoc:
# static path components, used to assemble the final path dependent on service_url_component to include services
ocis_services_raw_url: 'https://raw.githubusercontent.com/owncloud/ocis/'
ocis_services_final_path: '/services/_includes/'
ocis_services_dev_path: '/services/'

# only used in deployment/services/env-var-changes.adoc
# static path component, used to assemble the final path
Expand Down
3 changes: 1 addition & 2 deletions modules/ROOT/partials/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
* xref:index.adoc[Introduction]
include::admin:partial$nav.adoc[]
// include::developer:partial$nav.adoc[]

include::developer:partial$nav.adoc[]
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Auth Basic Service Configuration
:toc: right
:description: The Infinite Scale Auth Basic service provides basic authentication for those clients who cannot handle O>
:description: The Infinite Scale Auth Basic service provides basic authentication for those clients who cannot handle OIDC. This is a rare case, is usually not necessary and mainly used for tests or development.
:page-aliases: ROOT:deployment/services/s-list/auth-basic.adoc

:service_name: auth-basic
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= Auth Machine Service Configuration
:toc: right
:description: The Infinite Scale Auth Machine service
:description: The Infinite Scale Auth Machine service.
:page-aliases: ROOT:deployment/services/s-list/auth-machine.adoc

:service_name: auth-machine
Expand Down
2 changes: 1 addition & 1 deletion modules/admin/pages/deployment/services/s-list/ocdav.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= OCDAV Service Configuration
:toc: right
:description: The ocDAV service is responsible for translating ownCloud-flavored WebDAV into CS3 API calls. Note that previews (thumbnails) are provided by the xref:{s-path}/webdav.adoc[WebDAV service].
:description: The ocDAV service is responsible for translating ownCloud-flavored WebDAV into CS3 API calls. Note that previews (thumbnails) are provided by the WebDAV service.
:page-aliases: ROOT:deployment/services/s-list/ocdav.adoc

// references https://github.com/owncloud/ocis/pull/3864 ([docs-only] add PROPFIND sequence diagram examples)
Expand Down
2 changes: 1 addition & 1 deletion modules/admin/pages/deployment/services/s-list/ocm.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
= OCM Configuration
:toc: right
:ocm-api-version: 1.1.0
:description: The Infinite Scale OCM service provides federated sharing functionality based on ScienceMesh and the OCM {ocm-api-version} HTTP API.
:description: The Infinite Scale OCM service provides federated sharing functionality based on ScienceMesh and the OCM 1.1.0 HTTP API.
:page-aliases: ROOT:deployment/services/s-list/ocm.adoc

:site-object-url: https://developer.sciencemesh.io/docs/technical-documentation/central-database/#site-object
Expand Down
2 changes: 1 addition & 1 deletion modules/admin/pages/deployment/services/s-list/proxy.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ include::partial$multi-location/compose-version.adoc[]

{description} Every HTTP request goes through this service. Authentication, logging and other preprocessing of requests also happens here. Mechanisms like request rate limiting or intrusion prevention are **not** included in the proxy service and must be set up in front of an external reverse proxy.

See the https://owncloud.dev/services/proxy/[Developer Documentation] for details if you want to write your own extensions and need to change or add routes to endpoints.
See the xref:developer:{s-dev-path}/proxy/index.adoc[Developer Documentation] for details if you want to write your own extensions and need to change or add routes to endpoints.

== Default Values

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@

{description} and is also responsible for presenting images, not only thumbnails to the client. It retrieves the sources at the location where the user files are stored and saves the thumbnails where system files are stored. Those locations have defaults but can be manually defined via environment variables.

Note for developers, more information is available with regards to querying thumbnails in the services section of the https://owncloud.dev/services/thumbnails/[Developer Documentation].
Note for developers, more information is available with regards to querying thumbnails in the services section of the xref:developer:{s-dev-path}/thumbnails/thumbnails.adoc/[Developer Documentation].

== Default Values

Expand Down
2 changes: 1 addition & 1 deletion modules/admin/pages/deployment/services/s-list/webdav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

== Introduction

{description} It receives HTTP calls from requestors like clients and issues gRPC calls to other services executing these requests. After the called service has finished the request, the webdav service will render their responses in `xml` and sends them back to the requestor. Also see the xref:{s-path}/ocdav.adoc[ocdav] service.
{description} It receives HTTP calls from requestors like clients and issues gRPC calls to other services executing these requests. After the called service has finished the request, the webdav service will render their responses in `xml` and sends them back to the requestor. Also see the xref:{s-path}/ocdav.adoc[ocdav] service.

== Default Values

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/developer/images/ocis/cs3org.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/developer/images/ocis/grpc-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added modules/developer/images/ocis/http-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading