Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[docs-only] Update new-service-checklist.md #6021

Merged
merged 1 commit into from
Apr 6, 2023
Merged

[docs-only] Update new-service-checklist.md #6021

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion docs/services/new-service-checklist.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ Use this checklist with copy/paste in your PR - right from the beginning. It ren
- Use CamelCase for section headers.
- [ ] For images and example files used in README.md:
- Create a folder named `md-sources` on the same level where README.md is located. Put all the images and example files referenced by README.md into this folder.
- Use absolute references like `https://github.com/owncloud/ocis/blob/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" />`
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.
- [ ] Add the service to the makefile in the ocis repo root.
- [ ] Make the service startable for binary and individual startup:
Expand Down