CONTRIBUTING.md 5.01 KB

Table of Contents generated with DocToc

Adding a new site example

The steps to add a new static site example are:

  1. Create a new project named after the static generator (lowercase)
  2. Add a project description which must follow the schema:

    Example <Name> site using GitLab Pages: https://pages.gitlab.io/<name>

    where <Name> is the name of the static generator and the URL's <name> is taken after the project's name.

  3. Add a README.md that has specific information, according to the README template

  4. Add a new issue to https://gitlab.com/pages/pages.gitlab.io/issues, containing:

    • SSG name / website
    • Your working example: project url / website url
    • Yours (optional) and the SSG's Twitter handle (we'll thank you for contributing!)

README template

The README.md file must contain the following information in this order:

  1. Link to the build status badge
  2. Introduction: what this project is about, provide links to:
    1. Official project main page
    2. https://pages.gitlab.io
    3. Pages documentation http://doc.gitlab.com/ee/pages/README.html
  3. Building locally
    1. Install requirements
    2. Run local server if any
  4. GitLab CI
  5. Difference between user/project Pages
    • How to convert to user Pages
  6. Did you fork this project?
    • Remove fork relationship

Use the following text as a base and build upon it:

![Build Status](https://gitlab.com/pages/<project>/badges/master/build.svg)

---

Example [<Project>] website using GitLab Pages.

Learn more about GitLab Pages at https://pages.gitlab.io and the official
documentation http://doc.gitlab.com/ee/pages/README.html.

---

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*

- [GitLab CI](#gitlab-ci)
- [Building locally](#building-locally)
- [GitLab User or Group Pages](#gitlab-user-or-group-pages)
- [Did you fork this project?](#did-you-fork-this-project)
- [Troubleshooting](#troubleshooting)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## GitLab CI

This project's static Pages are built by [GitLab CI][ci], following the steps
defined in [`.gitlab-ci.yml`](.gitlab-ci.yml):

contents of .gitlab-ci.yml in codeblock

## Building locally

To work locally with this project, you'll have to follow the steps below:

1. Fork, clone or download this project
1. [Install][] <project>
1. Generate the website: `make html`
1. Preview your project: `make serve`
1. Add content

Read more at <Project>'s [documentation][].

## 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 two things:

    Either that you have wrongly set up the CSS URL in your templates, or
    your static generator has a configuration option that needs to be explicitly
    set in order to serve static assets under a relative URL.

[ci]: https://about.gitlab.com/gitlab-ci/
[<project>]: http://link-to-project-main-page
[install]: http://link-to-install-page
[documentation]: http://link-to-main-documentation-page
[userpages]: http://doc.gitlab.com/ee/pages/README.html#user-or-group-pages
[projpages]: http://doc.gitlab.com/ee/pages/README.html#project-pages

----

Forked from @<username>

The changes you'll have to make are:

  1. Replace <project> and <Project> with the project name (tip: use your editor's search and replace function)
  2. Explain the contents of .gitlab-ci.yml
  3. Add some brief steps how to build and hack locally
  4. Replace the links at the bottom of the README to:
    1. [<project>]: The project's homepage
    2. [install]: The project's installation guide
    3. [documentation]: The project's documentation website
    4. <username>: Your username at GitLab
  5. Use doctoc to create or update the Table Of Contents: doctoc --gitlab README.md Make sure that the badge and the project info are on top. See the README template to take an example.

Leave any other information as-is.