Commit eedcbab8 authored by ngaskill's avatar ngaskill

Removing notes from Pages docs

parent dcc29126
...@@ -61,7 +61,6 @@ according to the type of domain you want to use with your Pages site: ...@@ -61,7 +61,6 @@ according to the type of domain you want to use with your Pages site:
- [For subdomains](#for-subdomains), `subdomain.example.com`. - [For subdomains](#for-subdomains), `subdomain.example.com`.
- [For both](#for-both-root-and-subdomains). - [For both](#for-both-root-and-subdomains).
NOTE: **Note:**
You can [configure IPv6 on self-managed instances](../../../../administration/pages/index.md#advanced-configuration), You can [configure IPv6 on self-managed instances](../../../../administration/pages/index.md#advanced-configuration),
but IPv6 is not currently configured for Pages on GitLab.com. but IPv6 is not currently configured for Pages on GitLab.com.
Follow [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/214718) for details. Follow [this issue](https://gitlab.com/gitlab-org/gitlab/-/issues/214718) for details.
...@@ -250,8 +249,8 @@ You can use any certificate satisfying the following requirements: ...@@ -250,8 +249,8 @@ You can use any certificate satisfying the following requirements:
- **A private key**, it's an encrypted key which validates - **A private key**, it's an encrypted key which validates
your PEM against your domain. your PEM against your domain.
NOTE: **Note:** For example, [Cloudflare certificates](https://about.gitlab.com/blog/2017/02/07/setting-up-gitlab-pages-with-cloudflare-certificates/)
[Cloudflare certificates](https://about.gitlab.com/blog/2017/02/07/setting-up-gitlab-pages-with-cloudflare-certificates/), for example, meet these requirements. meet these requirements.
#### Steps #### Steps
...@@ -269,7 +268,6 @@ NOTE: **Note:** ...@@ -269,7 +268,6 @@ NOTE: **Note:**
just jumping a line between them. just jumping a line between them.
1. Copy your private key and paste it in the last field. 1. Copy your private key and paste it in the last field.
NOTE: **Note:**
**Do not** open certificates or encryption keys in **Do not** open certificates or encryption keys in
regular text editors. Always use code editors (such as regular text editors. Always use code editors (such as
Sublime Text, Atom, Dreamweaver, Brackets, etc). Sublime Text, Atom, Dreamweaver, Brackets, etc).
...@@ -290,8 +288,8 @@ To enable this setting: ...@@ -290,8 +288,8 @@ To enable this setting:
1. Navigate to your project's **Settings > Pages**. 1. Navigate to your project's **Settings > Pages**.
1. Tick the checkbox **Force HTTPS (requires valid certificates)**. 1. Tick the checkbox **Force HTTPS (requires valid certificates)**.
NOTE: **Note:** If you use Cloudflare CDN in front of GitLab Pages, make sure to set the SSL connection setting to
If you use Cloudflare CDN in front of GitLab Pages, make sure to set the SSL connection setting to `full` instead of `flexible`. For more details, see the [Cloudflare CDN directions](https://support.cloudflare.com/hc/en-us/articles/200170416-End-to-end-HTTPS-with-Cloudflare-Part-3-SSL-options#h_4e0d1a7c-eb71-4204-9e22-9d3ef9ef7fef). `full` instead of `flexible`. For more details, see the [Cloudflare CDN directions](https://support.cloudflare.com/hc/en-us/articles/200170416-End-to-end-HTTPS-with-Cloudflare-Part-3-SSL-options#h_4e0d1a7c-eb71-4204-9e22-9d3ef9ef7fef).
<!-- ## Troubleshooting <!-- ## Troubleshooting
......
...@@ -33,7 +33,6 @@ Before you can enable automatic provisioning of an SSL certificate for your doma ...@@ -33,7 +33,6 @@ Before you can enable automatic provisioning of an SSL certificate for your doma
and verified your ownership. and verified your ownership.
- Verified your website is up and running, accessible through your custom domain. - Verified your website is up and running, accessible through your custom domain.
NOTE: **Note:**
GitLab's Let's Encrypt integration is enabled and available on GitLab.com. GitLab's Let's Encrypt integration is enabled and available on GitLab.com.
For **self-managed** GitLab instances, make sure your administrator has For **self-managed** GitLab instances, make sure your administrator has
[enabled it](../../../../administration/pages/index.md#lets-encrypt-integration). [enabled it](../../../../administration/pages/index.md#lets-encrypt-integration).
......
...@@ -11,12 +11,9 @@ according to your intended website's URL. ...@@ -11,12 +11,9 @@ according to your intended website's URL.
## GitLab Pages default domain names ## GitLab Pages default domain names
NOTE: **Note:** If you use your own GitLab instance to deploy your site with GitLab Pages, verify your Pages
If you use your own GitLab instance to deploy your wildcard domain with your sysadmin. This guide is valid for any GitLab instance, provided that you
site with GitLab Pages, check with your sysadmin what's your replace the Pages wildcard domain on GitLab.com (`*.gitlab.io`) with your own.
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.
If you set up a GitLab Pages project on GitLab, If you set up a GitLab Pages project on GitLab,
it will automatically be accessible under a it will automatically be accessible under a
......
...@@ -259,9 +259,8 @@ instead. Here are some examples of what will happen given the above Pages site: ...@@ -259,9 +259,8 @@ instead. Here are some examples of what will happen given the above Pages site:
| `/other/index` | `200 OK` | `public/other/index.html` | | `/other/index` | `200 OK` | `public/other/index.html` |
| `/other/index.html` | `200 OK` | `public/other/index.html` | | `/other/index.html` | `200 OK` | `public/other/index.html` |
NOTE: **Note:** Note that when `public/data/index.html` exists, it takes priority over the `public/data.html` file
When `public/data/index.html` exists, it takes priority over the `public/data.html` for both the `/data` and `/data/` URL paths.
file for both the `/data` and `/data/` URL paths.
## Frequently Asked Questions ## Frequently Asked Questions
......
...@@ -33,9 +33,8 @@ To follow along with this tutorial, we assume you already have: ...@@ -33,9 +33,8 @@ To follow along with this tutorial, we assume you already have:
Once you have the requirements addressed, follow the instructions Once you have the requirements addressed, follow the instructions
below to learn how to obtain the certificate. below to learn how to obtain the certificate.
NOTE: **Note:** Note that these instructions were tested on macOS Mojave. For other operating systems the steps
The instructions below were tested on macOS Mojave. For other might be slightly different. Follow the
operating systems the steps might be slightly different. Follow the
[CertBot instructions](https://certbot.eff.org/) according to your OS. [CertBot instructions](https://certbot.eff.org/) according to your OS.
1. On your computer, open a terminal and navigate to your repository's 1. On your computer, open a terminal and navigate to your repository's
......
...@@ -20,11 +20,9 @@ on your GitLab instance. When enabled, only ...@@ -20,11 +20,9 @@ on your GitLab instance. When enabled, only
For a demonstration, see [Pages access controls](https://www.youtube.com/watch?v=tSPAr5mQYc8). For a demonstration, see [Pages access controls](https://www.youtube.com/watch?v=tSPAr5mQYc8).
1. Navigate to your project's **Settings > General** and expand **Visibility, project features, permissions**. 1. Navigate to your project's **Settings > General** and expand **Visibility, project features, permissions**.
1. Toggle the **Pages** button to enable the access control.
NOTE: **Note:** 1. Toggle the **Pages** button to enable the access control. If you don't see the toggle button,
If you don't see the toggle button, that means that it's not enabled. that means it isn't enabled. Ask your administrator to [enable it](../../../administration/pages/index.md#access-control).
Ask your administrator to [enable it](../../../administration/pages/index.md#access-control).
1. The Pages access control dropdown allows you to set who can view pages hosted 1. The Pages access control dropdown allows you to set who can view pages hosted
with GitLab Pages, depending on your project's visibility: with GitLab Pages, depending on your project's visibility:
......
...@@ -22,8 +22,10 @@ GitLab Pages only supports the ...@@ -22,8 +22,10 @@ GitLab Pages only supports the
[`_redirects` plain text file syntax](https://docs.netlify.com/routing/redirects/#syntax-for-the-redirects-file), [`_redirects` plain text file syntax](https://docs.netlify.com/routing/redirects/#syntax-for-the-redirects-file),
and `.toml` files are not supported. and `.toml` files are not supported.
Redirects are only supported at a basic level, and GitLab Pages doesn't support all Redirects are only supported at a basic level. GitLab Pages doesn't support all
[special options offered by Netlify](https://docs.netlify.com/routing/redirects/redirect-options/): [special options offered by Netlify](https://docs.netlify.com/routing/redirects/redirect-options/).
Note that supported paths must start with a forward slash `/`.
| Feature | Supported | Example | | Feature | Supported | Example |
| ------- | --------- | ------- | | ------- | --------- | ------- |
...@@ -37,9 +39,6 @@ Redirects are only supported at a basic level, and GitLab Pages doesn't support ...@@ -37,9 +39,6 @@ Redirects are only supported at a basic level, and GitLab Pages doesn't support
| Redirect by country or language | **{dotted-circle}** No | `/ /anz 302 Country=au,nz` | | Redirect by country or language | **{dotted-circle}** No | `/ /anz 302 Country=au,nz` |
| Redirect by role | **{dotted-circle}** No | `/admin/* 200! Role=admin` | | Redirect by role | **{dotted-circle}** No | `/admin/* 200! Role=admin` |
NOTE: **Note:**
Supported paths must start with a forward slash `/`.
## Create redirects ## Create redirects
To create redirects, To create redirects,
...@@ -78,8 +77,7 @@ is ignored because `hello.html` exists: ...@@ -78,8 +77,7 @@ is ignored because `hello.html` exists:
/projectname/hello.html /projectname/world.html 302 /projectname/hello.html /projectname/world.html 302
``` ```
NOTE: **Note:** GitLab doesn't support Netlify's
GitLab does not support Netlify's
[force option](https://docs.netlify.com/routing/redirects/rewrites-proxies/#shadowing) [force option](https://docs.netlify.com/routing/redirects/rewrites-proxies/#shadowing)
to change this behavior. to change this behavior.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment