mirror/opencloud
1
0
Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-01-06 12:19:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Apply suggestions from code review

Browse Source 
Co-authored-by: kobergj <jkoberg@owncloud.com>
This commit is contained in:
Martin
2023-03-23 15:20:30 +01:00
committed by GitHub
parent 8dc37cb22a
commit 1f5b79b252
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/services/new-service-checklist.md
View File

@@ -15,7 +15,7 @@ When a new service gets introduced, this checklist is a good startingpoint for t
Use this checklist with copy/paste in your PR - right from the beginning. It renders correctly in your PR.
```markdown
- [ ] Provide a readme.md for that service in the root folder of that service.
- [ ] Provide a README.md for that service in the root folder of that service.
- Use CamelCase for section headers.
- [ ] For images, you currenly have to create a folder named `images` on the same lavel where readme.md is located and put all the images used in readme.md. For the time being, the imagefolder needs to be manually copied to `docs/servcies/<service name>`. This is also true for image changes post merging.
- [ ] If new CLI command are introduced, that command must be described in readme.md.
@@ -30,7 +30,7 @@ Use this checklist with copy/paste in your PR - right from the beginning. It ren
- base description, set of available values, description of each value.
- [ ] When suggestable commits are created for text changes and you agree, collect them to a batch and commit them. Do not forget to rebase locally to avoid overwriting the changes made.
- [ ] If new envvars are introduced which serve the same purpose but in multiple services, an additional envvar must be added at the beginning of the list starting with `OCIS_` (global envvar).
- [ ] Ensure that a service has a debug port - if required.
- [ ] Ensure that a service has a debug port
- [ ] If the new service introduces a new port:
- the port must be added to [port-ranges.md](https://github.com/owncloud/ocis/blob/master/docs/services/port-ranges.md) and to the readme.md file.
- [ ] Make sure to have a function `FullDefaultConfig()` in `pkg/config/defaults/defaultconfig.go` of your service. It is needed to create the documentation.