diff --git a/README.md b/README.md index af49be3..3acc553 100644 --- a/README.md +++ b/README.md @@ -1,99 +1,71 @@ -![Build Status](https://gitlab.com/pages/ikiwiki/badges/master/build.svg) +# ilot.io +Upstream: https://lab.ilot.io/ilot/ilot.io ---- +![Build Status](https://lab.ilot.io/ilot/ilot.io/badges/main/pipeline.svg) -Example [ikiwiki] website using GitLab Pages. -Learn more about GitLab Pages at https://pages.gitlab.io and the official -documentation https://docs.gitlab.com/ce/user/project/pages/. +## Description ---- - - - -**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) - - +This repository contains the source code to the [ilot.io](https://ilot.io) +website. ## GitLab CI This project's static Pages are built by [GitLab CI][ci], following the steps defined in [`.gitlab-ci.yml`](.gitlab-ci.yml): -```yaml -image: elecnix/ikiwiki - -before_script: - - apt-get install -y git - - git submodule init - - git submodule update - -test: - stage: test - script: - - ikiwiki --setup ikiwiki.setup --libdir themes/ikistrap/lib - only: - - branches - - tags - -pages: - stage: deploy - script: - - ikiwiki --setup ikiwiki.setup --libdir themes/ikistrap/lib - artifacts: - paths: - - public - only: - - master -``` - -We are using a theme based on Bootstrap 4 using submodules, and in order to -enable the theme plugin, we must pass the `libdir` parameter. +We are using a theme based on +[Bootstrap 3](https://lab.ilot.io/ilot/ikiwiki-bootstrap-ilot) 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 -1. [Install][] ikiwiki +1. Install ikiwiki: + * [mac][] + * [linux][] + * [source][] 1. Clone the submodules: `git submodule init && git submodule update` -1. Generate the website: `ikiwiki --setup .ikiwiki/ikiwiki.setup --libdir themes/ikistrap/lib` +1. Generate the website: `ikiwiki --setup ikiwiki.setup` 1. Preview your project: open `public/index.html` in a browser Read more at ikiwiki's [documentation][]. -## GitLab User or Group Pages +## Contributing -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**. +1. Fork the main ilot.io repo. -Read more about [user/group Pages][userpages] and [project Pages][projpages]. +2. Checkout the forked repository. -## Did you fork this project? + - `git clone ssh://git@lab.ilot.io/$USER/ilot.io` + - `cd ilot.io` -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. +3. Make your changes. -## Troubleshooting +4. Do local build. -1. CSS is missing! That means two things: + - `ikiwiki --setup ikiwiki.setup` - 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. +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 ` + - `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. [ci]: https://about.gitlab.com/gitlab-ci/ [ikiwiki]: https://ikiwiki.info/ -[install]: https://ikiwiki.info/install/ +[source]: https://ikiwiki.info/install/ +[linux]: https://ikiwiki.info/setup/ +[mac]: https://ikiwiki.info/tips/ikiwiki_on_mac_os_x/ [documentation]: https://ikiwiki.info/ [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