Revert "run remark linter locally"

This reverts commit 97c348f1ae.
This commit is contained in:
A.Unger
2020-09-23 11:48:59 +02:00
parent 97c348f1ae
commit 8b9e02ec0b
447 changed files with 6088 additions and 6178 deletions
+31 -28
View File
@@ -4,24 +4,25 @@ The following sections list the changes for 0.1.1.
## Summary
- Fix #22: Build docker images with alpine:latest instead of alpine:edge
- Chg #20: Change status not found on missing thumbnail
* Fix #22: Build docker images with alpine:latest instead of alpine:edge
* Chg #20: Change status not found on missing thumbnail
## Details
- Bugfix #22: Build docker images with alpine:latest instead of alpine:edge
* Bugfix #22: 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.
ARM builds were failing when built on alpine:edge, so we switched to alpine:latest instead.
<https://github.com/owncloud/ocis/webdav/pull/22>
https://github.com/owncloud/ocis/webdav/pull/22
- Change #20: Change status not found on missing thumbnail
* Change #20: Change status not found on missing thumbnail
The service returned a bad request when no thumbnail was generated. It is now changed to not
found.
The service returned a bad request when no thumbnail was generated. It is now changed to not
found.
https://github.com/owncloud/ocis/webdav/issues/20
https://github.com/owncloud/ocis/webdav/pull/21
<https://github.com/owncloud/ocis/webdav/issues/20>
<https://github.com/owncloud/ocis/webdav/pull/21>
# Changelog for 0.1.0
@@ -29,35 +30,37 @@ The following sections list the changes for 0.1.0.
## Summary
- Chg #1: Initial release of basic version
- Chg #16: Update ocis-pkg to version 2.2.0
- Enh #14: Configuration
- Enh #13: Implement preview API
* Chg #1: Initial release of basic version
* Chg #16: Update ocis-pkg to version 2.2.0
* Enh #14: Configuration
* Enh #13: Implement preview API
## Details
- Change #1: Initial release of basic version
* Change #1: Initial release of basic version
Just prepared an initial basic version to serve webdav for the ownCloud Infinite Scale
project. It just provides a minimal viable product to demonstrate the microservice pattern.
Just prepared an initial basic version to serve webdav for the ownCloud Infinite Scale
project. It just provides a minimal viable product to demonstrate the microservice pattern.
<https://github.com/owncloud/ocis/webdav/issues/1>
https://github.com/owncloud/ocis/webdav/issues/1
- Change #16: Update ocis-pkg to version 2.2.0
* Change #16: Update ocis-pkg to version 2.2.0
Updated ocis-pkg to include the cors header changes.
Updated ocis-pkg to include the cors header changes.
<https://github.com/owncloud/ocis/webdav/issues/16>
https://github.com/owncloud/ocis/webdav/issues/16
- Enhancement #14: Configuration
* Enhancement #14: Configuration
Extensions should be responsible of configuring themselves. We use Viper for config loading
from default paths. Environment variables **WILL** take precedence over config files.
Extensions should be responsible of configuring themselves. We use Viper for config loading
from default paths. Environment variables **WILL** take precedence over config files.
<https://github.com/owncloud/ocis/webdav/pull/14>
https://github.com/owncloud/ocis/webdav/pull/14
- Enhancement #13: Implement preview API
* Enhancement #13: Implement preview API
Added the API endpoint for file previews.
https://github.com/owncloud/ocis/webdav/pull/13
Added the API endpoint for file previews.
<https://github.com/owncloud/ocis/webdav/pull/13>
+2 -2
View File
@@ -2,7 +2,7 @@
[![Build Status](https://cloud.drone.io/api/badges/owncloud/ocis-webdav/status.svg)](https://cloud.drone.io/owncloud/ocis-webdav)
[![Gitter chat](https://badges.gitter.im/cs3org/reva.svg)](https://gitter.im/cs3org/reva)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/0913fcc866a344b587bb867fcec5b848)](https://www.codacy.com/app/owncloud/ocis-webdav?utm_source=github.com&utm_medium=referral&utm_content=owncloud/ocis-webdav&utm_campaign=Badge_Grade)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/0913fcc866a344b587bb867fcec5b848)](https://www.codacy.com/app/owncloud/ocis-webdav?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=owncloud/ocis-webdav&amp;utm_campaign=Badge_Grade)
[![Go Doc](https://godoc.org/github.com/owncloud/ocis-webdav?status.svg)](http://godoc.org/github.com/owncloud/ocis-webdav)
[![Go Report](http://goreportcard.com/badge/github.com/owncloud/ocis-webdav)](http://goreportcard.com/report/github.com/owncloud/ocis-webdav)
[![](https://images.microbadger.com/badges/image/owncloud/ocis-webdav.svg)](http://microbadger.com/images/owncloud/ocis-webdav "Get your own image badge on microbadger.com")
@@ -28,7 +28,7 @@ make generate build
## Security
If you find a security issue please contact [security@owncloud.com](mailto:security@owncloud.com) first.
If you find a security issue please contact security@owncloud.com first.
## Contributing
@@ -2,4 +2,4 @@ Enhancement: Configuration
Extensions should be responsible of configuring themselves. We use Viper for config loading from default paths. Environment variables **WILL** take precedence over config files.
<https://github.com/owncloud/ocis/webdav/pull/14>
https://github.com/owncloud/ocis/webdav/pull/14
@@ -4,4 +4,4 @@ Just prepared an initial basic version to serve webdav for the ownCloud
Infinite Scale project. It just provides a minimal viable product to
demonstrate the microservice pattern.
<https://github.com/owncloud/ocis/webdav/issues/1>
https://github.com/owncloud/ocis/webdav/issues/1
@@ -2,4 +2,4 @@ Enhancement: implement preview API
Added the API endpoint for file previews.
<https://github.com/owncloud/ocis/webdav/pull/13>
https://github.com/owncloud/ocis/webdav/pull/13
@@ -2,4 +2,4 @@ Change: update ocis-pkg to version 2.2.0
Updated ocis-pkg to include the cors header changes.
<https://github.com/owncloud/ocis/webdav/issues/16>
https://github.com/owncloud/ocis/webdav/issues/16
@@ -3,5 +3,5 @@ Change: change status not found on missing thumbnail
The service returned a bad request when no thumbnail was generated.
It is now changed to not found.
<https://github.com/owncloud/ocis/webdav/issues/20>
<https://github.com/owncloud/ocis/webdav/pull/21>
https://github.com/owncloud/ocis/webdav/issues/20
https://github.com/owncloud/ocis/webdav/pull/21
@@ -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/webdav/pull/22>
https://github.com/owncloud/ocis/webdav/pull/22
+3 -4
View File
@@ -1,7 +1,6 @@
* * *
---
title: "{{ replace .TranslationBaseName "-" " " | title }}"
date: {{ .Date }}
anchor: "{{ replace .TranslationBaseName "-" " " | title | urlize }}"
## weight:
weight:
---
+3 -4
View File
@@ -1,9 +1,8 @@
* * *
---
title: "About"
date: 2018-05-02T00:00:00+00:00
anchor: "about"
## weight: 10
weight: 10
---
This service provides the WebDAV API which is required by some ownCloud clients.
+8 -9
View File
@@ -1,25 +1,24 @@
* * *
---
title: "Building"
date: 2018-05-02T00:00:00+00:00
anchor: "building"
## weight: 30
weight: 30
---
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-webdav.git>
{{< highlight txt >}}
git clone https://github.com/owncloud/ocis-webdav.git
cd ocis-webdav
{{&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 >}}
Finally you should have the binary within the `bin/` folder now, give it a try with `./bin/ocis-webdav -h` to see all available options.
+24 -25
View File
@@ -1,10 +1,9 @@
* * *
---
title: "Getting Started"
date: 2018-05-02T00:00:00+00:00
anchor: "getting-started"
## weight: 20
weight: 20
---
### Installation
@@ -86,59 +85,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 `webdav`
\--debug-addr
--debug-addr
: Address to bind debug server, defaults to `0.0.0.0:9119`
\--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:9115`
\--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, defaults to `0.0.0.0:9119`
#### Configuration file
@@ -153,17 +152,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-webdav 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-webdav health --help
{{&lt; / highlight >}}
{{< / highlight >}}
### Metrics
+3 -4
View File
@@ -1,9 +1,8 @@
* * *
---
title: "License"
date: 2018-05-02T00:00:00+00:00
anchor: "license"
## weight: 40
weight: 40
---
This project is licensed under the [Apache 2.0](https://github.com/owncloud/ocis/webdav/blob/master/LICENSE) license. For the license of the used libraries you have to check the respective sources.