From e18299e0d41d94ad8ad4a3a115903e2c633e1cb9 Mon Sep 17 00:00:00 2001 From: Wolfgang Knopki Date: Tue, 7 Jul 2020 11:58:06 +0000 Subject: [PATCH] Update README.md --- README.md | 55 ++++++++++--------------------------------------------- 1 file changed, 10 insertions(+), 45 deletions(-) diff --git a/README.md b/README.md index 0a36586..a1e88ea 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -![Build Status](https://gitlab.com/pages/plain-html/badges/master/build.svg) + --- @@ -9,59 +9,24 @@ documentation https://docs.gitlab.com/ce/user/project/pages/. --- - - -**Table of Contents** *generated with [DocToc](https://github.com/thlorenz/doctoc)* - -- [GitLab CI](#gitlab-ci) -- [GitLab User or Group Pages](#gitlab-user-or-group-pages) -- [Did you fork this project?](#did-you-fork-this-project) -- [Troubleshooting](#troubleshooting) - - - ## GitLab CI This project's static Pages are built by [GitLab CI][ci], following the steps defined in [`.gitlab-ci.yml`](.gitlab-ci.yml): ``` -image: alpine:latest +variables: + EXPORT_DIR: "/var/www/html/pages" -pages: +pages-master: stage: deploy script: - - echo 'Nothing to do...' - artifacts: - paths: - - public - only: - - master + - mkdir "$EXPORT_DIR/$CI_PROJECT_NAME" + - cp -r public/* "$EXPORT_DIR/$CI_PROJECT_NAME" + tags: + - production + only: + - master ``` The above example expects to put all your HTML files in the `public/` directory. - -## GitLab User or Group Pages - -To use this project as your user/group website, you will need one additional -step: just rename your project to `namespace.gitlab.io`, where `namespace` is -your `username` or `groupname`. This can be done by navigating to your -project's **Settings**. - -Read more about [user/group Pages][userpages] and [project Pages][projpages]. - -## Did you fork this project? - -If you forked this project for your own use, please go to your project's -**Settings** and remove the forking relationship, which won't be necessary -unless you want to contribute back to the upstream project. - -## Troubleshooting - -1. CSS is missing! That means that you have wrongly set up the CSS URL in your - HTML files. Have a look at the [index.html] for an example. - -[ci]: https://about.gitlab.com/gitlab-ci/ -[index.html]: https://gitlab.com/pages/plain-html/blob/master/public/index.html -[userpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#user-or-group-pages -[projpages]: https://docs.gitlab.com/ce/user/project/pages/introduction.html#project-pages -- GitLab