Welcome to mirror list, hosted at ThFree Co, Russian Federation.

gitlab.com/gitlab-org/gitlab-docs.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2017-09-12 20:20:42 +0300
committerAchilleas Pipinellis <axilleas@axilleas.me>2017-09-12 20:20:42 +0300
commita7456af186198107c234d74e825a6d39e47f1663 (patch)
tree5df1cb987402a6c916768eede1dbbfc688d9c015 /README.md
parentf85c3ded5e1819e165c7e0f8c7fa196f76cf2bf0 (diff)
Update readme
Diffstat (limited to 'README.md')
-rw-r--r--README.md71
1 files changed, 4 insertions, 67 deletions
diff --git a/README.md b/README.md
index 0c558325..78256361 100644
--- a/README.md
+++ b/README.md
@@ -232,79 +232,16 @@ The Atom Flight Manual has [the ability to switch between platforms for given pa
## Review Apps for documentation merge requests
-If you are working on [one of the projects we pull from](#projects-we-pull-from)
-and updating the documentation, there is a way to preview it using Review Apps
-in the gitlab-docs project:
-
-1. Make sure you have Developer (push) access to this project.
-1. Clone the docs site:
-
- ```
- git clone git@gitlab.com:gitlab-com/gitlab-docs.git
- ```
-
-1. Create a branch.
-1. Edit `.gitlab-ci.yml` and change the branch variable of the project you
- wish to preview. For example, if you work on documentation changes for
- GitLab CE and the branch is named `1234-docs-for-foo`, change the respective
- CI variable:
-
- ```yaml
- VARIABLES:
- BRANCH_CE: '1234-docs-for-foo'
- ```
-
-1. Commit your changes and push the branch.
-1. Optionally create an MR marked as `WIP` in order to
- avoid accidental merge, we'll use this only as a Review App.
-1. Wait a few minutes and if the build finishes successfully, you'll be able to
- see the link to the preview docs in the [environments page] using the
- [environment URL button][env-url-button].
-
-If new changes are pushed to the upstream docs, just create a new pipeline in
-the [new pipeline page]. Choose the branch you created for the Review App and
-hit **Create pipeline** for the new doc changes to be pulled and deployed.
-
-Once the docs are eventually merged upstream, don't forget to close the
-Review Apps MR (if you created one), delete the branch.
+If you are contributing to GitLab docs read how to create a Review App with each
+merge request: https://docs.gitlab.com/ee/development/writing_documentation.html#previewing-the-changes-live.
## 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, EE, Omnibus.
-
-To add a new trigger for another project:
-
-1. Go to https://gitlab.com/gitlab-com/gitlab-docs/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/gitlab-docs/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/1794617/trigger/builds"
- only:
- - master@gitlab-org/gitlab-ce
- ```
-
- >**Note:**
- Every project might have different stages, make sure to add it to one that
- makes sense, for example after all builds successfully pass.
+We also use [scheduled pipelines](https://docs.gitlab.com/ee/user/project/pipelines/schedules.html)
+to build the site once an hour.
[job]: https://gitlab.com/gitlab-org/gitlab-ce/blob/2c00d00ec1c39dbea0e0e54265027b5476b78e3c/.gitlab-ci.yml#L308-318
[pages]: https://pages.gitlab.io