summaryrefslogtreecommitdiff
path: root/doc/user/project/pages/getting_started/pages_forked_sample_project.md
blob: b43af2f0efe8c4f930e141564bf01c0f693b8e2a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
---
type: reference, howto
stage: Release
group: Release
info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
---

# Create a Pages website from a forked sample **(FREE)**

GitLab provides [sample projects for the most popular Static Site Generators (SSG)](https://gitlab.com/pages).
You can fork one of the sample projects and run the CI/CD pipeline to generate a Pages website.

Fork a sample project when you want to test GitLab Pages or start a new project that's already
configured to generate a Pages site.

<i class="fa fa-youtube-play youtube" aria-hidden="true"></i> Watch a [video tutorial](https://www.youtube.com/watch?v=TWqh9MtT4Bg) of how this works.

To fork a sample project and create a Pages website:

1. View the sample projects by navigating to the [GitLab Pages examples](https://gitlab.com/pages) group.
1. Select the name of the project you want to [fork](../../repository/forking_workflow.md#creating-a-fork).
1. In the top right, select **Fork** and then choose a namespace to fork to.
1. For your project, on the left sidebar, select **CI/CD > Pipelines** and then **Run pipeline**.
   GitLab CI/CD builds and deploys your site.

The site can take approximately 30 minutes to deploy.
When the pipeline is finished, go to **Settings > Pages** to find the link to your website from your project.

For every change pushed to your repository, GitLab CI/CD runs a new pipeline
that immediately publishes your changes to the Pages site.

You can take some **optional** further steps:

- Remove the fork relationship. If you want to contribute to the project you forked from,
  you can keep this relationship. Otherwise, go to your project's **Settings > General**,
  expand **Advanced settings**, and scroll down to **Remove fork relationship**:

  ![Remove fork relationship](../img/remove_fork_relationship_v13_1.png)

- Change the URL to match your namespace. If your Pages site is hosted on GitLab.com,
  you can rename it to `<namespace>.gitlab.io`, where `<namespace>` is your GitLab namespace
  (the one you chose when you forked the project).

  - Go to your project's **Settings > General** and expand **Advanced**. Scroll down to
    **Change path** and change the path to `<namespace>.gitlab.io`.

    For example, if your project's URL is `gitlab.com/gitlab-tests/jekyll`, your namespace is
    `gitlab-tests`.

    If you set the repository path to `gitlab-tests.gitlab.io`,
    the resulting URL for your Pages website is `https://gitlab-tests.gitlab.io`.

    ![Change repository's path](../img/change_path_v12_10.png)

  - Now go to your SSG's configuration file and change the [base URL](../getting_started_part_one.md#urls-and-base-urls)
    from `"project-name"` to `""`. The project name setting varies by SSG and may not be in the configuration file.