Merge pull request #752 from MetaCell/dvcorreia-patch-1

Fix documentation typos

Author: filippomc

README.md

@@ -108,7 +108,6 @@ A JRE is needed to run the code generators based on openapi-generator.
 
 For more info, see [here](https://openapi-generator.tech/docs/installation).
 
-
 ## CloudHarness command line tools
 To use the cli tools, install requirements first:
 

docs/README.md

@@ -1,6 +1,6 @@
 # Index of the documentation articles
 - [Create and run a deployment](./build-deploy/README.md)
-  - [Create a codefresh continuous deployment](./build-deploy/codefresh.md)
+  - [Create a codefresh continuous deployment](./build-deploy/ci-cd/codefresh.md)
   - [Configure the Helm chart](./build-deploy/helm-configuration.md)
   - [Set up environments](./build-deploy/environments.md)
   - [Work with local deployments](./build-deploy/local-deploy/README.md)

docs/accounts.md

@@ -13,7 +13,8 @@ A user account must be provided to access to the MNP secured applications.
 To put a gatekeeper in front of your application, set `harness/secured` to `true`
 in the application's values.yaml.
 
-To assign paths and roles, set `uri_role_mapping` as you would do in the [gatekeeper configuration file resources](https://github.com/gogatekeeper/gatekeeper/blob/master/docs/content/userguide/_index.md#configuration-options).
+To assign paths and roles, set `uri_role_mapping` as you would do in the [gatekeeper configuration file resources](https://github.com/gogatekeeper/gatekeeper/blob/master/docs/content/configuration/_index.md).
+
 
 Example:
 
@@ -27,6 +28,7 @@ harness:
     - administrator
 ```
 
+
 See the [Gogatekeeper official documentation](https://gogatekeeper.github.io/gatekeeper/userguide) for more.
 
 

docs/applications/secrets.md

@@ -2,7 +2,7 @@
 
 ## What secrets are
 
-Kubernetes Secrets let you store and manage sensitive information, such as passwords, OAuth tokens, and ssh keys. Storing confidential information in a Secret is safer and more flexible than putting it verbatim in a Pod definition or in a container image. See [Secrets design document](https://github.com/kubernetes/community/blob/master/contributors/design-proposals/auth/secrets.md) for more information.
+Kubernetes Secrets let you store and manage sensitive information, such as passwords, OAuth tokens, and ssh keys. Storing confidential information in a Secret is safer and more flexible than putting it verbatim in a Pod definition or in a container image. See [Secrets design document](https://github.com/kubernetes/design-proposals-archive/blob/main/auth/secrets.md) for more information.
 
 **CloudHarness has build-in support for application specific kubernetes secrets.**
 

docs/build-deploy/README.md

@@ -94,7 +94,7 @@ To build and reploy
 
 ## Continuous deployment with Codefresh
 
-See [here](./codefresh.md).
+See [here](./ci-cd/codefresh.md).
 
 ## Relevant files and directory structure
 Deployment files are automatically generated with the script 

docs/build-deploy/environments.md

@@ -6,7 +6,7 @@ respect to the production build.
 
 ## How to set the environment
 
-The environment of the current deployment can ve set with the parameter `--env` (`-e`)
+The environment of the current deployment can be set with the parameter `--env` (`-e`)
 of `harness-deployment`.
 
 When the environment is set, specific environment configuration files are included, potentially overriding any value in the system.

docs/dev.md

@@ -232,7 +232,7 @@ The skaffold configuration is generated by the `create_skaffold_configuration(..
 This function also generates the skaffold entries for the Dockerfiles of the micro-services used in the application.
 The skaffold generation is based on the [`skaffold-template.yaml`](../deployment-configuration/skaffold-template.yaml) from the CloudHarness project located in [`deployment-configuration`](../deployment-configuration/).
 This base configuration is merged with the configuration dedicated to a specific project and which is located in the `deployment-configuration` folder of the project.
-Finally, once all the requiered information are injected in the skaffold configuration dictionnary, the dictionnary is saved as a YAML file in the `deployment/skaffold.yaml` file in the project directory.
+Finally, once all the requiered information is injected in the skaffold configuration dictionnary, the dictionnary is saved as a YAML file in the `deployment/skaffold.yaml` file in the project directory.
 
 #### How to extend the deployment generation
 

docs/jupyterhub.md

@@ -138,7 +138,7 @@ def change_pod_manifest(self: KubeSpawner):
 ```
 
 The hook function should be part of a library installable as a pip package.
-To see a real example, refer to the main [hook implementation](../applications/jupyterhub/src/harness_jupyter/jupyterhub.py).
+To see a real example, refer to the main [hook implementation](../applications/jupyterhub/src/harness_jupyter/harness_jupyter/jupyterhub.py).
 
 ### Add the hook
 
@@ -178,5 +178,3 @@ to the [values.yaml](../applications/jupyterhub/deploy/values.yaml) file.
 Cloudharness JupyterHub is integrated with the accounts service so enabling a shared single-sign-on with other applications in the solution.
 
 The spawner is also adapted providing a hook to allow other applications to be based on the hub spawner to run with their own configurations.
-
-Available

docs/tutorials/simple-date-clock-application.adoc

@@ -36,7 +36,7 @@ Before installing everything, please be sure you have the following tools instal
 == Install {ch} (if it is not yet done)
 
 {ch} is coded in Python, consequently, it's always better to create a local virtualenv dedicated to the project to avoid messing with your system dependencies.
-As shown in the snippet above, we will clone the repository, change directory inside the freshly clone directory and create a virtualenv inside (for this tutorial, the Python's version used is CPython 3.10.6).
+As shown in the snippet below, we will clone the repository, change directory inside the freshly clone directory and create a virtualenv inside (for this tutorial, the Python's version used is CPython 3.10.6).
 
 First step is to clone the link:{repo_url}[{ch} repository] on your system.
 
@@ -398,7 +398,7 @@ This will add a new `datetime_controller.py` in the `backend/clockdate/controlle
 
 [IMPORTANT]
 You need to notice that all the controllers files (and all the files) are overridden in the `backend` directory.
-To prevent files of being overridden, you need to edit the `.openapi-generator-ignore` file, that acts like a `.gitignore` file (in a way), by marking the files/directories that needs to be ignored by the generation.
+To prevent files from being overridden, you need to edit the `.openapi-generator-ignore` file, in Cloud Harness template directory, which acts like a `.gitignore` file (in a way), by marking the files/directories that needs to be ignored by the generation.
 
 When we open this file, we get the following controller method: