From 1d4e40c30b9327f4cc5ee52eec5971259a7fd262 Mon Sep 17 00:00:00 2001 From: Jorge Moratinos Salcines Date: Mon, 22 Apr 2024 17:23:13 +0200 Subject: [PATCH 1/2] Fixing error on markdown --- README.md | 8 ++++++-- doc/index.md | 22 ++++++++++++++++------ 2 files changed, 22 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index cf33d8b..5a12324 100644 --- a/README.md +++ b/README.md @@ -50,11 +50,15 @@ The easy way to check if documentation will be generated properly is check local ``` pip install -q mkdocs-material mike ``` -3. Run mike development server: +3. Set default tag: +``` +mike set-default --allow-undefined version1 +``` +4. Run mike development server: ``` mike deploy version1; mike serve ``` -4. Use any web browser to reach http://localhost:8000/version1/ +1. Use any web browser to reach http://localhost:8000/version1/ > **To see changes on documentation you will need to restart mike server** diff --git a/doc/index.md b/doc/index.md index 807b265..10d23ee 100644 --- a/doc/index.md +++ b/doc/index.md @@ -3,22 +3,32 @@ # Release X.X.X-rc This release includes next changes: -- New register flow to ensure: + +**New register flow to ensure:** + - isolation between CCF and Register services. - Improve security, with split resposability between administrator operations and common user. -- Improved Testing with Robot in order to cover: + +**Improved Testing with Robot in order to cover:** + - New Register flows. - Allow different URLs for register, ccf and vault services. -- Improved security on DB: + +**Improved security on DB:** + - Credentials requested to access mongo databases. - Credentials requested also by mongo-express. -- Scripts upgraded: + +**Scripts upgraded:** + - docker compose version 2 used on them. - New cleaning script developed. -- Cleanup of capif repository: + +**Cleanup of capif repository:** + - Documentation is now on splitted repository [OCF Documentation Repository] - Test plan was moved to [OCF Documentation Repository] - - Some obsolote data is removed. + - Obsolote data is removed. # Release 0.0 -- GitLab From 3dcaaa63a5303897751f5e7f1af04bc9e805ed7e Mon Sep 17 00:00:00 2001 From: Jorge Moratinos Salcines Date: Mon, 22 Apr 2024 17:24:35 +0200 Subject: [PATCH 2/2] Fixing error on markdown --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5a12324..573def1 100644 --- a/README.md +++ b/README.md @@ -58,7 +58,7 @@ mike set-default --allow-undefined version1 ``` mike deploy version1; mike serve ``` -1. Use any web browser to reach http://localhost:8000/version1/ +5. Use any web browser to reach http://localhost:8000/version1/ > **To see changes on documentation you will need to restart mike server** -- GitLab