Skip to content

Commit

Permalink
[docs] Backport docs fixes from main (#242)
Browse files Browse the repository at this point in the history
* Update design.md

* Update README.md

Bringing changes suggested in the pending PR #181

* Update README in docs folder since that gets published in https://arlon.readthedocs.io/

* Update README in docs (ReadTheDocs) to fix relative paths
  • Loading branch information
cruizen authored Sep 22, 2022
1 parent b406432 commit 9d5d572
Show file tree
Hide file tree
Showing 3 changed files with 335 additions and 45 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,7 +116,7 @@ However, it does NOT remove the repository from `argocd`. When the "default" ali
we also clear the "default" entry from the JSON file.

#### Examples
Given below are some examples for registering an unregistering a repository.
Given below are some examples for registering and unregistering a repository.
##### Registering Repositories
Registering a repository requires the repository link, the GitHub username(`--user`), and a personal access token(`--password`).
When the `--password` flag isn't provided at the command line, the CLI will prompt for a password(this is the recommended approach).
Expand Down Expand Up @@ -168,7 +168,7 @@ the bundle at the time the cluster was created, and is not affected by subsequen
changes to the bundle's manifest data.

### Dynamic bundle
A dynamic bunlde contains a reference to the manifest data stored in git.
A dynamic bundle contains a reference to the manifest data stored in git.
A dynamic bundle is distinguished
by having these fields set to non-empty values:
- git URL of the repo
Expand Down Expand Up @@ -248,7 +248,7 @@ After this step, you should be logged in as `admin` and a config file was create
Example: `argocd repo add https://github.com/myname/arlon_workspace --username myname --password secret`.
- Note: type `argocd repo add --help` to see all available options.
- For Arlon developers, this is not your fork of the Arlon source code repository,
but a separate git repo where some artefacts like profiles created by Arlon will be stored.
but a separate git repo where some artifacts like profiles created by Arlon will be stored.
- Highly recommended: [configure a webhook](https://argo-cd.readthedocs.io/en/stable/operator-manual/webhook/)
to immediately notify ArgoCD of changes to the repo. This will be especially useful
during the tutorial. Without a webhook, repo changes may take up to 3 minutes
Expand Down
Loading

0 comments on commit 9d5d572

Please sign in to comment.