run remark linter locally

This commit is contained in:
A.Unger
2020-09-23 11:34:11 +02:00
parent d9e8b60f49
commit 97c348f1ae
447 changed files with 6178 additions and 6088 deletions

View File

@@ -1,10 +1,11 @@
---
* * *
title: "Ocs"
date: 2018-05-02T00:00:00+00:00
weight: 10
geekdocRepo: https://github.com/owncloud/ocis-ocs
geekdocRepo: <https://github.com/owncloud/ocis-ocs>
geekdocEditPath: edit/master/docs
geekdocFilePath: _index.md
---
## geekdocFilePath: \_index.md
This service provides the OCS API which is required by some ownCloud clients.

View File

@@ -1,28 +1,29 @@
---
* * *
title: "Building"
date: 2018-05-02T00:00:00+00:00
weight: 30
geekdocRepo: https://github.com/owncloud/ocis-ocs
geekdocRepo: <https://github.com/owncloud/ocis-ocs>
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-ocs.git
{{&lt; highlight txt >}}
git clone <https://github.com/owncloud/ocis-ocs.git>
cd ocis-ocs
{{< / 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-ocs -h` to see all available options.

View File

@@ -1,13 +1,14 @@
---
* * *
title: "Getting Started"
date: 2018-05-02T00:00:00+00:00
weight: 10
geekdocRepo: https://github.com/owncloud/ocis-ocs
geekdocRepo: <https://github.com/owncloud/ocis-ocs>
geekdocEditPath: edit/master/docs
geekdocFilePath: getting-started.md
---
{{< toc >}}
## geekdocFilePath: getting-started.md
{{&lt; toc >}}
## Installation
@@ -15,7 +16,7 @@ So far we are offering two different variants for the installation. You can choo
### Docker
Docker images for ocis-ocs are hosted on https://hub.docker.com/r/owncloud/ocis-ocs.
Docker images for ocis-ocs are hosted on <https://hub.docker.com/r/owncloud/ocis-ocs>.
The `latest` tag always reflects the current master branch.
@@ -25,7 +26,7 @@ docker pull owncloud/ocis-ocs
### Binaries
The pre-built binaries for different platforms are downloadable at https://download.owncloud.com/ocis/ocs/ . Specific releases are organized in separate folders. They are in sync which every release tag on GitHub. The binaries from the current master branch can be found in https://download.owncloud.com/ocis/ocs/testing/
The pre-built binaries for different platforms are downloadable at <https://download.owncloud.com/ocis/ocs/> . Specific releases are organized in separate folders. They are in sync which every release tag on GitHub. The binaries from the current master branch can be found in <https://download.owncloud.com/ocis/ocs/testing/>
```console
curl https://download.owncloud.com/ocis/ocis-ocs/1.0.0-beta1/ocis-ocs-1.0.0-beta1-darwin-amd64 --output ocis-ocs
@@ -41,17 +42,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-ocs 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-ocs health --help
{{< / highlight >}}
{{&lt; / highlight >}}
## Metrics

View File

@@ -1,10 +1,11 @@
---
* * *
title: "License"
date: 2018-05-02T00:00:00+00:00
weight: 40
geekdocRepo: https://github.com/owncloud/ocis-ocs
geekdocRepo: <https://github.com/owncloud/ocis-ocs>
geekdocEditPath: edit/master/docs
geekdocFilePath: license.md
---
## geekdocFilePath: license.md
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/ocs/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.