ilot-io/README.md

ilot.io

Upstream: https://lab.ilot.io/ilot/ilot.io

Description

This repository contains the source code to the ilot.io website.

GitLab CI

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

We are using a theme based on Bootstrap 3 using submodules.

Building locally

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

1. Fork, clone or download this project
2. Install ikiwiki:
   • mac
   • linux
   • source
3. Clone the submodules: git submodule init && git submodule update
4. Generate the website: ikiwiki --setup ikiwiki.setup
5. Preview your project: open public/index.html in a browser

Note that the link to certain objects (like images, css) will be broken when testing locally. To test a specific page, please add <base href="/full/path/to/public" /> at the top of the html file that you want to preview. You may have to adjust absolute links to point to relative links (i.e, make / into ./).

Read more at ikiwiki's documentation.

Contributing

1. Fork the main ilot.io repo.

2. Checkout the forked repository.

   • git clone ssh://git@lab.ilot.io/$USER/ilot.io
   • cd ilot.io

3. Make your changes.

4. Do local build.

   • ikiwiki --setup ikiwiki.setup

5. Fix any errors that come up and rebuild until it works locally.

6. Commit the changes to the git repo in a git branch

   • git checkout -b <name>
   • git add changes
   • git commit -m 'content/index: descriptive description'
   • git push

7. Create a merge request with your changes by following link in server response.

8. Once the tests in the merge-request pass, and reviewers are happy, your changes will be merged.