Commit 8b201fed authored by Fredy PULIDO's avatar Fredy PULIDO
Browse files

jekyll: improves documentation

* Names match gitlab menu names
* Detailed gitlab pages configuration
* Order match gitlab menu order (for conf)
parent 68bc4c4f
......@@ -85,13 +85,18 @@ Neither of this repositories supposed to have a `.gitlab-ci.yml` file. If your p
### Primary project configuration
* Create (from `master`) a new branch named `production`
* Repository / Branches:
* Create (from `master`) a new branch named `production`
* Settings / General / Visibility, project features, permissions / Pages
* Enabled: **Everyone**
* Settings / General / Merge requests / Merge method:
* `Fast-forward merge` (clean git log, avoid braking repo)
* Settings / General / Merge requests / Merge checks:
* Pipelines must succeed
* Settings / Members:
* Developer: for content or code developers
* Maintainer(or owner): for the project manager
* Note: giving maintainer or owner to content or theme developers give to them the power to destroy the repository by accident. Please do not do it.
* Settings / Repository / Protected Branches:
* `master` (default)
* Allowed to merge: `Developers + Maintainers`
......@@ -101,22 +106,26 @@ Neither of this repositories supposed to have a `.gitlab-ci.yml` file. If your p
* Allowed to push: `No one`
* Settings / CI-CD / General pipelines / Custom CI configuration path:
* `ci-jekyll-gl_pages-primary.yml@publicgroup/templates/gitlab-ci-yml`
* Settings / CI-CD / Variables :
* Settings / CI-CD / Variables:
* CI_SECONDARY_PROJECT_ID:
* Value: Get from the **secondary project** [General Settings](https://docs.gitlab.com/ee/user/project/settings/index.html#general-settings)
* Project Members:
* Developer: for content or code developers
* Maintainer(or owner): for the project manager
* Note: giving maintainer or owner to content or theme developers give to them the power to destroy the repository by accident. Please do not do it.
* Settings / Pages / New Domain
* Domain: www.example.com (replace with your domain name)
* Automatic certificate management using Let's Encrypt: Enabled
* Note: After you clik "Create New Domain" button the **DNS** fiels will appear.
* Copy it and ask the domain name administrator (usally IT) to create that record.
* `Warning`: Do not forget to click the "Save Changes" green button.
* Note: If your domain provider offer http redirections (gandi.net does) create on for example.com. If it does not offer it then do this same process for example.com.
### Secondary project configuration
* Ensure that `master` is the only branch in this project
* Ensure that `master` only contains a `README.md` file with this content:
* `WARNING: Read [README-jekyll.md](https://ci.linagora.com/publicgroup/templates/gitlab-ci-yml/blob/master/README-jekyll.md) before to do anything.`
* Repository / Branches:
* Ensure that `master` is the only branch in this project.
* Repository / Files:
* Ensure that `master` only contains a `README.md` file with this content:
* `WARNING: Read [README-jekyll.md](https://ci.linagora.com/publicgroup/templates/gitlab-ci-yml/blob/master/README-jekyll.md) before to do anything.`
* Settings / General / Visibility, project features, permissions / Pages
* Enabled: **Only Project Members**
* Enabled: `Only Project Members`
* Settings / General / Merge requests / Merge method:
* `Fast-forward merge` (clean git log, avoid braking repo)
* Settings / Repository / Protected Branches:
......@@ -125,9 +134,13 @@ Neither of this repositories supposed to have a `.gitlab-ci.yml` file. If your p
* Allowed to push: `No one`
* Settings / CI-CD / General pipelines / Custom CI configuration path:
* `ci-jekyll-gl_pages-secondary.yml@publicgroup/templates/gitlab-ci-yml`
* Settings / Pages / New Domain
* Domain: pre-www.example.com (replace with your domain name, keep the "pre-")
* Automatic certificate management using Let's Encrypt: Enabled
* Note: After you clik "Create New Domain" button the **DNS** fiels will appear.
* Copy it and ask the domain name administrator (usally IT) to create that record.
* `Warning`: Do not forget to click the "Save Changes" green button.
### GitLab Pages configuration
* Read [GitLab pages custom domains configuration](https://docs.gitlab.com/ee/user/project/pages/custom_domains_ssl_tls_certification/index.html#set-up-pages-with-a-custom-domain)
* Ask IT to create the required domains for each environment.
## Jekyll tips
* [Matomo configuration reference](https://ci.linagora.com/linagora/organization/expertise-libre.fr/commit/b90a9faf0828b1db551e30d771dc9938b2e0104d)
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