Revert "run remark linter locally"

This reverts commit 97c348f1ae.
2020-09-23 11:48:59 +02:00
parent 97c348f1ae
commit 8b9e02ec0b
447 changed files with 6088 additions and 6178 deletions
@@ -1,11 +1,10 @@
-* * *
-
+---
 title: "Phoenix"
 date: 2018-05-02T00:00:00+00:00
 weight: 10
-geekdocRepo: <https://github.com/owncloud/ocis-phoenix>
+geekdocRepo: https://github.com/owncloud/ocis-phoenix
 geekdocEditPath: edit/master/docs
-
-## geekdocFilePath: \_index.md
+geekdocFilePath: _index.md
+---

 This service embeds [Phoenix](https://github.com/owncloud/phoenix) to provide a UI for ownCloud Infinite Scale.
@@ -1,27 +1,26 @@
-* * *
-
+---
 title: "Building"
 date: 2018-05-02T00:00:00+00:00
 weight: 30
-geekdocRepo: <https://github.com/owncloud/ocis-phoenix>
+geekdocRepo: https://github.com/owncloud/ocis-phoenix
 geekdocEditPath: edit/master/docs
-
-## geekdocFilePath: building.md
+geekdocFilePath: building.md
+---

 As this project is built with Go, so you need to install that first. 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.12. After the installation of the required tools you need to get the sources:

-{{&lt; highlight txt >}}
-git clone <https://github.com/owncloud/ocis-phoenix.git>
+{{< highlight txt >}}
+git clone https://github.com/owncloud/ocis-phoenix.git
 cd ocis-phoenix
-{{&lt; / highlight >}}
+{{< / highlight >}}

 All required tool besides Go itself and make are bundled or getting automatically installed within the `GOPATH`. All commands to build this project are part of our `Makefile`.

 ## Backend

-{{&lt; highlight txt >}}
+{{< highlight txt >}}
 make generate
 make build
-{{&lt; / highlight >}}
+{{< / highlight >}}

 The above commands will download a [Phoenix](https://github.com/owncloud/phoenix) release and embed it into the binary. Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-phoenix -h` to see all available options.
@@ -1,14 +1,13 @@
-* * *
-
+---
 title: "Getting Started"
 date: 2018-05-02T00:00:00+00:00
 weight: 20
-geekdocRepo: <https://github.com/owncloud/ocis-phoenix>
+geekdocRepo: https://github.com/owncloud/ocis-phoenix
 geekdocEditPath: edit/master/docs
+geekdocFilePath: getting-started.md
+---

-## geekdocFilePath: getting-started.md
-
-{{&lt; toc >}}
+{{< toc >}}

 ## Installation

@@ -128,91 +127,91 @@ If you prefer to configure the service with commandline flags you can see the av

 #### Global

-\--config-file
+--config-file
 : Path to config file, empty default value

-\--log-level
+--log-level
 : Set logging level, defaults to `info`

-\--log-color
+--log-color
 : Enable colored logging, defaults to `true`

-\--log-pretty
+--log-pretty
 : Enable pretty logging, defaults to `true`

 #### Server

-\--tracing-enabled
+--tracing-enabled
 : Enable sending traces, defaults to `false`

-\--tracing-type
+--tracing-type
 : Tracing backend type, defaults to `jaeger`

-\--tracing-endpoint
+--tracing-endpoint
 : Endpoint for the agent, empty default value

-\--tracing-collector
+--tracing-collector
 : Endpoint for the collector, empty default value

-\--tracing-service
+--tracing-service
 : Service name for tracing, defaults to `phoenix`

-\--debug-addr
+--debug-addr
 : Address to bind debug server, defaults to `0.0.0.0:9104`

-\--debug-token
+--debug-token
 : Token to grant metrics access, empty default value

-\--debug-pprof
+--debug-pprof
 : Enable pprof debugging, defaults to `false`

-\--debug-zpages
+--debug-zpages
 : Enable zpages debugging, defaults to `false`

-\--http-addr
+--http-addr
 : Address to bind http server, defaults to `0.0.0.0:9100`

-\--http-root
+--http-root
 : Root path of http server, defaults to `/`

-\--asset-path
+--asset-path
 : Path to custom assets, empty default value

-\--web-config
+--web-config
 : Path to phoenix config, empty default value

-\--web-config-server
+--web-config-server
 : Server URL, defaults to `http://localhost:9135`

-\--web-config-theme
+--web-config-theme
 : Theme, defaults to `owncloud`

-\--web-config-version
+--web-config-version
 : Version, defaults to `0.1.0`

-\--web-config-app
+--web-config-app
 : Provide multiple apps, defaults to `""`. Usage: `phoenix --web-config-app files --web-config-app pdf-viewer`

-\--oidc-metadata-url
+--oidc-metadata-url
 : OpenID Connect metadata URL, defaults to `http://localhost:9130/.well-known/openid-configuration`

-\--oidc-authority
+--oidc-authority
 : OpenID Connect authority, defaults to `http://localhost:9130`

-\--oidc-client-id
+--oidc-client-id
 : OpenID Connect client ID, defaults to `phoenix`

-\--oidc-response-type
+--oidc-response-type
 : OpenID Connect response type, defaults to `code`

-\--oidc-scope
+--oidc-scope
 : OpenID Connect scope, defaults to `openid profile email`

 In case you want to render any additional properties in the config.json you can provide a custom config.json using  eg. `ocis-phoenix server --web-config=/path/to/config.json`

 #### Health

-\--debug-addr
+--debug-addr
 : Address to debug endpoint, defaults to `0.0.0.0:9104`

 ### Configuration file
@@ -227,17 +226,17 @@ The program provides a few sub-commands on execution. The available configuratio

 The server command is used to start the http and debug server on two addresses within a single process. The http server is serving the general webservice while the debug server is used for health check, readiness check and to server the metrics mentioned below. For further help please execute:

-{{&lt; highlight txt >}}
+{{< highlight txt >}}
 ocis-phoenix server --help
-{{&lt; / highlight >}}
+{{< / highlight >}}

 ### Health

 The health command is used to execute a health check, if the exit code equals zero the service should be up and running, if the exist code is greater than zero the service is not in a healthy state. Generally this command is used within our Docker containers, it could also be used within Kubernetes.

-{{&lt; highlight txt >}}
+{{< highlight txt >}}
 ocis-phoenix health --help
-{{&lt; / highlight >}}
+{{< / highlight >}}

 ## Metrics

@@ -1,11 +1,10 @@
-* * *
-
+---
 title: "License"
 date: 2018-05-02T00:00:00+00:00
 weight: 50
-geekdocRepo: <https://github.com/owncloud/ocis-phoenix>
+geekdocRepo: https://github.com/owncloud/ocis-phoenix
 geekdocEditPath: edit/master/docs
-
-## geekdocFilePath: license.md
+geekdocFilePath: license.md
+---

 This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/ocis-phoenix/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.
@@ -1,13 +1,12 @@
-* * *
-
+---
 title: "Releasing"
 weight: 40
-geekdocRepo: <https://github.com/owncloud/ocis-phoenix>
+geekdocRepo: https://github.com/owncloud/ocis-phoenix
 geekdocEditPath: edit/master/docs
+geekdocFilePath: releasing.md
+---

-## geekdocFilePath: releasing.md
-
-{{&lt; toc >}}
+{{< toc >}}

 ## Releasing

@@ -17,10 +16,10 @@ To update this package within all the deliveries, we need to update the package

 ### Package Hierarchy

-   [ocis](https://githug.com/owncloud/ocis)
-    -   [ocis-phoenix](https://github.com/owncloud/ocis-phoenix)
-        -   [ocis-pkg](https://github.com/owncloud/ocis-pkg)
-        -   [phoenix](https://github.com/owncloud/phoenix)
+- [ocis](https://githug.com/owncloud/ocis)
+    - [ocis-phoenix](https://github.com/owncloud/ocis-phoenix)
+      - [ocis-pkg](https://github.com/owncloud/ocis-pkg)
+      - [phoenix](https://github.com/owncloud/phoenix)

 #### Prerequisites

@@ -29,15 +28,15 @@ and take note of its release tag name.

 #### Updating ocis-phoenix

-1.  Create a branch `release-$version`. in <https://github.com/owncloud/ocis-phoenix>
-2.  Create a Folder in `changelog` for the release version and date `mkdir $major.$minor.$patchVersion_YYYY-MM-DD`.
-3.  Move all changelog items from the `changelog/unreleased/` folder to the `$major.$minor.$patchVersion_YYYY-MM-DD` folder.
-4.  Update the go module `ocis-pkg` to the latest version <https://blog.golang.org/using-go-modules> .
-5.  Update the phoenix asset by adjusting the value of `PHOENIX_ASSETS_VERSION` at the top of the Makefile and specify the tag name of the latest [Phoenix release](https://github.com/owncloud/phoenix/tags).
-6.  Run `make clean generate`.
-7.  Create a changelog item for the update in the `changelog/$major.$minor.$patchVersion_YYYY-MM-DD` folder.
-8.  Commit your changes.
-9.  After merging, wait for the CI to run on the merge commit.
+1. Create a branch `release-$version`. in <https://github.com/owncloud/ocis-phoenix>
+2. Create a Folder in `changelog` for the release version and date `mkdir $major.$minor.$patchVersion_YYYY-MM-DD`.
+3. Move all changelog items from the `changelog/unreleased/` folder to the `$major.$minor.$patchVersion_YYYY-MM-DD` folder.
+4. Update the go module `ocis-pkg` to the latest version <https://blog.golang.org/using-go-modules> .
+5. Update the phoenix asset by adjusting the value of `PHOENIX_ASSETS_VERSION` at the top of the Makefile and specify the tag name of the latest [Phoenix release](https://github.com/owncloud/phoenix/tags).
+6. Run `make clean generate`.
+7. Create a changelog item for the update in the `changelog/$major.$minor.$patchVersion_YYYY-MM-DD` folder.
+8. Commit your changes.
+9. After merging, wait for the CI to run on the merge commit.
 10. Go to "Releases" in GH click "Draft a new Release".
 11. Use `v$major.$minor.$patch` as a tag (the `v` prefix is important) and publish it.
 12. The tag and the Release artifacts will be created automatically.
@@ -45,3 +44,4 @@ and take note of its release tag name.
 #### Next steps

 Next steps is usually updating the ocis-phoenix version in the [ocis](https://githug.com/owncloud/ocis) repository.
+