[docs-only] Fix texts and typos in README.md files

This commit is contained in:
mmattel
2023-04-23 10:02:27 +02:00
parent 169a3abe07
commit 84d2d8dae9
14 changed files with 39 additions and 67 deletions
+2 -1
View File
@@ -16,11 +16,12 @@
## Introduction
`docs/helpers` contains small go programs creating docs by extracting information from the code. The `main.go` program is manually started with `make docs-generate` or via the CI. It calls the other required programs and has three main responsibilities:
`docs/helpers` contains small go programs creating docs by extracting information from the code. The `main.go` program is manually started with `make docs-generate` or via the CI. It calls the other required programs and has these main responsibilities:
- Generate docs for envvars in config structs including deprecations if there are any.
- Extract and generate docs for `extended` envvars that are not mentioned in config structs (aka "rogue" envvars).
- Extract and generate docs for `global` envvars which occur in multiple services.
- Create `docs/service/<service-name>/_index.md` from `service/<service-name>/README.md` files while keeping the existing `_index.md` if the README.md has not been created so far.
## Output Generated
-37
View File
@@ -1,37 +0,0 @@
---
title: Frontend
date: 2022-03-02T00:00:00+00:00
weight: 20
geekdocRepo: https://github.com/owncloud/ocis
geekdocEditPath: edit/master/docs/services/frontend
geekdocFilePath: _index.md
geekdocCollapseSection: true
---
## Abstract
The frontend service provides multiple HTTP endpoints to translate OCS, archiver and approvider requests into CS3 requests.
## Table of Contents
{{< toc-tree >}}
## OCS
The OCS endpoint implements the open collaboration services API in a backwards compatible manner.
### Sharing
Aggregating share information is one of the most time consuming operations in OCIS. The service fetches a list of either received or created shares and has to stat every resource individually. While stats are fast, the default behavior scales linearly with the number of shares.
To save network trips the sharing implementation can cache the stat requests with an in memory cache or in redis. It will shorten the response time by the network round-trip overhead at the cost of the API only eventually being updated.
Setting `FRONTEND_OCS_RESOURCE_INFO_CACHE_TTL=60` would cache the stat info for 60 seconds. Increasing this value makes sense for large deployments with thousands of active users that keep the cache up to date. Low frequency usage scenarios should not expect a noticeable improvement.
## Archiver
The archiver endpoint provides bundled downloads of multiple files and folders.
## Appprovider
The appprovider endpoint is used to manage available apps that can be used to open different file types.