mirror/opencloud
1
0 Fork 0
mirror of https://github.com/opencloud-eu/opencloud.git synced 2026-08-07 05:14:57 -04:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #8869 from owncloud/mmattel-patch-1

Browse Source 
[docs-only] Update new-service-checklist in dev docs
This commit is contained in:
Martin authored and GitHub committed 2024-04-16 12:33:31 +02:00
2 parents 6654dff76e b0aff85cd4
commit 316bdd44ef
1 file changed
+5 -3
Download Patch File Download Diff File Expand all files Collapse all files
docs/services/general-info/new-service-checklist.md
+5 -3
View File
@@ -22,8 +22,8 @@ Use this checklist with copy/paste in your PR - right from the beginning. It ren
- Use absolute references like `https://raw.githubusercontent.com/owncloud/ocis/master/services/<service-name>/md-sources/file` to make the content accessible for both README.md and owncloud.dev - Use absolute references like `https://raw.githubusercontent.com/owncloud/ocis/master/services/<service-name>/md-sources/file` to make the content accessible for both README.md and owncloud.dev
bad `<img src="https://github.com/owncloud/ocis/blob/master/services/graph/images/mermaid-graph.svg" width="500" />` 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" />` 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 CLI command are introduced, that command must be described in the README.md.
- [ ] If new global envvar is introduced, the name must start with `OCIS_`. - [ ] If new global envvars are introduced, the name must start with `OCIS_`.
- [ ] Add the service to the makefile in the ocis repo root. - [ ] Add the service to the makefile in the ocis repo root.
- [ ] Make the service startable for binary and individual startup: - [ ] Make the service startable for binary and individual startup:
- For single binary add service to `ocis/pkg/runtime` - For single binary add service to `ocis/pkg/runtime`
@@ -39,6 +39,8 @@ Use this checklist with copy/paste in your PR - right from the beginning. It ren
- [ ] 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). - [ ] 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 - [ ] Ensure that a service has a debug port
- [ ] If the new service introduces a new 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/general-info/port-ranges.md) and to the readme.md file. - The port must be added to [port-ranges.md](https://github.com/owncloud/ocis/blob/master/docs/services/general-info/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. - [ ] Make sure to have a function `FullDefaultConfig()` in `pkg/config/defaults/defaultconfig.go` of your service. It is needed to create the documentation.
- [ ] Add metrics to the code to enable monitoring. See the proxy service for implementation details.
- Plus add a monitoring documentation in the README.md file
``` ```