Skip to content

Commit d0a6ea3

Browse files
committed
Misc refactoring of docs/ folder content
1 parent a71f191 commit d0a6ea3

File tree

5 files changed

+4
-6
lines changed

5 files changed

+4
-6
lines changed

docs/building.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,4 +99,4 @@ docker run --rm -it gitops-service:latest # to get /bin/bash
9999
[psql.sh]: https://github.com/redhat-appstudio/managed-gitops/blob/main/psql.sh
100100
[Operation CRD]: https://github.com/redhat-appstudio/managed-gitops/blob/main/backend-shared/config/crd/bases/managed-gitops.redhat.com_operations.yaml
101101
[routes]: https://github.com/redhat-appstudio/managed-gitops/tree/main/backend/routes
102-
[Design]: https://docs.google.com/document/d/1e1UwCbwK-Ew5ODWedqp_jZmhiZzYWaxEvIL-tqebMzo/edit#heading=h.s0hdo22ap5cp
102+
[Design]: ./designs/gitops-service-internal-architecture-appstudio

docs/components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,4 @@ Plus, within each of the components there is a `Makefile`, which can be used for
4747
[psql.sh]: https://github.com/redhat-appstudio/managed-gitops/blob/main/psql.sh
4848
[Operation CRD]: https://github.com/redhat-appstudio/managed-gitops/blob/main/backend-shared/config/crd/bases/managed-gitops.redhat.com_operations.yaml
4949
[routes]: https://github.com/redhat-appstudio/managed-gitops/tree/main/backend/routes
50-
[Design]: https://docs.google.com/document/d/1e1UwCbwK-Ew5ODWedqp_jZmhiZzYWaxEvIL-tqebMzo/edit#heading=h.s0hdo22ap5cp
50+
[Design]: ./designs/gitops-service-internal-architecture-appstudio

docs/designs/initial-api-design.md

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

33
### Written by
44
- Jonathan West (@jgwest)
5+
- Originally written from Sept 30, 2021 to Nov 19, 2021, with additional updates throughout 2022 and 2023
56

67
# Definitions
78

docs/profiling.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,3 @@ docker run --rm -it --network="host" -v $HOME/managed-gitops/parca.yaml:/parca.y
6565

6666
4. Select a profile from the dropdown menu to visualize the icicle graph.
6767

68-
### Reference
69-
70-
1. [Profiling HAS](https://docs.google.com/document/d/1LqLeDEhYXDK07lz_p582c1LRVwxwFCdqFLk1fh33Dn8/edit#heading=h.852ozrf8sxek)

docs/sandboxing-via-appprojects.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ spec:
8484
8585
# Argo CD’s default Repository Credential behaviour is not a good fit for multitenancy, and AppProject doesn’t fix that
8686
87-
The way that Argo CD handles repository credentials does not fit well with multitenancy. This is covered [in this document](https://docs.google.com/document/d/1aYUFlOvGB0R5142PTg5Y4BQwp_1kugj-zveziErRwJY/edit#heading=h.5mbvxcu19jxr).
87+
The way that Argo CD handles repository credentials does not fit well with multitenancy. This is covered [in this document](./designs/gitops-service-internal-architecture-appstudio).
8888
8989
In short, if one Argo CD Application has the credentials to read from a private Git repository, then ANY Argo CD Application can read from that Git repository (and will use those credentials).
9090

0 commit comments

Comments
 (0)