Skip to content

Commit f4c526f

Browse files
committed
Added first pull of external repo and README addition on external content
Signed-off-by: Tobias Babin <[email protected]>
1 parent 7459bac commit f4c526f

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,25 @@ Example output.
9393

9494
To lint all documents, run `yarn lint`.
9595

96+
## Autogenerated content
97+
98+
### Score example hub
99+
100+
This site uses content from external Git repositories to create and continuously update the "Score example hub" pages. The external repos are pulled in to the `/gen/external-repos` folder.
101+
102+
The commands for the initial integration of an external repo are:
103+
104+
```bash
105+
git remote add -f repo-name https://github.com/repo-org/repo-name.git
106+
git subtree add --prefix gen/external-repos/repo-name/ repo-name main --squash
107+
```
108+
109+
These commands will not have to be repeated unless re-creating the repo integration, or moving the source location. In that case, remove the `remote`, delete the local contents, repeat these commands targeting the new location, and update the generation scripts.
110+
111+
### Pulling new content
112+
113+
TODO - fill in the details on the continous pulling of external content once implemented.
114+
96115
## Troubleshooting documentation site builds
97116

98117
This section covers common build issues with Hugo.

0 commit comments

Comments
 (0)