diff --git a/doc/contributing/developing.md b/doc/contributing/developing.md index 72a79fcf528c7a8e68c02726916da9f8f51e420f..e8939eeca651aadf2bedef512ed8009df305b4aa 100644 --- a/doc/contributing/developing.md +++ b/doc/contributing/developing.md @@ -30,14 +30,14 @@ sudo docker compose --profile dev down;sudo docker compose --profile dev up -d - ## General requirements - Docker should be installed in your development environment -- Run the core subsystems (see above sections) +- Run the core subsystems (see above section) ## Slack -Feel free to join OpenSlice [Slack](https://openslice.slack.com) for any development oriented questions +Feel free to join OpenSlice [Slack](https://openslice.slack.com) for any development oriented questions. -## Examples on developing on specific subsystems +## Examples of developing on specific subsystems ### VNF/NSD Catalog Management and NSD Deployment API service diff --git a/doc/deployment.md b/doc/deployment.md index 3f88e32c5b4415031078de0372c72462e752bf78..48aa4950f66ab2832035d882083496724d291e2e 100644 --- a/doc/deployment.md +++ b/doc/deployment.md @@ -17,7 +17,7 @@ ## Preparing the environment -> See the [Kubernetes section](##Kubernetes-installation), if you would like to deploy OpenSlice in a Kubernetes cluster. +> See the [Kubernetes section](#Kubernetes-installation), if you would like to deploy OpenSlice in a Kubernetes cluster. ### 1. Backup your previous database if necessary: @@ -154,6 +154,7 @@ And add the provided Bugzilla installation information: ``` Bugzilla should have the following components under the specified product: + * NSD Deployment Request: Component used to schedule deployment req * Onboarding: Issues related to VNF/NSD Onboarding * Operations Support: Default component for operations support @@ -336,7 +337,7 @@ The Keycloack server is managing authentication and running on a container at po - Navigate to Administration Console -- Login with the credentials from section [Configure keycloak container](#Configure-keycloak-container). Default values are: +- Login with the credentials from section [Configure keycloak container](#3-configure-keycloak-container-optional). Default values are: - user: admin and - password: KEYCLOAK_PASSWORD