Merge pull request #10 from owncloud/central-docs

Docs Edit links, Changelog template, Makefile

.drone.star

@@ -484,16 +484,16 @@ def changelog(ctx):
         ],
       },
       {
-				'name': 'diff',
-				'image': 'owncloud/alpine:latest',
-				'pull': 'always',
-				'commands': [
-					'git diff',
-				],
-			},
+        'name': 'diff',
+        'image': 'owncloud/alpine:latest',
+        'pull': 'always',
+        'commands': [
+          'git diff',
+        ],
+      },
       {
         'name': 'output',
-        'image': 'webhippie/golang:1.13',
+        'image': 'owncloud/alpine:latest',
         'pull': 'always',
         'commands': [
           'cat CHANGELOG.md',

Makefile

@@ -58,7 +58,7 @@ sync:
 .PHONY: clean
 clean:
 	go clean -i ./...
-	rm -rf $(BIN) $(DIST)
+	rm -rf $(BIN) $(DIST) $(HUGO)
 
 .PHONY: fmt
 fmt:

changelog/CHANGELOG.tmpl

@@ -1,10 +1,10 @@
 {{ $allVersions := . }}
 {{- range $index, $changes := . }}{{ with $changes -}}
+{{ if gt (len $allVersions) 1 -}}
 # Changelog for [{{ .Version }}] ({{ .Date }})
 
-The following sections list the changes for {{ .Version }}.
+The following sections list the changes for ocis-proxy {{ .Version }}.
 
-{{ if gt (len $allVersions) 1 -}}
 {{/* creating version compare links */ -}}
 {{ $next := add1 $index -}}
 {{ if ne (len $allVersions) $next -}}
@@ -23,16 +23,19 @@ The following sections list the changes for {{ .Version }}.
 [{{ .Version }}]: https://github.com/owncloud/ocis-proxy/compare/500e303cb544ed93d84153f01219d77eeee44929...v{{ .Version }}
 
 {{ end -}}
-{{- end -}}
+{{ else -}}
+# Changes in {{ .Version }}
+
+{{ end -}}
 
 ## Summary
 {{ range $entry := .Entries }}{{ with $entry }}
- * {{ .TypeShort }} #{{ .PrimaryID }}: {{ .Title }}
+* {{ .Type }} - {{ .Title }}: [#{{ .PrimaryID }}]({{ .PrimaryURL }})
 {{- end }}{{ end }}
 
 ## Details
 {{ range $entry := .Entries }}{{ with $entry }}
- * {{ .Type }} #{{ .PrimaryID }}: {{ .Title }}
+* {{ .Type }} - {{ .Title }}: [#{{ .PrimaryID }}]({{ .PrimaryURL }})
 {{ range $par := .Paragraphs }}
    {{ wrapIndent $par 80 3 }}
 {{ end -}}

docs/_index.md

@@ -1,6 +1,8 @@
 ---
 title: Proxy
-anchor: "ocis-proxy"
+geekdocRepo: https://github.com/owncloud/ocis-proxy
+geekdocEditPath: edit/master/docs
+geekdocFilePath: _index.md
 ---
 
 This service provides a basic proxy in front of the public ocis services.

docs/about.md

@@ -1,8 +1,10 @@
 ---
 title: "About"
 date: 2020-02-07T00:00:00+00:00
-anchor: "about"
 weight: 10
+geekdocRepo: https://github.com/owncloud/ocis-proxy
+geekdocEditPath: edit/master/docs
+geekdocFilePath: about.md
 ---
 
 This service provides an proxy service that routes requests to the correct services.

docs/building.md

@@ -1,10 +1,14 @@
 ---
 title: "Building"
 date: 2018-05-02T00:00:00+00:00
-anchor: "building"
 weight: 30
+geekdocRepo: https://github.com/owncloud/ocis-proxy
+geekdocEditPath: edit/master/docs
+geekdocFilePath: building.md
 ---
 
+{{< 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.13. After the installation of the required tools you need to get the sources:
 
 {{< highlight txt >}}
@@ -14,7 +18,7 @@ cd ocis-proxy
 
 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
+## Backend
 
 {{< highlight txt >}}
 make generate

docs/getting-started.md

@@ -1,31 +1,35 @@
 ---
 title: "Getting Started"
 date: 2018-05-02T00:00:00+00:00
-anchor: "getting-started"
 weight: 20
+geekdocRepo: https://github.com/owncloud/ocis-proxy
+geekdocEditPath: edit/master/docs
+geekdocFilePath: getting-started.md
 ---
 
-### Installation
+{{< toc >}}
+
+## Installation
 
 So far we are offering two different variants for the installation. You can choose between [Docker](https://www.docker.com/) or pre-built binaries which are stored on our download mirrors and GitHub releases. Maybe we will also provide system packages for the major distributions later if we see the need for it.
 
-#### Docker
+### Docker
 
 TBD
 
-#### Binaries
+### Binaries
 
 TBD
 
-### Configuration
+## Configuration
 
 We provide overall three different variants of configuration. The variant based on environment variables and commandline flags are split up into global values and command-specific values.
 
-#### Envrionment variables
+### Envrionment variables
 
 If you prefer to configure the service with environment variables you can see the available variables below.
 
-##### Server
+#### Server
 
 OCIS_PROXY_NAME
 : Name of the proxy service. It will be part of the namespace.
@@ -36,19 +40,19 @@ OCIS_PROXY_NAMESPACE
 OCIS_PROXY_ADDRESS
 : Endpoint for the http service endpoint.
 
-#### Commandline flags
+### Commandline flags
 
 If you prefer to configure the service with commandline flags you can see the available variables below.
 
-#### Configuration file
+### Configuration file
 
 So far we support the file formats `JSON` and `YAML`, if you want to get a full example configuration just take a look at [our repository](https://github.com/owncloud/ocis-proxy/tree/master/pkg/config), there you can always see the latest configuration format. These example configurations include all available options and the default values. The configuration file will be automatically loaded if it's placed at `/etc/ocis/proxy.yml`, `${HOME}/.ocis/proxy.yml` or `$(pwd)/config/proxy.yml`.
 
-### Usage
+## Usage
 
 The program provides a few sub-commands on execution. The available configuration methods have already been mentioned above. Generally you can always see a formated help output if you execute the binary via `ocis-proxy --help`.
 
-#### Server
+### Server
 
 The server command is used to start the http server. For further help please execute: