diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2022-07-13 09:10:00 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2022-07-13 09:10:00 +0300 |
commit | 33a43bde0ea70044342e62637d85cdfa84931ef2 (patch) | |
tree | 417b45ed10511e909c1843a984df0c0e445bfcdb /doc/development/documentation/site_architecture | |
parent | 58f103ba8fa4a64ca54c80713123dbf87e41459f (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development/documentation/site_architecture')
-rw-r--r-- | doc/development/documentation/site_architecture/folder_structure.md | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/doc/development/documentation/site_architecture/folder_structure.md b/doc/development/documentation/site_architecture/folder_structure.md index e960a6491c7..0e8065d794f 100644 --- a/doc/development/documentation/site_architecture/folder_structure.md +++ b/doc/development/documentation/site_architecture/folder_structure.md @@ -85,6 +85,15 @@ place for it. Do not include the same information in multiple places. [Link to a single source of truth instead.](../styleguide/index.md#link-instead-of-repeating-text) +For example, if you have code in a repository other than the [primary repositories](index.md#architecture), +and documentation in the same repository, you can keep the documentation in that repository. + +Then you can either: + +- Publish it to <https://docs.gitlab.com>. +- Link to it from <https://docs.gitlab.com> by adding an entry in the global navigation. + View [an example](https://gitlab.com/gitlab-org/gitlab-docs/-/blob/fedb6378a3c92274ba3b6031df0d34455594e4cc/content/_data/navigation.yaml#L2944). + ## References across documents - Give each folder an `index.md` page that introduces the topic, and both introduces |