2019-02-15 15:39:39 +05:30
|
|
|
---
|
|
|
|
|
description: "Learn how GitLab's documentation website is architectured."
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
# Documentation site architecture
|
|
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
Learn how we build and architecture [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs)
|
2019-02-15 15:39:39 +05:30
|
|
|
and deploy it to <https://docs.gitlab.com>.
|
|
|
|
|
|
|
|
|
|
## Repository
|
|
|
|
|
|
|
|
|
|
While the source of the documentation content is stored in GitLab's respective product
|
|
|
|
|
repositories, the source that is used to build the documentation site _from that content_
|
2019-09-30 21:07:59 +05:30
|
|
|
is located at <https://gitlab.com/gitlab-org/gitlab-docs>.
|
|
|
|
|
|
|
|
|
|
The following diagram illustrates the relationship between the repositories
|
|
|
|
|
from where content is sourced, the `gitlab-docs` project, and the published output.
|
|
|
|
|
|
|
|
|
|
```mermaid
|
|
|
|
|
graph LR
|
|
|
|
|
A[gitlab-ce/doc]
|
|
|
|
|
B[gitlab-ee/doc]
|
|
|
|
|
C[gitlab-runner/docs]
|
|
|
|
|
D[omnibus-gitlab/doc]
|
|
|
|
|
E[charts/doc]
|
|
|
|
|
F[gitlab-docs]
|
|
|
|
|
A --> F
|
|
|
|
|
B --> F
|
|
|
|
|
C --> F
|
|
|
|
|
D --> F
|
|
|
|
|
E --> F
|
|
|
|
|
F -- Build pipeline --> G
|
|
|
|
|
G[docs.gitlab.com]
|
|
|
|
|
H[/ce/]
|
|
|
|
|
I[/ee/]
|
|
|
|
|
J[/runner/]
|
|
|
|
|
K[/omnibus/]
|
|
|
|
|
L[/charts/]
|
|
|
|
|
G --> H
|
|
|
|
|
G --> I
|
|
|
|
|
G --> J
|
|
|
|
|
G --> K
|
|
|
|
|
G --> L
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
See the [README there](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/README.md)
|
|
|
|
|
for detailed information.
|
2019-02-15 15:39:39 +05:30
|
|
|
|
|
|
|
|
## Assets
|
|
|
|
|
|
|
|
|
|
To provide an optimized site structure, design, and a search-engine friendly
|
|
|
|
|
website, along with a discoverable documentation, we use a few assets for
|
|
|
|
|
the GitLab Documentation website.
|
|
|
|
|
|
|
|
|
|
### Libraries
|
|
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
- [Bootstrap 4.3.1 components](https://getbootstrap.com/docs/4.3/components/)
|
|
|
|
|
- [Bootstrap 4.3.1 JS](https://getbootstrap.com/docs/4.3/getting-started/javascript/)
|
|
|
|
|
- [jQuery](https://jquery.com/) 3.3.1
|
2019-02-15 15:39:39 +05:30
|
|
|
- [Clipboard JS](https://clipboardjs.com/)
|
|
|
|
|
- [Font Awesome 4.7.0](https://fontawesome.com/v4.7.0/icons/)
|
|
|
|
|
|
|
|
|
|
### SEO
|
|
|
|
|
|
|
|
|
|
- [Schema.org](https://schema.org/)
|
|
|
|
|
- [Google Analytics](https://marketingplatform.google.com/about/analytics/)
|
|
|
|
|
- [Google Tag Manager](https://developers.google.com/tag-manager/)
|
|
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
## Global navigation
|
2019-02-15 15:39:39 +05:30
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
Read through the global navigation](global_nav.md) documentation to understand:
|
|
|
|
|
|
|
|
|
|
- How the global navigation is built.
|
|
|
|
|
- How to add new navigation items.
|
2019-02-15 15:39:39 +05:30
|
|
|
|
|
|
|
|
## Deployment
|
|
|
|
|
|
|
|
|
|
The docs site is deployed to production with GitLab Pages, and previewed in
|
|
|
|
|
merge requests with Review Apps.
|
|
|
|
|
|
2019-09-30 21:07:59 +05:30
|
|
|
The deployment aspects will be soon transferred from the [original document](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/README.md)
|
2019-02-15 15:39:39 +05:30
|
|
|
to this page.
|
|
|
|
|
|
|
|
|
|
<!--
|
|
|
|
|
## Repositories
|
|
|
|
|
|
|
|
|
|
TBA
|
|
|
|
|
|
|
|
|
|
## Search engine
|
|
|
|
|
|
|
|
|
|
TBA
|
|
|
|
|
|
|
|
|
|
## Versions
|
|
|
|
|
|
|
|
|
|
TBA
|
|
|
|
|
|
|
|
|
|
## Helpers
|
|
|
|
|
|
|
|
|
|
TBA
|
|
|
|
|
-->
|
