diff --git a/README.md b/README.md index cf33d8be384ceb18ddb56b046e18be8123a3ca27..573def1cc63154cbcfb764b1013dc73ed4cf6543 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/ +5. 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 807b265d7ad0418cdadfbc046f6724a81e11875c..10d23eefdf17602dc64e7a329925172b647a3be9 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