Skip to content
Snippets Groups Projects
Commit 7e7d3a03 authored by Achilleas Pipinellis's avatar Achilleas Pipinellis
Browse files

Deprecation message

[ci skip]
parent 04369024
No related branches found
No related tags found
No related merge requests found
[![build status](https://gitlab.com/gitlab-com/doc-gitlab-com/badges/master/build.svg)](https://gitlab.com/gitlab-com/doc-gitlab-com/commits/master)
# DEPRECATED
 
## Introduction
[Doc-gitlab-com](https://gitlab.com/gitlab-com/doc-gitlab-com/) generates HTML
pages for the [GitLab documentation website](https://docs.gitlab.com/). The
documentation is generated from the Markdown files in the `/doc` directory of
the GitLab repos. The conversion from Markdown into HTML is done with
[Pandoc](http://johnmacfarlane.net/pandoc/).
If you want to contribute with documentation, please add them to the
corresponding project:
+ [GitLab CE](https://gitlab.com/gitlab-org/gitlab-ce/)
+ [GitLab EE](https://gitlab.com/gitlab-org/gitlab-ee/)
And follow the [contributing guidelines][contributing] and
[documentation styleguide][doc-styleguide] of each project.
## Requirements
Only 2 requirements:
- Ruby
- Pandoc
No version restrictions, although you'd probably be better off using the
latest of both.
## Generation
To build the documentation website we use the `generate.rb` script which:
1. Clones the respective repositories in `/tmp/gitlab/`.
1. Uses pandoc to create HTML documents from Markdown using `template.html` as
a template.
1. Copies the stylesheets and the index page.
By default, the site is built in the `public/` directory inside the root
directory of this project. You can override this using the `SITE_PATH`
environment variable.
No console output will be created by default during the build process. If you
want to see progress indicators, set the `PROGRESS` environment variable:
```
PROGRESS=1 ./generate.rb
```
## Restrictions
- Only png image files are supported.
## Deployment process
We use [GitLab Pages][pages] to build and host this website. You can see
`.gitlab-ci.yml` for more information.
A [job] is used to trigger a new build whenever tests run and pass on master
branch of CE.
To add a new trigger for another project:
1. Go to https://gitlab.com/gitlab-com/doc-gitlab-com/triggers (you need Master
access) and copy the trigger value.
1. Go to the project you will be triggering from and add a secret variable
named `DOCS_TRIGGER_TOKEN` with the value of the trigger you copied from the
previous step.
1. Add the following job to the project's `.gitlab-ci.yml`, where you should
replace the `PROJECT` variable's value with the name of the project the
trigger is running from, for example `ce`, `ee`, `omnibus`, `runner`, etc.:
```yaml
# Trigger docs build
# https://gitlab.com/gitlab-com/doc-gitlab-com/blob/master/README.md#deployment-process
trigger_docs:
variables:
GIT_STRATEGY: none
before_script: []
cache: {}
artifacts: {}
script:
- "curl -X POST -F token=${DOCS_TRIGGER_TOKEN} -F ref=master -F variables[PROJECT]=ce https://gitlab.com/api/v3/projects/38069/trigger/builds"
only:
- master
```
>**Note:**
Every project might have different stages, make sure to add it to one that
makes sense, for example after all builds successfully pass.
[contributing]: https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#merge-request-guidelines
[doc-styleguide]: https://docs.gitlab.com/ce/development/doc_styleguide.html
[job]: https://gitlab.com/gitlab-org/gitlab-ce/blob/2c00d00ec1c39dbea0e0e54265027b5476b78e3c/.gitlab-ci.yml#L308-318
[pages]: https://pages.gitlab.io
This project is now deprecated and archived. You can find the new docs portal
at https://gitlab.com/gitlab-com/gitlab-docs.
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment