run remark linter locally

2026-01-06 12:19:37 -06:00 · 2020-09-23 11:34:11 +02:00
parent d9e8b60f49
commit 97c348f1ae
447 changed files with 6178 additions and 6088 deletions
--- a/store/CHANGELOG.md
+++ b/store/CHANGELOG.md
@@ -1,4 +1,4 @@
-# Changelog for [0.1.1] (2020-08-17)
+# Changelog for [0.1.1] \(2020-08-17)

 The following sections list the changes in ocis-store 0.1.1.

@@ -6,18 +6,18 @@ The following sections list the changes in ocis-store 0.1.1.

 ## Summary

-* Bugfix - Removed code from other service: [#7](https://github.com/owncloud/ocis/store/pull/7)
+-   Bugfix - Removed code from other service: [#7](https://github.com/owncloud/ocis/store/pull/7)

 ## Details

-* Bugfix - Removed code from other service: [#7](https://github.com/owncloud/ocis/store/pull/7)
+-   Bugfix - Removed code from other service: [#7](https://github.com/owncloud/ocis/store/pull/7)

-   We had code copied over from another repository which doesn't belong in here and now removed it
-   again.
+     We had code copied over from another repository which doesn't belong in here and now removed it
+     again.

-   https://github.com/owncloud/ocis/store/pull/7
+     <https://github.com/owncloud/ocis/store/pull/7>

-# Changelog for [0.1.0] (2020-07-23)
+# Changelog for [0.1.0] \(2020-07-23)

 The following sections list the changes in ocis-store 0.1.0.

@@ -25,27 +25,27 @@ The following sections list the changes in ocis-store 0.1.0.

 ## Summary

-* Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#5](https://github.com/owncloud/ocis/store/pull/5)
-* Change - Initial release of basic version: [#1](https://github.com/owncloud/ocis/store/pull/1)
+-   Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#5](https://github.com/owncloud/ocis/store/pull/5)
+-   Change - Initial release of basic version: [#1](https://github.com/owncloud/ocis/store/pull/1)

 ## Details

-* Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#5](https://github.com/owncloud/ocis/store/pull/5)
+-   Bugfix - Build docker images with alpine:latest instead of alpine:edge: [#5](https://github.com/owncloud/ocis/store/pull/5)

-   ARM builds were failing when built on alpine:edge, so we switched to alpine:latest instead.
+     ARM builds were failing when built on alpine:edge, so we switched to alpine:latest instead.

-   https://github.com/owncloud/ocis/store/pull/5
+     <https://github.com/owncloud/ocis/store/pull/5>


-* Change - Initial release of basic version: [#1](https://github.com/owncloud/ocis/store/pull/1)
+-   Change - Initial release of basic version: [#1](https://github.com/owncloud/ocis/store/pull/1)

-   We have built a new service which implements go micro's [store
-   interface](https://github.com/micro/development/blob/master/design/framework/store.md),
-   so that we can provide a key-value-store through GRPC for our services. The underlying
-   implementation stores data as json files on disk and maintains an index using
-   [bleve](https://github.com/blevesearch/bleve).
+     We have built a new service which implements go micro's [store
+     interface](https://github.com/micro/development/blob/master/design/framework/store.md),
+     so that we can provide a key-value-store through GRPC for our services. The underlying
+     implementation stores data as json files on disk and maintains an index using
+     [bleve](https://github.com/blevesearch/bleve).

-   https://github.com/owncloud/ocis/store/pull/1
-   https://github.com/owncloud/ocis/store/pull/2
+     <https://github.com/owncloud/ocis/store/pull/1>
+     <https://github.com/owncloud/ocis/store/pull/2>

-}}
+\-}}
--- a/store/README.md
+++ b/store/README.md
@@ -23,7 +23,7 @@ make generate build

 ## Security

-If you find a security issue please contact security@owncloud.com first.
+If you find a security issue please contact [security@owncloud.com](mailto:security@owncloud.com) first.

 ## Contributing

@@ -41,18 +41,16 @@ Copyright (c) 2020 ownCloud GmbH <https://owncloud.com>

 ## Design

-```
-/var/tmp
-    /ocis-store
-        /index.bleve
-        /databases
-            /ocs
-                /users
-            /settings
-                /bundles
-                /values
-                /assignments
-            /accounts
+    /var/tmp
+        /ocis-store
+            /index.bleve
+            /databases
+                /ocs
+                    /users
+                /settings
+                    /bundles
+                    /values
+                    /assignments
                /accounts
-                /groups
-```
+                    /accounts
+                    /groups
--- a/store/changelog/0.1.0_2020-07-23/initial-release.md
+++ b/store/changelog/0.1.0_2020-07-23/initial-release.md
@@ -4,5 +4,5 @@ We have built a new service which implements go micro's [store interface](https:
 so that we can provide a key-value-store through GRPC for our services. The underlying implementation stores data as json
 files on disk and maintains an index using [bleve](https://github.com/blevesearch/bleve).

-https://github.com/owncloud/ocis/store/pull/1
-https://github.com/owncloud/ocis/store/pull/2
+<https://github.com/owncloud/ocis/store/pull/1>
+<https://github.com/owncloud/ocis/store/pull/2>
--- a/store/changelog/0.1.0_2020-07-23/use-alpine-latest.md
+++ b/store/changelog/0.1.0_2020-07-23/use-alpine-latest.md
@@ -2,4 +2,4 @@ Bugfix: build docker images with alpine:latest instead of alpine:edge

 ARM builds were failing when built on alpine:edge, so we switched to alpine:latest instead.

-https://github.com/owncloud/ocis/store/pull/5
+<https://github.com/owncloud/ocis/store/pull/5>
--- a/store/changelog/0.1.1_2020-08-17/cleanup-code.md
+++ b/store/changelog/0.1.1_2020-08-17/cleanup-code.md
@@ -2,5 +2,4 @@ Bugfix: Removed code from other service

 We had code copied over from another repository which doesn't belong in here and now removed it again.

-https://github.com/owncloud/ocis/store/pull/7
-
+<https://github.com/owncloud/ocis/store/pull/7>
--- a/store/docs/_index.md
+++ b/store/docs/_index.md
@@ -1,10 +1,11 @@
---
+* * *
+
 title: "Store"
 date: 2018-05-02T00:00:00+00:00
 weight: 10
-geekdocRepo: https://github.com/owncloud/ocis-store
+geekdocRepo: <https://github.com/owncloud/ocis-store>
 geekdocEditPath: edit/master/docs
-geekdocFilePath: _index.md
---
+
+## geekdocFilePath: \_index.md

 This service provides ...
--- a/store/docs/building.md
+++ b/store/docs/building.md
@@ -1,28 +1,29 @@
---
+* * *
+
 title: "Building"
 date: 2018-05-02T00:00:00+00:00
 weight: 30
-geekdocRepo: https://github.com/owncloud/ocis-store
+geekdocRepo: <https://github.com/owncloud/ocis-store>
 geekdocEditPath: edit/master/docs
-geekdocFilePath: building.md
---

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

 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:

-{{< highlight txt >}}
-git clone https://github.com/owncloud/ocis-store.git
+{{&lt; highlight txt >}}
+git clone <https://github.com/owncloud/ocis-store.git>
 cd ocis-store
-{{< / highlight >}}
+{{&lt; / 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

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

 Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-store -h` to see all available options.
--- a/store/docs/getting-started.md
+++ b/store/docs/getting-started.md
@@ -1,13 +1,14 @@
---
+* * *
+
 title: "Getting Started"
 date: 2018-05-02T00:00:00+00:00
 weight: 20
-geekdocRepo: https://github.com/owncloud/ocis-store
+geekdocRepo: <https://github.com/owncloud/ocis-store>
 geekdocEditPath: edit/master/docs
-geekdocFilePath: getting-started.md
---

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

 ## Installation

@@ -92,59 +93,59 @@ 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 `store`

--debug-addr
+\--debug-addr
 : Address to bind debug server

--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:9461`

--http-namespace
+\--http-namespace
 : Namespace for internal services communication, defaults to `com.owncloud.web`

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

 #### Health

--debug-addr
+\--debug-addr
 : Address to debug endpoint

 ### Configuration file
@@ -159,17 +160,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:

-{{< highlight txt >}}
+{{&lt; highlight txt >}}
 ocis-store server --help
-{{< / highlight >}}
+{{&lt; / 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.

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

 ## Metrics

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

 This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/store/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.