Updated over index. Added achitecture and release notes added

doc/architecture.md

+<img src="../images/logos/OpenCAPIF.png" alt="drawing" width="200"/>
+
+# Architecture
+
+

doc/index.md

 <img src="images/logos/OpenCAPIF.png" alt="drawing" width="200"/>
 
-# Release X.X.X-rc
 
-This release includes next changes:
-
-**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:**
-
-  - New Register flows.
-  - Allow different URLs for register, ccf and vault services.
-
-**Improved security on DB:**
-
-  - Credentials requested to access mongo databases.
-  - Credentials requested also by mongo-express.
-
-**Scripts upgraded:**
-
-  - docker compose version 2 used on them.
-  - New cleaning script developed.
-
-**Cleanup of capif repository:**
-
-  - Documentation is now on splitted repository [OCF Documentation Repository]
-  - Test plan was moved to [OCF Documentation Repository]
-  - Obsolote data is removed.
-
-
-# Release 0.0
-
-The APIs included in Release 0.0 are:
-
-- JWT Authentication APIs
-- CAPIF Invoker Management API
-- CAPIF Publish API
-- CAPIF Discover API
-- CAPIF Security API
-- CAPIF Events API
-- CAPIF Provider Management API
-
-This Release also includes a Robot Test Suite for all those services and a Postman Test Suite for simple testing.
-
-## What is OpenCAPIF?
+# What is OpenCAPIF?
 
 OpenCAPIF is an open source implementation of the CAPIF Core Function APIs plus the logic and additional services required to fulfill the 3GPP requirements and deliver the expected functionality.
 
@@ -81,7 +37,7 @@ The following diagram shows how API Invokers and API Providers interact with the
 If you want to know more about OpenCAPIF check [The story behind openCAPIF](https://ocf.etsi.org/news/20240110_the_story_behind_opencapif/)
 
 
-## Repository structure
+# Repository structure
 
 You can check the code at [OpenCAPIF Repository]
 
@@ -101,21 +57,21 @@ CAPIF_API_Services
 * **tools**: Auxiliary tools. Robot Framework related code and OpenAPI scripts.
 * **test**: Tests developed using Robot Framework.
 
-## CAPIF_API_Services
+# CAPIF_API_Services
 
 This repository has the python-flask Mockup servers created with openapi-generator related with CAPIF APIS defined here:
 [Open API Descriptions of 3GPP 5G APIs]
 
 
-## How to test CAPIF APIs
+# How to test CAPIF APIs
 
 The above APIs can be tested either with POSTMAN tool or running the developed tests with Robot Framework.
 
-## Test Plan Documentation
+# Test Plan Documentation
 
 Complete documentation of tests is available here: [Test Plan Directory]
 
-## Robot Framework
+# Robot Framework
 
 In order to ensure that modifications over CAPIF services still fulfills the required functionality, the Robot Framework Test Suite must be successfully run.
 
@@ -123,15 +79,15 @@ The Robot Test Suite covers the requirements described in the test plan at [Test
 
 Please check the [Testing with Robot Framework] Section
 
-## Using PostMan
+# Using PostMan
 
 You can also test the CAPIF flow using the Postman tool. To do this, we have created a collection with some examples of CAPIF requests with everything necessary to carry them out.
 
 For more information on how to test the APIs with POSTMAN, go to this [POSTMAN Section].
 
-## Important urls:
+# Important urls:
 
-## Mongo CAPIF's DB Dashboard
+# Mongo CAPIF's DB Dashboard
 ```
 http://localhost:8082/ (if accessed from localhost) 
 
@@ -140,7 +96,7 @@ or
 http://<Mongo CAPIF Express Host IP>:8082/ (if accessed from another host)
 ```
 
-## Mongo Register's DB Dashboard
+# Mongo Register's DB Dashboard
 ```
 http://localhost:8083/ (if accessed from localhost) 
 
@@ -149,15 +105,12 @@ or
 http://<Mongo Register Express Host IP>:8083/ (if accessed from another host)
 ```
 
-## FAQ Documentation
+# FAQ Documentation
 
 Frequently asked questions can be found here: [FAQ Section]
 
 
 
-
-
-
 [Test Plan Directory]: ./testing/testplan/README.md  "Test Plan Directory"
 [Testing with Robot Framework]: ./testing/robotframework/README.md  "Testing with Robot Framework"
 [FAQ Section]: ./FAQ.md "FAQ Section"

doc/releasenotes.md

+# Release X.X.X-rc
+
+This release includes next changes:
+
+**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:**
+
+  - New Register flows.
+  - Allow different URLs for register, ccf and vault services.
+
+**Improved security on DB:**
+
+  - Credentials requested to access mongo databases.
+  - Credentials requested also by mongo-express.
+
+**Scripts upgraded:**
+
+  - docker compose version 2 used on them.
+  - New cleaning script developed.
+
+**Cleanup of capif repository:**
+
+  - Documentation is now on splitted repository [OCF Documentation Repository]
+  - Test plan was moved to [OCF Documentation Repository]
+  - Obsolote data is removed.
+
+
+# Release 0.0
+
+The APIs included in Release 0.0 are:
+
+- JWT Authentication APIs
+- CAPIF Invoker Management API
+- CAPIF Publish API
+- CAPIF Discover API
+- CAPIF Security API
+- CAPIF Events API
+- CAPIF Provider Management API
+
+This Release also includes a Robot Test Suite for all those services and a Postman Test Suite for simple testing.
+

doc/testing/robotframework/README.md

@@ -15,7 +15,7 @@ To run any test locally you will need *docker* and *docker-compose* installed in
 ## Script Test Execution
 This script will build robot docker image if it's need and execute tests selected by "include" option. Just go to service folder, execute and follow steps.
 ```
-./runCapifTests.sh --include <TAG>
+./run_capif_tests.sh --include <TAG>
 ```
 Results will be stored at <REPOSITORY_FOLDER>/results
 
@@ -24,9 +24,15 @@ Please check parameters (include) under *Test Execution* at [Manual Build And Te
 ### Mock Server
 Some tests on Test Plans require mockserver. That mock server must be deployed and reachable by Robot Framework and CCF under test.
 
+To run Mock Server locally you can just execute the next script:
+```
+cd services
+./run_mock_server.sh
+```
+
 If you want to launch only tests that not needed mockserver, just add "--exclude mockserver" parameter to robot execution:
 ```
-./runCapifTests.sh --include <TAG> --exclude mockserver
+./run_capif_tests.sh --include <TAG> --exclude mockserver
 ```
 
 ## Manual Build And Test Execution

mkdocs.yml

@@ -74,6 +74,8 @@ extra:
 nav:
   - Overview:
       - Introduction: index.md
+      - Release Notes: releasenotes.md
+      - Architecture: architecture.md
   - Getting Started:
       - How to Run: ./gettingstarted/howtorun.md
   - Testing: