QIoT-Project Website Based on Jekyll

Getting Started

These instructions will get you a copy of the qiot-project.github.io website up and running on your local machine for development and testing purposes.

Installation

Jekyll static site generator docs.

1. Fork the project repository, then clone your fork:

      git clone git@github.com:YOUR_USER_NAME/qiotio.github.io.git

2. Change into the project directory:

      cd qiot-project.github.io

3a. Pull and Run the containerized version of the ruby bundler and jekyll runtime to install the required gems locally and run the jekyll server, using the docker-compose file provided by the community:

        docker-compose up

3b. Pull and Run the jekyll container manually:

        docker run --rm \
                --volume="$PWD:/srv/jekyll:Z" \
                --publish [::1]:4000:4000 \
                jekyll/jekyll \
                jekyll serve

7. Now browse to http://localhost:4000

If you encounter any unexpected errors during the above, please refer to the troubleshooting page or the requirements page, as you might be missing development headers or other prerequisites.

For more regarding the use of Jekyll, please refer to the Jekyll Step by Step Tutorial.

Deploying to Github Pages

The website deployment is automatically performed by GitHub Actions (when commits are pushed to the develop branch). If for some reason you need to deploy from your local machine, follow these instructions:

1. Install the act executable to run GitHub Actions locally
2. Run act -s GITHUB_TOKEN=<GITHUB_TOKEN>, where <GITHUB_TOKEN> needs to be replaced with a token that allows you to push to the https://github.com/qiot-project/qiotio.github.io repository.

Writing a blog

To write a blog:

• create an author entry in _data/authors.yaml
  • emailhash is used to fetch your picture form the Gravatar service
• create an blog entry under _posts -the file name is yyyy-mm-dd-slug.adoc
• category must be blog. Other categories reserved to the project team you want to be aware of:
  • announcement - official project announcements
  • project - QIoT subprojects
  • usecase - Posts documenting the QIoT use-cases
• tags should be used with some care as an archive page is created for of them. Below are some basic rules to try follow:
  • add a tech specific, like kafka, if your post has a significant mention/relevance to that technology.
  • tags is space separated list tags:extension grpc
  • tags must be in lowercase
• it's in asciidoc format, there is an example as shown with 2021-03-17-quarkus-native-on-a-raspberry-pi.adoc
  • Be aware that the date attribute in the asciidoc preamble defines when the article will be published. Use a present date while writing your article to test locally, then switch to the actual target date before submitting.
• send a pull request against the develop branch and voilà

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

License

This website is licensed under the Creative Commons Attribution 3.0.

Get in touch with the QIoT Team:

Website: qiot-project.github.io

Email: qiotproject@google.com

Mailing list: qiotproject@googlegroups.com

Twitter: @qiotproject

Slack:

Weekly meeting: