summaryrefslogtreecommitdiff
path: root/doc/development/documentation/site_architecture/index.md
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2022-07-12 21:09:53 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2022-07-12 21:09:53 +0000
commitb6f17c69925beded921017fa049385de715553ba (patch)
tree5f8b2a5fbc6b1e779b7421ceddd219065e65fec9 /doc/development/documentation/site_architecture/index.md
parent0ba11d8461a2b091d37bb6308d85e74f2b133803 (diff)
downloadgitlab-ce-b6f17c69925beded921017fa049385de715553ba.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/site_architecture/index.md')
-rw-r--r--doc/development/documentation/site_architecture/index.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/doc/development/documentation/site_architecture/index.md b/doc/development/documentation/site_architecture/index.md
index 05015fe7c5f..af24fbe303b 100644
--- a/doc/development/documentation/site_architecture/index.md
+++ b/doc/development/documentation/site_architecture/index.md
@@ -59,6 +59,19 @@ product, and all together are pulled to generate the docs website:
Learn more about [the docs folder structure](folder_structure.md).
+### Documentation in other repositories
+
+If you have code and documentation in a repository other than the [primary repositories](#architecture),
+you should keep the documentation with the code in that repository.
+
+Then you can either:
+
+- [Add the repository to the list of products](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/main/doc/development.md#add-a-new-product)
+ published at <https://docs.gitlab.com>.
+- [Add an entry in the global navigation](global_nav.md#add-a-navigation-entry) for
+ <https://docs.gitlab.com> that links to the documentation in that repository.
+ View [an example](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/fedb6378a3c92274ba3b6031df0d34455594e4cc/content/_data/navigation.yaml#L2944-L2946).
+
## Assets
To provide an optimized site structure, design, and a search-engine friendly