BigW Consortium Gitlab
Skip to content
Projects
Groups
Snippets
Help
This project
Loading...
Sign in / Register
Toggle navigation
G
gitlab-ce
Project
Overview
Details
Activity
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Board
Labels
Milestones
Merge Requests
0
Merge Requests
0
Registry
Registry
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
Forest Godfrey
gitlab-ce
Commits
8aba28e1
Commit
8aba28e1
authored
Dec 22, 2015
by
Achilleas Pipinellis
Committed by
James Edwards-Jones
Jan 31, 2017
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Clarify some things in Pages [ci skip]
* Pages are enabled by default on each project * Add note about using the `only` parameter
parent
0bb480dc
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
13 additions
and
4 deletions
+13
-4
README.md
doc/pages/README.md
+13
-4
No files found.
doc/pages/README.md
View file @
8aba28e1
...
...
@@ -17,13 +17,14 @@ The steps that are performed from the initialization of a project to the
creation of the static content, can be summed up to:
1.
Create project (its name could be specific according to the case)
1.
Enable the GitLab Pages feature under the project's settings
1.
Provide a specific job in
`.gitlab-ci.yml`
1.
GitLab Runner builds the project
1.
GitLab CI uploads the artifacts
1.
Nginx serves the content
As a user, you should normally be concerned only with the first three 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.
In general there are four kinds of pages one might create. This is better
explained with an example so let's make some assumptions.
...
...
@@ -68,6 +69,13 @@ To make use of GitLab Pages, your `.gitlab-ci.yml` must follow the rules below:
1.
Any static content must be placed under a
`public/`
directory
1.
`artifacts`
with a path to the
`public/`
directory must be defined
Be aware that Pages are by default branch/tag agnostic and their deployment
relies solely on what you specify in
`gitlab-ci.yml`
. If you don't limit the
`pages`
job with the
[
`only` parameter
](
../ci/yaml/README.md#only-and-except
)
,
whenever a new commit is pushed to whatever branch or tag, the Pages will be
overwritten. In the examples below, we limit the Pages to be deployed whenever
a commit is pushed only on the
`master`
branch, which is advisable to do so.
The pages are created after the build completes successfully and the artifacts
for the
`pages`
job are uploaded to GitLab.
...
...
@@ -84,6 +92,8 @@ pages:
artifacts
:
paths
:
-
public
only
:
-
master
```
## Example projects
...
...
@@ -101,10 +111,9 @@ in the artifacts.
## Frequently Asked Questions
**Q:
**
Can I download my generated pages?
**Q:
Can I download my generated pages?**
**A:**
Sure. All you need to do is download the artifacts archive from the
build page.
Sure. All you need to do is download the artifacts archive from the build page.
---
...
...
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