fix docs formatting and push to docs branch

This commit is contained in:
Robert Kaussow
2020-02-12 12:55:47 +01:00
parent 1c2c1616b7
commit 94f19c3a7c
5 changed files with 39 additions and 20 deletions
+22
View File
@@ -643,6 +643,28 @@ def website(ctx):
'tree hugo/public',
],
},
{
'name': 'publish',
'image': 'plugins/gh-pages:1',
'pull': 'always',
'settings': {
'username': {
'from_secret': 'github_username',
},
'password': {
'from_secret': 'github_token',
},
'pages_directory': 'docs/',
'target_branch': 'docs',
},
'when': {
'ref': {
'exclude': [
'refs/pull/**',
],
},
},
},
{
'name': 'downstream',
'image': 'plugins/downstream',
+1 -1
View File
@@ -140,7 +140,7 @@ docs-copy:
git remote add origin https://github.com/owncloud/owncloud.github.io; \
git fetch; \
git checkout origin/source -f; \
rsync -aX ../docs/ content/extensions/ocis-accounts
rsync --delete -aX ../docs/ content/extensions/ocis-accounts
.PHONY: docs-build
docs-build:
+1 -4
View File
@@ -1,8 +1,5 @@
---
title: "About"
date: 2020-02-07T00:00:00+00:00
anchor: "about"
weight: 10
title: ocis-accounts
---
This service provides an inter-operable accounts service that operates on the filesystem by default.
+2 -3
View File
@@ -1,8 +1,7 @@
---
title: "Building"
date: 2018-05-02T00:00:00+00:00
anchor: "building"
weight: 30
weight: 20
---
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:
@@ -14,7 +13,7 @@ cd ocis-accounts
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
+13 -12
View File
@@ -1,31 +1,32 @@
---
title: "Getting Started"
date: 2018-05-02T00:00:00+00:00
anchor: "getting-started"
weight: 20
weight: 10
---
### 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_ACCOUNTS_MANAGER
: Enable sending traces, defaults to `filesystem`
@@ -42,19 +43,19 @@ OCIS_ACCOUNTS_NAMESPACE
OCIS_ACCOUNTS_ADDRESS
: Endpoint for the grpc 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-accounts/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/accounts.yml`, `${HOME}/.ocis/accounts.yml` or `$(pwd)/config/accounts.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-accounts --help`.
#### Server
### Server
The server command is used to start the grpc server. For further help please execute: