Merge branch 'rename-gitlab-docs-repo' into 'master'
Move the gitlab-docs project under gitlab-org See merge request gitlab-org/gitlab-ce!30620
This commit is contained in:
commit
cb0edce20e
|
@ -4,7 +4,7 @@
|
||||||
Note: Doc work as part of feature development is covered in the Feature Request template.
|
Note: Doc work as part of feature development is covered in the Feature Request template.
|
||||||
|
|
||||||
* For issues related to features of the docs.gitlab.com site, see
|
* For issues related to features of the docs.gitlab.com site, see
|
||||||
https://gitlab.com/gitlab-com/gitlab-docs/issues/
|
https://gitlab.com/gitlab-org/gitlab-docs/issues/
|
||||||
|
|
||||||
* For information about documentation content and process, see
|
* For information about documentation content and process, see
|
||||||
https://docs.gitlab.com/ee/development/documentation/ -->
|
https://docs.gitlab.com/ee/development/documentation/ -->
|
||||||
|
|
|
@ -43,7 +43,7 @@ Meanwhile, anyone can contribute [documentation improvements](improvement-workfl
|
||||||
|
|
||||||
## Markdown and styles
|
## Markdown and styles
|
||||||
|
|
||||||
[GitLab docs](https://gitlab.com/gitlab-com/gitlab-docs) uses [GitLab Kramdown](https://gitlab.com/gitlab-org/gitlab_kramdown)
|
[GitLab docs](https://gitlab.com/gitlab-org/gitlab-docs) uses [GitLab Kramdown](https://gitlab.com/gitlab-org/gitlab_kramdown)
|
||||||
as its markdown rendering engine. See the [GitLab Markdown Guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/) for a complete Kramdown reference.
|
as its markdown rendering engine. See the [GitLab Markdown Guide](https://about.gitlab.com/handbook/product/technical-writing/markdown-guide/) for a complete Kramdown reference.
|
||||||
|
|
||||||
Adhere to the [Documentation Style Guide](styleguide.md). If a style standard is missing, you are welcome to suggest one via a merge request.
|
Adhere to the [Documentation Style Guide](styleguide.md). If a style standard is missing, you are welcome to suggest one via a merge request.
|
||||||
|
@ -384,7 +384,7 @@ on how the left-side navigation menu is built and updated.
|
||||||
|
|
||||||
NOTE: **Note:**
|
NOTE: **Note:**
|
||||||
To preview your changes to documentation locally, follow this
|
To preview your changes to documentation locally, follow this
|
||||||
[development guide](https://gitlab.com/gitlab-com/gitlab-docs/blob/master/README.md#development-when-contributing-to-gitlab-documentation) or [these instructions for GDK](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/gitlab_docs.md).
|
[development guide](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/README.md#development-when-contributing-to-gitlab-documentation) or [these instructions for GDK](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/gitlab_docs.md).
|
||||||
|
|
||||||
The live preview is currently enabled for the following projects:
|
The live preview is currently enabled for the following projects:
|
||||||
|
|
||||||
|
@ -408,7 +408,7 @@ You will need to push a branch to those repositories, it doesn't work for forks.
|
||||||
|
|
||||||
The `review-docs-deploy*` job will:
|
The `review-docs-deploy*` job will:
|
||||||
|
|
||||||
1. Create a new branch in the [gitlab-docs](https://gitlab.com/gitlab-com/gitlab-docs)
|
1. Create a new branch in the [gitlab-docs](https://gitlab.com/gitlab-org/gitlab-docs)
|
||||||
project named after the scheme: `$DOCS_GITLAB_REPO_SUFFIX-$CI_ENVIRONMENT_SLUG`,
|
project named after the scheme: `$DOCS_GITLAB_REPO_SUFFIX-$CI_ENVIRONMENT_SLUG`,
|
||||||
where `DOCS_GITLAB_REPO_SUFFIX` is the suffix for each product, e.g, `ce` for
|
where `DOCS_GITLAB_REPO_SUFFIX` is the suffix for each product, e.g, `ce` for
|
||||||
CE, etc.
|
CE, etc.
|
||||||
|
@ -464,7 +464,7 @@ If you want to know the in-depth details, here's what's really happening:
|
||||||
1. The preview URL is shown both at the job output and in the merge request
|
1. The preview URL is shown both at the job output and in the merge request
|
||||||
widget. You also get the link to the remote pipeline.
|
widget. You also get the link to the remote pipeline.
|
||||||
1. In the docs project, the pipeline is created and it
|
1. In the docs project, the pipeline is created and it
|
||||||
[skips the test jobs](https://gitlab.com/gitlab-com/gitlab-docs/blob/8d5d5c750c602a835614b02f9db42ead1c4b2f5e/.gitlab-ci.yml#L50-55)
|
[skips the test jobs](https://gitlab.com/gitlab-org/gitlab-docs/blob/8d5d5c750c602a835614b02f9db42ead1c4b2f5e/.gitlab-ci.yml#L50-55)
|
||||||
to lower the build time.
|
to lower the build time.
|
||||||
1. Once the docs site is built, the HTML files are uploaded as artifacts.
|
1. Once the docs site is built, the HTML files are uploaded as artifacts.
|
||||||
1. A specific Runner tied only to the docs project, runs the Review App job
|
1. A specific Runner tied only to the docs project, runs the Review App job
|
||||||
|
@ -488,7 +488,7 @@ Currently, the following tests are in place:
|
||||||
that all cURL examples in API docs use the full switches. It's recommended
|
that all cURL examples in API docs use the full switches. It's recommended
|
||||||
to [check locally](#previewing-the-changes-live) before pushing to GitLab by executing the command
|
to [check locally](#previewing-the-changes-live) before pushing to GitLab by executing the command
|
||||||
`bundle exec nanoc check internal_links` on your local
|
`bundle exec nanoc check internal_links` on your local
|
||||||
[`gitlab-docs`](https://gitlab.com/gitlab-com/gitlab-docs) directory.
|
[`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs) directory.
|
||||||
1. [`ee_compat_check`](../automatic_ce_ee_merge.md#avoiding-ce-ee-merge-conflicts-beforehand) (runs on CE only):
|
1. [`ee_compat_check`](../automatic_ce_ee_merge.md#avoiding-ce-ee-merge-conflicts-beforehand) (runs on CE only):
|
||||||
When you submit a merge request to GitLab Community Edition (CE),
|
When you submit a merge request to GitLab Community Edition (CE),
|
||||||
there is this additional job that runs against Enterprise Edition (EE)
|
there is this additional job that runs against Enterprise Edition (EE)
|
||||||
|
|
|
@ -4,9 +4,9 @@ description: "Learn how GitLab docs' global navigation works and how to add new
|
||||||
|
|
||||||
# Global navigation
|
# Global navigation
|
||||||
|
|
||||||
> - [Introduced](https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/362)
|
> - [Introduced](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/362)
|
||||||
in GitLab 11.6.
|
in GitLab 11.6.
|
||||||
> - [Updated](https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/482) in GitLab 12.1.
|
> - [Updated](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/482) in GitLab 12.1.
|
||||||
|
|
||||||
The global nav adds to the left sidebar the ability to
|
The global nav adds to the left sidebar the ability to
|
||||||
navigate and explore the contents of GitLab's documentation.
|
navigate and explore the contents of GitLab's documentation.
|
||||||
|
@ -25,7 +25,7 @@ To add a new doc to the nav, first and foremost, check with the technical writin
|
||||||
Once you get their approval and their guidance in regards to the position on the nav,
|
Once you get their approval and their guidance in regards to the position on the nav,
|
||||||
read trhough this page to understand how it works, and submit a merge request to the
|
read trhough this page to understand how it works, and submit a merge request to the
|
||||||
docs site, adding the doc you wish to include in the nav into the
|
docs site, adding the doc you wish to include in the nav into the
|
||||||
[global nav data file](https://gitlab.com/gitlab-com/gitlab-docs/blob/master/content/_data/global-nav.yaml).
|
[global nav data file](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/content/_data/global-nav.yaml).
|
||||||
|
|
||||||
Don't forget to ask a technical writer to review your changes before merging.
|
Don't forget to ask a technical writer to review your changes before merging.
|
||||||
|
|
||||||
|
@ -70,7 +70,7 @@ the data among the nav in containers properly [styled](#css-classes).
|
||||||
|
|
||||||
### Data file
|
### Data file
|
||||||
|
|
||||||
The [data file](https://gitlab.com/gitlab-com/gitlab-docs/blob/master/content/_data/global-nav.yaml)
|
The [data file](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/content/_data/global-nav.yaml)
|
||||||
is structured in three components: sections, categories, and docs.
|
is structured in three components: sections, categories, and docs.
|
||||||
|
|
||||||
#### Sections
|
#### Sections
|
||||||
|
@ -248,9 +248,9 @@ Examples:
|
||||||
|
|
||||||
### Layout file (logic)
|
### Layout file (logic)
|
||||||
|
|
||||||
The [layout](https://gitlab.com/gitlab-com/gitlab-docs/blob/master/layouts/global_nav.html)
|
The [layout](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/layouts/global_nav.html)
|
||||||
is fed by the [data file](#data-file), builds the global nav, and is rendered by the
|
is fed by the [data file](#data-file), builds the global nav, and is rendered by the
|
||||||
[default](https://gitlab.com/gitlab-com/gitlab-docs/blob/master/layouts/default.html) layout.
|
[default](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/layouts/default.html) layout.
|
||||||
|
|
||||||
There are three main considerations on the logic built for the nav:
|
There are three main considerations on the logic built for the nav:
|
||||||
|
|
||||||
|
|
|
@ -4,14 +4,14 @@ description: "Learn how GitLab's documentation website is architectured."
|
||||||
|
|
||||||
# Documentation site architecture
|
# Documentation site architecture
|
||||||
|
|
||||||
Learn how we build and architecture [`gitlab-docs`](https://gitlab.com/gitlab-com/gitlab-docs)
|
Learn how we build and architecture [`gitlab-docs`](https://gitlab.com/gitlab-org/gitlab-docs)
|
||||||
and deploy it to <https://docs.gitlab.com>.
|
and deploy it to <https://docs.gitlab.com>.
|
||||||
|
|
||||||
## Repository
|
## Repository
|
||||||
|
|
||||||
While the source of the documentation content is stored in GitLab's respective product
|
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_
|
repositories, the source that is used to build the documentation site _from that content_
|
||||||
is located at <https://gitlab.com/gitlab-com/gitlab-docs>.
|
is located at <https://gitlab.com/gitlab-org/gitlab-docs>.
|
||||||
|
|
||||||
The following diagram illustrates the relationship between the repositories
|
The following diagram illustrates the relationship between the repositories
|
||||||
from where content is sourced, the `gitlab-docs` project, and the published output.
|
from where content is sourced, the `gitlab-docs` project, and the published output.
|
||||||
|
@ -43,7 +43,7 @@ from where content is sourced, the `gitlab-docs` project, and the published outp
|
||||||
G --> L
|
G --> L
|
||||||
```
|
```
|
||||||
|
|
||||||
See the [README there](https://gitlab.com/gitlab-com/gitlab-docs/blob/master/README.md)
|
See the [README there](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/README.md)
|
||||||
for detailed information.
|
for detailed information.
|
||||||
|
|
||||||
## Assets
|
## Assets
|
||||||
|
@ -76,7 +76,7 @@ read through the [global navigation](global_nav.md) doc.
|
||||||
The docs site is deployed to production with GitLab Pages, and previewed in
|
The docs site is deployed to production with GitLab Pages, and previewed in
|
||||||
merge requests with Review Apps.
|
merge requests with Review Apps.
|
||||||
|
|
||||||
The deployment aspects will be soon transferred from the [original document](https://gitlab.com/gitlab-com/gitlab-docs/blob/master/README.md)
|
The deployment aspects will be soon transferred from the [original document](https://gitlab.com/gitlab-org/gitlab-docs/blob/master/README.md)
|
||||||
to this page.
|
to this page.
|
||||||
|
|
||||||
<!--
|
<!--
|
||||||
|
|
|
@ -127,7 +127,7 @@ Notes:
|
||||||
|
|
||||||
## Help and feedback section
|
## Help and feedback section
|
||||||
|
|
||||||
The "help and feedback" section (introduced by [!319](https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/319)) displayed at the end of each document
|
The "help and feedback" section (introduced by [!319](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/319)) displayed at the end of each document
|
||||||
can be omitted from the doc by adding a key into the its frontmatter:
|
can be omitted from the doc by adding a key into the its frontmatter:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
@ -142,7 +142,7 @@ you must check with a technical writer before doing so.
|
||||||
### Disqus
|
### Disqus
|
||||||
|
|
||||||
We also have integrated the docs site with Disqus (introduced by
|
We also have integrated the docs site with Disqus (introduced by
|
||||||
[!151](https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/151)),
|
[!151](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/151)),
|
||||||
allowing our users to post comments.
|
allowing our users to post comments.
|
||||||
|
|
||||||
To omit only the comments from the feedback section, use the following
|
To omit only the comments from the feedback section, use the following
|
||||||
|
|
|
@ -340,7 +340,7 @@ For other punctuation rules, please refer to the
|
||||||
links shift too, which eventually leads to dead links. If you think it is
|
links shift too, which eventually leads to dead links. If you think it is
|
||||||
compelling to add numbers in headings, make sure to at least discuss it with
|
compelling to add numbers in headings, make sure to at least discuss it with
|
||||||
someone in the Merge Request.
|
someone in the Merge Request.
|
||||||
- [Avoid using symbols and special chars](https://gitlab.com/gitlab-com/gitlab-docs/issues/84)
|
- [Avoid using symbols and special chars](https://gitlab.com/gitlab-org/gitlab-docs/issues/84)
|
||||||
in headers. Whenever possible, they should be plain and short text.
|
in headers. Whenever possible, they should be plain and short text.
|
||||||
- Avoid adding things that show ephemeral statuses. For example, if a feature is
|
- Avoid adding things that show ephemeral statuses. For example, if a feature is
|
||||||
considered beta or experimental, put this info in a note, not in the heading.
|
considered beta or experimental, put this info in a note, not in the heading.
|
||||||
|
@ -488,7 +488,7 @@ You can link any up-to-date video that is useful to the GitLab user.
|
||||||
|
|
||||||
### Embed videos
|
### Embed videos
|
||||||
|
|
||||||
> [Introduced](https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/472) in GitLab 12.1.
|
> [Introduced](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/472) in GitLab 12.1.
|
||||||
|
|
||||||
GitLab docs (docs.gitlab.com) support embedded videos.
|
GitLab docs (docs.gitlab.com) support embedded videos.
|
||||||
|
|
||||||
|
@ -801,7 +801,7 @@ GitLab.com Free, and all higher tiers.
|
||||||
|
|
||||||
### How it works
|
### How it works
|
||||||
|
|
||||||
Introduced by [!244](https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/244),
|
Introduced by [!244](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/244),
|
||||||
the special markup `**(STARTER)**` will generate a `span` element to trigger the
|
the special markup `**(STARTER)**` will generate a `span` element to trigger the
|
||||||
badges and tooltips (`<span class="badge-trigger starter">`). When the keyword
|
badges and tooltips (`<span class="badge-trigger starter">`). When the keyword
|
||||||
"only" is added, the corresponding GitLab.com badge will not be displayed.
|
"only" is added, the corresponding GitLab.com badge will not be displayed.
|
||||||
|
|
|
@ -40,7 +40,7 @@ repositories are also processed with CommonMark. As of 11.8, the [Redcarpet Ruby
|
||||||
has been removed and all issues and comments, including those from pre-11.1, are now processed
|
has been removed and all issues and comments, including those from pre-11.1, are now processed
|
||||||
using the [CommonMark Ruby Library](https://github.com/gjtorikian/commonmarker).
|
using the [CommonMark Ruby Library](https://github.com/gjtorikian/commonmarker).
|
||||||
|
|
||||||
The documentation website had its [markdown engine migrated from Redcarpet to Kramdown](https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/108)
|
The documentation website had its [markdown engine migrated from Redcarpet to Kramdown](https://gitlab.com/gitlab-org/gitlab-docs/merge_requests/108)
|
||||||
in October 2018.
|
in October 2018.
|
||||||
|
|
||||||
You may have older issues, merge requests, or Markdown documents in your
|
You may have older issues, merge requests, or Markdown documents in your
|
||||||
|
|
|
@ -13,7 +13,7 @@ end
|
||||||
#
|
#
|
||||||
# The remote docs project
|
# The remote docs project
|
||||||
#
|
#
|
||||||
GITLAB_DOCS_REPO = 'gitlab-com/gitlab-docs'.freeze
|
GITLAB_DOCS_REPO = 'gitlab-org/gitlab-docs'.freeze
|
||||||
|
|
||||||
#
|
#
|
||||||
# Truncate the remote docs branch name otherwise we hit the filesystem
|
# Truncate the remote docs branch name otherwise we hit the filesystem
|
||||||
|
@ -31,7 +31,7 @@ end
|
||||||
# to avoid race conditions, since a triggered pipeline will also run right
|
# to avoid race conditions, since a triggered pipeline will also run right
|
||||||
# after the branch creation. This only happens the very first time a branch
|
# after the branch creation. This only happens the very first time a branch
|
||||||
# is created and will be skipped in subsequent runs. Read more in
|
# is created and will be skipped in subsequent runs. Read more in
|
||||||
# https://gitlab.com/gitlab-com/gitlab-docs/issues/154.
|
# https://gitlab.com/gitlab-org/gitlab-docs/issues/154.
|
||||||
#
|
#
|
||||||
def create_remote_branch
|
def create_remote_branch
|
||||||
Gitlab.create_branch(GITLAB_DOCS_REPO, docs_branch, 'master')
|
Gitlab.create_branch(GITLAB_DOCS_REPO, docs_branch, 'master')
|
||||||
|
@ -81,7 +81,7 @@ def slug
|
||||||
end
|
end
|
||||||
|
|
||||||
#
|
#
|
||||||
# Overriding vars in https://gitlab.com/gitlab-com/gitlab-docs/blob/master/.gitlab-ci.yml
|
# Overriding vars in https://gitlab.com/gitlab-org/gitlab-docs/blob/master/.gitlab-ci.yml
|
||||||
#
|
#
|
||||||
def param_name
|
def param_name
|
||||||
"BRANCH_#{slug.upcase}"
|
"BRANCH_#{slug.upcase}"
|
||||||
|
|
Loading…
Reference in New Issue