Skip to content

Commit 0002401

Browse files
committed
Update global to move update-common-components.py into global itself; update docs to reflect this new path
1 parent ded1aad commit 0002401

File tree

3 files changed

+6
-2
lines changed

3 files changed

+6
-2
lines changed

docs/_global/readme.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22

33
This repo holds the common components shared between this org's hosted MkDocs documentation projects.
44

5-
The idea is that this repo will be kept up-to-date with global config, and each child repo will use a provided script to download the latest commit from this repo, and have its "local" MkDocs config point to the downloaded files from this repo.
5+
The idea is that this repo will be kept up-to-date with global config, and each child repo will use the provided script to download the latest commit from this repo, and have its "local" MkDocs config point to the downloaded files from this repo.
66

77
In all cases, each child repo will be able to *override* config items here as needed.
8+
9+
## Updating This Repo
10+
11+
See [Modifying Common Components](https://docsforadobe.dev/contributing/common-components/modifying-common-components/) in the org contribution guide for info on how this repo works, and best practices for modifying it.

docs/contributing/common-components/updating-common-components.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Instead of trying to manage all of these shared files many times, we've hosted t
1212
In this manner, we've introduced a one-command workflow to fetch all of the latest global settings and ensure each guide is up-to-date with these changes.
1313

1414
```sh
15-
python ./scripts/update-common-components.py
15+
python ./docs/_global/scripts/update-common-components.py
1616
```
1717

1818
This will modify the contents of the `./docs/_global/` directory.

0 commit comments

Comments
 (0)