Skip to content

Commit 0305496

Browse files
author
Diogo Correia
committed
Fix documentation typos
1 parent 7d5c032 commit 0305496

6 files changed

Lines changed: 6 additions & 7 deletions

File tree

README.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,6 @@ A JRE is needed to run the code generators based on openapi-generator.
108108

109109
For more info, see [here](https://openapi-generator.tech/docs/installation).
110110

111-
112111
## CloudHarness command line tools
113112
To use the cli tools, install requirements first:
114113

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Index of the documentation articles
22
- [Create and run a deployment](./build-deploy/README.md)
3-
- [Create a codefresh continuous deployment](./build-deploy/codefresh.md)
3+
- [Create a codefresh continuous deployment](./build-deploy/ci-cd/codefresh.md)
44
- [Configure the Helm chart](./build-deploy/helm-configuration.md)
55
- [Set up environments](./build-deploy/environments.md)
66
- [Work with local deployments](./build-deploy/local-deploy/README.md)

docs/applications/secrets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## What secrets are
44

5-
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.
5+
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.
66

77
**CloudHarness has build-in support for application specific kubernetes secrets.**
88

docs/build-deploy/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ To build and reploy
9494

9595
## Continuous deployment with Codefresh
9696

97-
See [here](./codefresh.md).
97+
See [here](./ci-cd/codefresh.md).
9898

9999
## Relevant files and directory structure
100100
Deployment files are automatically generated with the script

docs/build-deploy/environments.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ respect to the production build.
66

77
## How to set the environment
88

9-
The environment of the current deployment can ve set with the parameter `--env` (`-e`)
9+
The environment of the current deployment can be set with the parameter `--env` (`-e`)
1010
of `harness-deployment`.
1111

1212
When the environment is set, specific environment configuration files are included, potentially overriding any value in the system.

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Before installing everything, please be sure you have the following tools instal
3636
== Install {ch} (if it is not yet done)
3737

3838
{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.
39-
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).
39+
As shown in the snippet bellow, 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).
4040

4141
First step is to clone the link:{repo_url}[{ch} repository] on your system.
4242

@@ -398,7 +398,7 @@ This will add a new `datetime_controller.py` in the `backend/clockdate/controlle
398398

399399
[IMPORTANT]
400400
You need to notice that all the controllers files (and all the files) are overridden in the `backend` directory.
401-
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.
401+
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.
402402

403403
When we open this file, we get the following controller method:
404404

0 commit comments

Comments
 (0)