Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
G
gitlab-ce
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
1
Merge Requests
1
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
gitlab-ce
Commits
98342b7f
Commit
98342b7f
authored
6 years ago
by
Marcia Ramos
Committed by
Achilleas Pipinellis
6 years ago
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Docs: how the global nav works
parent
0f5f1381
Changes
3
Expand all
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
411 additions
and
3 deletions
+411
-3
doc/development/documentation/index.md
doc/development/documentation/index.md
+10
-3
doc/development/documentation/site_architecture/global_nav.md
...development/documentation/site_architecture/global_nav.md
+342
-0
doc/development/documentation/site_architecture/index.md
doc/development/documentation/site_architecture/index.md
+59
-0
No files found.
doc/development/documentation/index.md
View file @
98342b7f
...
@@ -378,6 +378,16 @@ CAUTION: **Caution:**
...
@@ -378,6 +378,16 @@ CAUTION: **Caution:**
Because the rspec tests only run in a full pipeline, and not a special [docs-only pipeline](#branch-naming), it is possible
Because the rspec tests only run in a full pipeline, and not a special [docs-only pipeline](#branch-naming), it is possible
to merge changes that will break `master` from a merge request with a successful docs-only pipeline run.
to merge changes that will break `master` from a merge request with a successful docs-only pipeline run.
## Docs site architecture
Read through [docs architecture](site_architecture/index.md) to learn
how we architecture, build, and deploy the docs site, <https://docs.gitlab.com>, and
to check all the assets and libraries available.
### Global navigation
Read through the [global navigation](site_architecture/global_nav.md) doc.
## General Documentation vs Technical Articles
## General Documentation vs Technical Articles
### General documentation
### General documentation
...
@@ -690,6 +700,3 @@ GitLab uses [danger bot](https://github.com/danger/danger) for some elements in
...
@@ -690,6 +700,3 @@ GitLab uses [danger bot](https://github.com/danger/danger) for some elements in
code review. For docs changes in merge requests, whenever a change under `/doc`
code review. For docs changes in merge requests, whenever a change under `/doc`
is made, the bot leaves a comment for the author to mention `@gl-docsteam`, so
is made, the bot leaves a comment for the author to mention `@gl-docsteam`, so
that the docs can be properly reviewed.
that the docs can be properly reviewed.
[gitlab-map]: https://gitlab.com/gitlab-org/gitlab-design/raw/master/production/resources/gitlab-map.png
[graffle]: https://gitlab.com/gitlab-org/gitlab-design/blob/d8d39f4a87b90fb9ae89ca12dc565347b4900d5e/production/resources/gitlab-map.graffle
This diff is collapsed.
Click to expand it.
doc/development/documentation/site_architecture/global_nav.md
0 → 100644
View file @
98342b7f
This diff is collapsed.
Click to expand it.
doc/development/documentation/site_architecture/index.md
0 → 100644
View file @
98342b7f
---
description
:
"
Learn
how
GitLab's
documentation
website
is
architectured."
---
# Docs site architecture
Learn how we build and architecture
[
`gitlab-docs`
](
https://gitlab.com/gitlab-com/gitlab-docs
)
and deploy it to
<https://docs.gitlab.com>
.
## 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
-
[
Bootstrap 3.3 components
](
https://getbootstrap.com/docs/3.3/components/
)
-
[
Bootstrap 3.3 JS
](
https://getbootstrap.com/docs/3.3/javascript/
)
-
[
jQuery
](
https://jquery.com/
)
3.2.1
-
[
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/
)
## Global nav
To understand how the global nav (left sidebar) is built, please
read through the
[
global navigation
](
global_nav.md
)
doc.
## Deployment
The docs site is deployed to production with GitLab Pages, and previewed in
merge requests with Review Apps.
The deployment aspects will be soon transfered from the
[
original document
](
https://gitlab.com/gitlab-com/gitlab-docs/blob/master/README.md
)
to this page.
<!--
## Repositories
TBA
## Search engine
TBA
## Versions
TBA
## Helpers
TBA
-->
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment