diff --git a/doc/pages/README.md b/doc/pages/README.md index a4f6eb14156d7bc9a7b17221751f925707327d37..6e748c8228c867c9c6f7f07befb4723cb0df1e8f 100644 --- a/doc/pages/README.md +++ b/doc/pages/README.md @@ -46,6 +46,31 @@ information, if you are using GitLab.com to host your website. +--- + +## Overview + +[GitLab Pages][pages-webpage] is a static site hosting service. It's a free +service at [GitLab.com][com], and available on-premises for [GitLab EE][ee] +instances only. + +You keep your website project in your own GitLab EE instance, build, +test, and deploy it automatically with +[GitLab CI][ci-webpage], and serve it with +[GitLab Pages Server][pages-daemon]. + +GitLab CI can build your site with [any Static Site Generator][ssgs-post-3] +and deploy it to GitLab Pages, which also supports SSL/TLS certificates and custom +domain and subdomain names. + +## Use-cases + +- Host your company's website +- Host your costumers' websites +- Host your team members' websites +- Host different websites for each of your companies' departments +- Use GitLab Pages as **staging** server and [deploy automatically or manually][post-ivan] to your **production** server + ## Getting started with GitLab Pages > **Note:** @@ -461,3 +486,9 @@ For a list of known issues, visit GitLab's [public issue tracker]. [pages-jekyll]: https://gitlab.com/pages/jekyll [metarefresh]: https://en.wikipedia.org/wiki/Meta_refresh [public issue tracker]: https://gitlab.com/gitlab-org/gitlab-ee/issues?label_name=Pages +[pages-webpage]: https://pages/gitlab.io +[ci-webpage]: https://about.gitlab.com/gitlab-ci/ +[ssgs-post-3]: https://about.gitlab.com/2016/06/17/ssg-overview-gitlab-pages-part-3-examples-ci/ +[com]: https://gitlab.com/users/sign_in +[ee]: https://about.gitlab.com/features/#enterprise +[post-ivan]: https://about.gitlab.com/2016/08/18/using-gitlab-labels/ci-deployment-and-environments/