From 9d54c882fbcf8931e1d4c9709784066baebc0e60 Mon Sep 17 00:00:00 2001 From: Martin Date: Fri, 24 Mar 2023 10:14:58 +0100 Subject: [PATCH 1/2] Update new-service-checklist.md Improve the handling of additional ressources used by README.md --- docs/services/new-service-checklist.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/services/new-service-checklist.md b/docs/services/new-service-checklist.md index b93fd7be3..20c1c6cf1 100644 --- a/docs/services/new-service-checklist.md +++ b/docs/services/new-service-checklist.md @@ -17,7 +17,9 @@ Use this checklist with copy/paste in your PR - right from the beginning. It ren ```markdown - [ ] 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/`. This is also true for image changes post merging. +- [ ] 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 (full URL) to make the content accessible for both README.md and owncloud.dev - [ ] 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: From dfb96e27de10af91d6abcd3e460d92c7db2e0876 Mon Sep 17 00:00:00 2001 From: Martin Date: Fri, 24 Mar 2023 11:01:35 +0100 Subject: [PATCH 2/2] Update docs/services/new-service-checklist.md --- docs/services/new-service-checklist.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/services/new-service-checklist.md b/docs/services/new-service-checklist.md index 20c1c6cf1..7b40c1221 100644 --- a/docs/services/new-service-checklist.md +++ b/docs/services/new-service-checklist.md @@ -19,7 +19,7 @@ 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 (full URL) to make the content accessible for both README.md and owncloud.dev + - Use absolute references like `https://github.com/owncloud/ocis/blob/master/services//md-sources/file` to make the content accessible for both README.md and owncloud.dev - [ ] 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: