From 4f3bc0c258bc1403c148bf9bcf040a19ba4d105a Mon Sep 17 00:00:00 2001 From: Artur Neumann Date: Mon, 12 Oct 2020 13:38:50 +0545 Subject: [PATCH] fix edit path --- docs/ocis/deployment/_index.md | 4 ++-- docs/ocis/deployment/basic-remote-setup.md | 2 +- docs/ocis/deployment/bridge.md | 6 +++--- docs/ocis/development/_index.md | 2 +- docs/ocis/development/building-docs.md | 6 +++--- docs/ocis/development/building.md | 4 ++-- docs/ocis/development/debugging.md | 8 ++++---- docs/ocis/development/getting-started.md | 2 +- docs/ocis/development/testing.md | 2 +- docs/ocis/development/tracing.md | 2 +- docs/ocis/eos.md | 2 +- docs/ocis/extensions.md | 4 ++-- docs/ocis/getting-started.md | 2 +- docs/ocis/license.md | 2 +- docs/ocis/login-flow.md | 4 ++-- docs/ocis/public-upload-flow.md | 2 +- docs/ocis/request-flow.md | 2 +- 17 files changed, 28 insertions(+), 28 deletions(-) diff --git a/docs/ocis/deployment/_index.md b/docs/ocis/deployment/_index.md index a09f6ecc9..1ebcd9fa4 100644 --- a/docs/ocis/deployment/_index.md +++ b/docs/ocis/deployment/_index.md @@ -3,14 +3,14 @@ title: "Deployment" date: 2020-10-01T20:35:00+01:00 weight: -10 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs/deployment +geekdocEditPath: edit/master/docs/ocis/deployment geekdocFilePath: _index.md --- {{< toc >}} ## Deployments Scenarios and Examples -This section handles deployments and operations for admins. If you are looking for a development setup, start with +This section handles deployments and operations for admins. If you are looking for a development setup, start with ### Setup oCIS oCIS deployments are super simple, yet there are many configrations possible for advanced setups. diff --git a/docs/ocis/deployment/basic-remote-setup.md b/docs/ocis/deployment/basic-remote-setup.md index c59e1bd89..ed74e1c96 100644 --- a/docs/ocis/deployment/basic-remote-setup.md +++ b/docs/ocis/deployment/basic-remote-setup.md @@ -3,7 +3,7 @@ title: "Basic Remote Setup" date: 2020-02-27T20:35:00+01:00 weight: 16 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs +geekdocEditPath: edit/master/docs/ocis/deployment geekdocFilePath: basic-remote-setup.md --- diff --git a/docs/ocis/deployment/bridge.md b/docs/ocis/deployment/bridge.md index d8e63dc7f..9f276170a 100644 --- a/docs/ocis/deployment/bridge.md +++ b/docs/ocis/deployment/bridge.md @@ -3,7 +3,7 @@ title: "Bridge" date: 2020-02-27T20:35:00+01:00 weight: 30 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs +geekdocEditPath: edit/master/docs/ocis/deployment geekdocFilePath: bridge.md --- @@ -64,7 +64,7 @@ Enter host password for user 'admin': ### Start ocis-glauth -We are going to use the above ownCloud 10 and graphapi app to turn it into the datastore for an LDAP proxy. +We are going to use the above ownCloud 10 and graphapi app to turn it into the datastore for an LDAP proxy. #### Grab it! @@ -250,5 +250,5 @@ In the above configuration replace ## Next steps Aside from the above todos these are the next stepo -- tie it all together behind `ocis-proxy` +- tie it all together behind `ocis-proxy` - create an `ocis bridge` command that runs all the ocis services in one step with a properly preconfigured `ocis-konnectd` `identifier-registration.yaml` file for `phoenix` and the owncloud 10 `openidconnect` app, as well as a randomized `--signing-kid`. diff --git a/docs/ocis/development/_index.md b/docs/ocis/development/_index.md index c67391e50..9730473ef 100644 --- a/docs/ocis/development/_index.md +++ b/docs/ocis/development/_index.md @@ -3,7 +3,7 @@ title: "Development" date: 2020-10-01T20:35:00+01:00 weight: -12 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs/development +geekdocEditPath: edit/master/docs/ocis/development geekdocFilePath: _index.md --- diff --git a/docs/ocis/development/building-docs.md b/docs/ocis/development/building-docs.md index fbe3b67a9..adcdbe625 100644 --- a/docs/ocis/development/building-docs.md +++ b/docs/ocis/development/building-docs.md @@ -3,7 +3,7 @@ title: "Build the documentation" date: 2020-07-27T08:39:38+00:00 weight: 99 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs/development +geekdocEditPath: edit/master/docs/ocis/development geekdocFilePath: building-docs.md --- @@ -26,11 +26,11 @@ hugo -D server Then open "http://localhost:1313/" -When making changes to the docs, run +When making changes to the docs, run ```bash rsync -ax --delete ../docs/ content/ -``` +``` in the hugo folder and the server will pick up the changes and reload the page automatically. diff --git a/docs/ocis/development/building.md b/docs/ocis/development/building.md index 7177f101f..b4551d90e 100644 --- a/docs/ocis/development/building.md +++ b/docs/ocis/development/building.md @@ -3,7 +3,7 @@ title: "Build ocis" date: 2020-02-27T20:35:00+01:00 weight: 30 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs/development +geekdocEditPath: edit/master/docs/ocis/development geekdocFilePath: building.md --- @@ -11,7 +11,7 @@ geekdocFilePath: building.md All required tools besides `go` and `make` are bundled or getting automatically installed within the `GOPATH`. All commands to build this project are part of our `Makefile`. -The installation of Go is out of the scope of this document, please follow the official documentation for [Go](https://golang.org/doc/install), to build this project you have to install Go >= v1.13. +The installation of Go is out of the scope of this document, please follow the official documentation for [Go](https://golang.org/doc/install), to build this project you have to install Go >= v1.13. ## Get the sources diff --git a/docs/ocis/development/debugging.md b/docs/ocis/development/debugging.md index 94905fd58..fa27dbc7c 100644 --- a/docs/ocis/development/debugging.md +++ b/docs/ocis/development/debugging.md @@ -3,7 +3,7 @@ title: "Debugging" date: 2020-03-19T08:21:00+01:00 weight: 50 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs/development +geekdocEditPath: edit/master/docs/ocis/development geekdocFilePath: debugging.md --- @@ -13,7 +13,7 @@ As a single binary for easy deployment running `ocis server` just forks itself t Ultimately, we want to be able to stop a single service using eg. `ocis kill phoenix` so that you can start the service you want to debug in debug mode. We need to [change the way we fork processes](https://github.com/owncloud/ocis/issues/77) though, otherwise the runtime will automatically restart a service if killed. -### Start ocis +### Start ocis For debugging there are two workflows that work well, depending on your preferences. @@ -146,7 +146,7 @@ This popped up when I tried to add `marie` as a collaborator in phoenix. That tr ```console # curl 'https://localhost:9200/ocs/v1.php/apps/files_sharing/api/v1/shares' -d 'shareType=0&shareWith=marie&path=%2FNeuer+Ordner&permissions=1' -u einstein:relativity -k -v | xmllint -format - -[... headers ...] +[... headers ...] @@ -182,7 +182,7 @@ The last line gives us a hint where the log message originated: `.../github.com/ 89: // WriteOCSResponse handles writing ocs responses in json and xml 90: func WriteOCSResponse(w http.ResponseWriter, r *http.Request, res *Response, err error) { 91: var encoded []byte -92: +92: 93: if err != nil { 94: appctx.GetLogger(r.Context()).Error().Err(err).Msg(res.OCS.Meta.Message) 95: } diff --git a/docs/ocis/development/getting-started.md b/docs/ocis/development/getting-started.md index a52d3142e..679dd7f2b 100644 --- a/docs/ocis/development/getting-started.md +++ b/docs/ocis/development/getting-started.md @@ -3,7 +3,7 @@ title: "Getting Started with Development" date: 2020-07-07T20:35:00+01:00 weight: 15 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs/development +geekdocEditPath: edit/master/docs/ocis/development geekdocFilePath: getting-started.md --- diff --git a/docs/ocis/development/testing.md b/docs/ocis/development/testing.md index 28337a132..7252130cb 100644 --- a/docs/ocis/development/testing.md +++ b/docs/ocis/development/testing.md @@ -3,7 +3,7 @@ title: "Testing" date: 2018-05-02T00:00:00+00:00 weight: 37 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs/development +geekdocEditPath: edit/master/docs/ocis/development geekdocFilePath: testing.md --- diff --git a/docs/ocis/development/tracing.md b/docs/ocis/development/tracing.md index 39a3ab81d..7da876677 100644 --- a/docs/ocis/development/tracing.md +++ b/docs/ocis/development/tracing.md @@ -3,7 +3,7 @@ title: "Tracing" date: 2020-05-13T12:09:00+01:00 weight: 55 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs/development +geekdocEditPath: edit/master/docs/ocis/development geekdocFilePath: tracing.md --- diff --git a/docs/ocis/eos.md b/docs/ocis/eos.md index 7c7b84cb2..5669f9633 100644 --- a/docs/ocis/eos.md +++ b/docs/ocis/eos.md @@ -3,7 +3,7 @@ title: "EOS" date: 2020-02-27T20:35:00+01:00 weight: 30 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs +geekdocEditPath: edit/master/docs/ocis geekdocFilePath: eos.md --- diff --git a/docs/ocis/extensions.md b/docs/ocis/extensions.md index 4fd9d2bbe..5406f083d 100644 --- a/docs/ocis/extensions.md +++ b/docs/ocis/extensions.md @@ -3,7 +3,7 @@ title: "Extension" date: 2020-02-27T20:35:00+01:00 weight: 40 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs +geekdocEditPath: edit/master/docs/ocis geekdocFilePath: extensions.md --- @@ -234,4 +234,4 @@ Long answer: micro and ocis-hello follow a protocol driven development: - they might be about user, contacrs, calendars ... which is covered by the graph api - we want to integrate with eg. kopano and provide a commen api (file sync and share is covered as well) -- as an example for protobuf take a look at [ocis-hello](https://github.com/owncloud/ocis-hello/tree/master/pkg/proto/v0) \ No newline at end of file +- as an example for protobuf take a look at [ocis-hello](https://github.com/owncloud/ocis-hello/tree/master/pkg/proto/v0) diff --git a/docs/ocis/getting-started.md b/docs/ocis/getting-started.md index d12a42059..2f10e3e70 100644 --- a/docs/ocis/getting-started.md +++ b/docs/ocis/getting-started.md @@ -3,7 +3,7 @@ title: "Getting Started" date: 2020-02-27T20:35:00+01:00 weight: -15 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs +geekdocEditPath: edit/master/docs/ocis geekdocFilePath: getting-started.md --- diff --git a/docs/ocis/license.md b/docs/ocis/license.md index 64460ec7e..ee6b3be08 100644 --- a/docs/ocis/license.md +++ b/docs/ocis/license.md @@ -3,7 +3,7 @@ title: "License" date: 2020-02-27T20:35:00+01:00 weight: 100 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs +geekdocEditPath: edit/master/docs/ocis geekdocFilePath: license.md --- diff --git a/docs/ocis/login-flow.md b/docs/ocis/login-flow.md index ab450d901..9f03c9fd4 100644 --- a/docs/ocis/login-flow.md +++ b/docs/ocis/login-flow.md @@ -3,7 +3,7 @@ title: "Login Flow" date: 2020-05-04T20:47:00+01:00 weight: 43 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs +geekdocEditPath: edit/master/docs/ocis geekdocFilePath: login-flow.md --- @@ -82,4 +82,4 @@ sequenceDiagram client->>+proxy: PROPFIND
With access token proxy-->>-client: 207 Multi-Status client-->>-user: List of Files X, Y, Z ... -{{< /mermaid >}} \ No newline at end of file +{{< /mermaid >}} diff --git a/docs/ocis/public-upload-flow.md b/docs/ocis/public-upload-flow.md index 399a5379b..b72e5b033 100644 --- a/docs/ocis/public-upload-flow.md +++ b/docs/ocis/public-upload-flow.md @@ -3,7 +3,7 @@ title: "Public upload Flow" date: 2020-07-27T14:16:00+01:00 weight: 47 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs +geekdocEditPath: edit/master/docs/ocis geekdocFilePath: public-upload-flow.md --- diff --git a/docs/ocis/request-flow.md b/docs/ocis/request-flow.md index 268aaa2a7..b219f2cd1 100644 --- a/docs/ocis/request-flow.md +++ b/docs/ocis/request-flow.md @@ -3,7 +3,7 @@ title: "Request Flow" date: 2020-04-27T16:07:00+01:00 weight: 45 geekdocRepo: https://github.com/owncloud/ocis -geekdocEditPath: edit/master/docs +geekdocEditPath: edit/master/docs/ocis geekdocFilePath: request-flow.md ---