kotovalexarian-likes-gitlab/gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity
gitlab-org--gitlab-foss/doc/user/project/pages/getting_started_part_one.md

103 lines
4.7 KiB
Markdown
Raw Normal View History

Update all articles with the new layout (meta data from the frontmatter) Context: https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/182
2018-02-16 13:01:35 -05:00
---
Docs: ssot epic - Pages
2019-06-05 16:49:52 -04:00
last_updated: 2018-06-04
type: concepts, reference
Update all articles with the new layout (meta data from the frontmatter) Context: https://gitlab.com/gitlab-com/gitlab-docs/merge_requests/182
2018-02-16 13:01:35 -05:00
---
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
Docs: Pages - clean up articles
2018-02-20 09:57:36 -05:00
# Static sites and GitLab Pages domains
add the "special format" to the only guide we already have in the docs
2017-03-16 16:24:35 -04:00
Refactor intro guide Remove redundancies: - Domains - User/group/project sites
2019-04-11 06:58:06 -04:00
On this docucument, learn how to name your project for GitLab Pages
according to your intended website's URL.
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
Add subgroups limitations to Pages docs
2017-07-16 12:01:11 -04:00
## Static sites
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
GitLab Pages only supports static websites, meaning,
your output files must be HTML, CSS, and JavaScript only.
To create your static site, you can either hardcode in HTML,
CSS, and JS, or use a [Static Site Generator (SSG)](https://www.staticgen.com/)
to simplify your code and build the static site for you,
which is highly recommendable and much faster than hardcoding.
Refactor intro guide Remove redundancies: - Domains - User/group/project sites
2019-04-11 06:58:06 -04:00
See the [further reading](#further-reading) section below for
references on static site concepts.
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
Refactor intro guide Remove redundancies: - Domains - User/group/project sites
2019-04-11 06:58:06 -04:00
## GitLab Pages domain names
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
>**Note:**
If you use your own GitLab instance to deploy your
site with GitLab Pages, check with your sysadmin what's your
Pages wildcard domain. This guide is valid for any GitLab instance,
you just need to replace Pages wildcard domain on GitLab.com
(`*.gitlab.io`) with your own.
Refactor intro guide Remove redundancies: - Domains - User/group/project sites
2019-04-11 06:58:06 -04:00
If you set up a GitLab Pages project on GitLab,
it will automatically be accessible under a
subdomain of `namespace.example.io`.
The [`namespace`](../../group/index.md#namespaces)
is defined by your username on GitLab.com,
or the group name you created this project under.
For GitLab self-managed instances, replace `example.io`
with your instance's Pages domain. For GitLab.com,
Pages domains are `*.gitlab.io`.
| Type of GitLab Pages | The name of the project created in GitLab | Website URL |
| -------------------- | ------------ | ----------- |
| User pages | `username.example.io` | `http(s)://username.example.io` |
| Group pages | `groupname.example.io` | `http(s)://groupname.example.io` |
| Project pages owned by a user | `projectname` | `http(s)://username.example.io/projectname` |
| Project pages owned by a group | `projectname` | `http(s)://groupname.example.io/projectname`|
| Project pages owned by a subgroup | `subgroup/projectname` | `http(s)://groupname.example.io/subgroup/projectname`|
CAUTION: **Warning:**
There are some known [limitations](introduction.md#limitations)
regarding namespaces served under the general domain name and HTTPS.
Make sure to read that section.
update links
2017-09-27 17:53:22 -04:00
Refactor intro guide Remove redundancies: - Domains - User/group/project sites
2019-04-11 06:58:06 -04:00
To understand Pages domains clearly, read the examples below.
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
Refactor intro guide Remove redundancies: - Domains - User/group/project sites
2019-04-11 06:58:06 -04:00
### Project website examples
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
- You created a project called `blog` under your username `john`,
Ensure all lists are surrounded by new lines Markdown renderers find it easier to determine where lists start and end when lists are surrounded by new lines. For consistency, also ensure entries in the list are aligned when they span multipls lines.
2019-02-22 08:17:10 -05:00
therefore your project URL is `https://gitlab.com/john/blog/`.
Once you enable GitLab Pages for this project, and build your site,
it will be available under `https://john.gitlab.io/blog/`.
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
- You created a group for all your websites called `websites`,
Ensure all lists are surrounded by new lines Markdown renderers find it easier to determine where lists start and end when lists are surrounded by new lines. For consistency, also ensure entries in the list are aligned when they span multipls lines.
2019-02-22 08:17:10 -05:00
and a project within this group is called `blog`. Your project
URL is `https://gitlab.com/websites/blog/`. Once you enable
GitLab Pages for this project, the site will live under
`https://websites.gitlab.io/blog/`.
Enable Gitlab-Pages for subgroups GitLab Pages supports projects hosted under a subgroup, but not subgroup websites. That means that only the highest-level group supports i.e.: You created a group for your engineering department called `engineering`, a subgroup for all your documentation websites called `docs`,and a project within this subgroup is called `workflows`. Your project URL is `https://gitlab.com/engineering/docs/workflows/`. Once you enable GitLab Pages for this project, the site will live under `https://engineering.gitlab.io/docs/workflows`.
2018-12-03 06:05:38 -05:00
- You created a group for your engineering department called `engineering`,
Ensure all lists are surrounded by new lines Markdown renderers find it easier to determine where lists start and end when lists are surrounded by new lines. For consistency, also ensure entries in the list are aligned when they span multipls lines.
2019-02-22 08:17:10 -05:00
a subgroup for all your documentation websites called `docs`,
and a project within this subgroup is called `workflows`. Your project
URL is `https://gitlab.com/engineering/docs/workflows/`. Once you enable
GitLab Pages for this project, the site will live under
`https://engineering.gitlab.io/docs/workflows`.
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
Refactor intro guide Remove redundancies: - Domains - User/group/project sites
2019-04-11 06:58:06 -04:00
### User and Group website examples
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
- Under your username, `john`, you created a project called
Ensure all lists are surrounded by new lines Markdown renderers find it easier to determine where lists start and end when lists are surrounded by new lines. For consistency, also ensure entries in the list are aligned when they span multipls lines.
2019-02-22 08:17:10 -05:00
`john.gitlab.io`. Your project URL will be `https://gitlab.com/john/john.gitlab.io`.
Once you enable GitLab Pages for your project, your website
will be published under `https://john.gitlab.io`.
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
- Under your group `websites`, you created a project called
Ensure all lists are surrounded by new lines Markdown renderers find it easier to determine where lists start and end when lists are surrounded by new lines. For consistency, also ensure entries in the list are aligned when they span multipls lines.
2019-02-22 08:17:10 -05:00
`websites.gitlab.io`. your project's URL will be `https://gitlab.com/websites/websites.gitlab.io`.
Once you enable GitLab Pages for your project,
your website will be published under `https://websites.gitlab.io`.
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
**General example:**
- On GitLab.com, a project site will always be available under
Ensure all lists are surrounded by new lines Markdown renderers find it easier to determine where lists start and end when lists are surrounded by new lines. For consistency, also ensure entries in the list are aligned when they span multipls lines.
2019-02-22 08:17:10 -05:00
`https://namespace.gitlab.io/project-name`
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
- On GitLab.com, a user or group website will be available under
Ensure all lists are surrounded by new lines Markdown renderers find it easier to determine where lists start and end when lists are surrounded by new lines. For consistency, also ensure entries in the list are aligned when they span multipls lines.
2019-02-22 08:17:10 -05:00
`https://namespace.gitlab.io/`
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
- On your GitLab instance, replace `gitlab.io` above with your
Ensure all lists are surrounded by new lines Markdown renderers find it easier to determine where lists start and end when lists are surrounded by new lines. For consistency, also ensure entries in the list are aligned when they span multipls lines.
2019-02-22 08:17:10 -05:00
Pages server domain. Ask your sysadmin for this information.
Move all Pages related content to a single location
2017-02-28 07:21:30 -05:00
Docs: Pages - clean up articles
2018-02-20 09:57:36 -05:00
_Read on about [Projects for GitLab Pages and URL structure](getting_started_part_two.md)._
Refactor intro guide Remove redundancies: - Domains - User/group/project sites
2019-04-11 06:58:06 -04:00
### Further reading
- Read through this technical overview on [Static versus Dynamic Websites](https://about.gitlab.com/2016/06/03/ssg-overview-gitlab-pages-part-1-dynamic-x-static/)
- Understand [how modern Static Site Generators work](https://about.gitlab.com/2016/06/10/ssg-overview-gitlab-pages-part-2/) and what you can add to your static site
- You can use [any SSG with GitLab Pages](https://about.gitlab.com/2016/06/17/ssg-overview-gitlab-pages-part-3-examples-ci/)
- Fork an [example project](https://gitlab.com/pages) to build your website based upon
Copy permalink