[docs-only] Create a General Info page plus content in services for owncloud.dev

This commit is contained in:
mmattel
2023-04-12 16:58:08 +02:00
parent 754cc767a5
commit c054f16c28
4 changed files with 62 additions and 4 deletions

View File

@@ -0,0 +1,18 @@
---
title: Rclone
date: 2021-11-17T00:00:00+00:00
weight: 0
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/general-info
geekdocFilePath: _index.md
geekdocCollapseSection: true
---
## General Information
This section provides general information valid for all services.
## Table of Contents
{{< toc-tree >}}

View File

@@ -0,0 +1,39 @@
---
title: Environment Variable Naming Scope
date: 2023-03-23T00:00:00+00:00
weight: 10
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/general-info
geekdocFilePath: envvar-scopes.md
geekdocCollapseSection: true
---
The scope of an environment variable can be derived from its name. Therefore it is important to follow the correct naming scheme to enable easy and proper identification. This is important when either:
- a new local envvar is introduced.
- a new global envvar is added to an existing local envvar.
## Envvar Definition
- A variable that is only used in a particular service is a **local envvar**.
- A variable that is used in more than one service is a **global envvar**.
- Mandatory when used in a service, a global envvar must have a local counterpart.
- Variables that do not belong to any service are by definition global.
## Name Scope
### Local Envvars
A local envvar always starts with the the service name like `POSTPROCESSING_LOG_FILE`.
### Global Envvars
A global envvar always starts with `OCIS_` like `OCIS_LOG_FILE`.
Note that this envvar is the global version of the local example above.
To get a list of global envvars used in all services, see the [Global Environment Variables](https://doc.owncloud.com/ocis/next/deployment/services/env-vars-special-scope.html#global-environment-variables) table in the ocis admin documentation.
## Deprecations
All environment variable types that are used in a service follow the same deprecation rules independent of their scope.

View File

@@ -1,9 +1,9 @@
---
title: New Service Checklist
date: 2023-03-23T00:00:00+00:00
weight: 0
weight: 10
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services
geekdocEditPath: edit/master/docs/services/general-info
geekdocFilePath: new-service-checklist.md
geekdocCollapseSection: true
---
@@ -23,6 +23,7 @@ Use this checklist with copy/paste in your PR - right from the beginning. It ren
bad `<img src="https://github.com/owncloud/ocis/blob/master/services/graph/images/mermaid-graph.svg" width="500" />`
good `<img src="https://raw.githubusercontent.com/owncloud/ocis/master/services/graph/images/mermaid-graph.svg" width="500" />`
- [ ] If new CLI command are introduced, that command must be described in readme.md.
- [ ] If new global envvar is introduced, the name must start with `OCIS_`.
- [ ] Add the service to the makefile in the ocis repo root.
- [ ] Make the service startable for binary and individual startup:
- For single binary add service to `ocis/pkg/runtime`

View File

@@ -1,9 +1,9 @@
---
title: Port Ranges
date: 2018-05-02T00:00:00+00:00
weight: 0
weight: 10
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services
geekdocEditPath: edit/master/docs/services/general-info
geekdocFilePath: port-ranges.md
geekdocCollapseSection: true
---