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

gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAchilleas Pipinellis <axilleas@axilleas.me>2016-02-24 17:12:12 +0300
committerJames Edwards-Jones <jedwardsjones@gitlab.com>2017-02-01 01:55:30 +0300
commitdbfde1d06f984ff37c5c953f914acf8d2ffe1c63 (patch)
tree94b55588c551a53fe8b5523904ef7d1be61eec01 /doc/pages/README.md
parentbcf891719f89620544ab8f4ea7d91748fa277251 (diff)
Add requirements section
Diffstat (limited to 'doc/pages/README.md')
-rw-r--r--doc/pages/README.md46
1 files changed, 24 insertions, 22 deletions
diff --git a/doc/pages/README.md b/doc/pages/README.md
index f63cfb3cda2..42df9c79f22 100644
--- a/doc/pages/README.md
+++ b/doc/pages/README.md
@@ -19,6 +19,7 @@ deploy static pages for your individual projects, your user or your group.
**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)*
- [Getting started with GitLab Pages](#getting-started-with-gitlab-pages)
+ - [GitLab Pages requirements](#gitlab-pages-requirements)
- [GitLab pages per user](#gitlab-pages-per-user)
- [GitLab pages per group](#gitlab-pages-per-group)
- [GitLab pages per project](#gitlab-pages-per-project)
@@ -36,39 +37,40 @@ deploy static pages for your individual projects, your user or your group.
## Getting started with GitLab Pages
-GitLab Pages rely heavily on GitLab CI and its ability to upload artifacts.
-The steps that are performed from the initialization of a project to the
-creation of the static content, can be summed up to:
-
-1. Find out the general domain name that is used for GitLab Pages
- (ask your administrator). This is very important, so you should first make
- sure you get that right.
-1. Create a project (its name should be specific according to the case)
-1. Provide a specific job named `pages` in `.gitlab-ci.yml`
-1. GitLab Runner builds the project
-1. GitLab CI uploads the artifacts
-1. The [GitLab Pages daemon][pages-daemon] serves the content
-
-As a user, you should normally be concerned only with the first three or four
-items. If [shared runners](../ci/runners/README.md) are enabled by your GitLab
-administrator, you should be able to use them instead of bringing your own.
-
-> **Note:**
-> In the rest of this document we will assume that the general domain name that
-> is used for GitLab Pages is `example.io`.
+GitLab Pages rely heavily on GitLab CI and its ability to upload
+[artifacts](../ci/yaml/README.md#artifacts).
In general there are two kinds of pages one might create:
-- Pages per user/group
-- Pages per project
+- Pages per user/group (`username.example.io`)
+- Pages per project (`username.example.io/projectname`)
In GitLab, usernames and groupnames are unique and often people refer to them
as namespaces. There can be only one namespace in a GitLab instance.
+> **Note:**
+> In the rest of this document we will assume that the general domain name that
+> is used for GitLab Pages is `example.io`.
+
> **Warning:**
> There are some known [limitations](#limitations) regarding namespaces served
> under the general domain name and HTTPS. Make sure to read that section.
+### GitLab Pages requirements
+
+In brief, this is what you need to upload your website in GitLab Pages:
+
+1. Find out the general domain name that is used for GitLab Pages
+ (ask your administrator). This is very important, so you should first make
+ sure you get that right.
+1. Create a project
+1. Provide a specific job named [`pages`](../ci/yaml/README.md#pages) in
+ [`.gitlab-ci.yml`](../ci/yaml/README.md)
+1. A GitLab Runner to build GitLab Pages
+
+If [shared runners](../ci/runners/README.md) are enabled by your GitLab
+administrator, you should be able to use them instead of bringing your own.
+
### GitLab pages per user
Head over your GitLab instance that supports GitLab Pages and create a