/quarkusio.github.io

Website for Quarkus project

Primary LanguageHTML

Quarkus.io Website Based on Jekyll

Getting Started

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

Installation

Using Docker

  1. Install Docker Desktop.

  2. Fork the project repository, then clone your fork.

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

  3. Change into the project directory:

     cd quarkusio.github.io

  4. Run Docker Composer

     docker compose up

    If any error occurs mentioning the name conflict, try

     docker compose up --force-recreate

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

Using a local Ruby environment

Jekyll static site generator docs.

  1. Install a full Ruby development environment. If you use rvm, run: rvm use 3.2.3.

  2. Install bundler gems

     gem install bundler

  3. Fork the project repository, then clone your fork.

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

  4. Change into the project directory:

     cd quarkusio.github.io

  5. Use bundler to fetch all required gems in their respective versions

     bundle install

  6. Build the site and make it available on a local server

     ./serve.sh

    Or if you want it faster and okay to not have guides included use the following:

     ./serve-noguides.sh

  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 main 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/quarkusio/quarkusio.github.io repository.

Writing a blog

To write a blog:

  • create an author entry in _data/authors.yaml

    • emailhash you can get by running echo -n your@email.org | md5sum on Linux or echo -n your@email.org | md5 on macOS using an email you have registered from the Gravatar service,

  • create an blog entry under _posts

    • the file name is yyyy-mm-dd-slug.adoc Set the date to the same value in the asciidoc preamble.

  • tags should be used with some care as an archive page is created for of them. Below are some basic rules to try follow:

    • quarkus-release used for Quarkus release blogs
    • announcement used for general announcement with some impact.
    • extension used for blogs related to a specific extension.
    • user-story used for stories from users/companies adopting Quarkus.
    • development-tips used for blogs with tips to develop using Quarkus or Quarkus itself.
    • 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 2019-06-05-quarkus-and-web-ui-development-mode.adoc

    • Be aware that the date attribute in the asciidoc preamble defines when the article will be published. Add a --future flag when testing locally to ensure the article is included in the generated site.

  • send a pull request against the main branch and voilà

Translations/Localization (l10n)

The primary site (quarkus.io) is written in English.

There are separate repositories for community driven localized versions of quarkus.io:

If you want to contribute to those efforts read the README in those projects. If you would like to start another translation, please open an issue in this main repo.

Enable DNS for l10n site

Once a localized site has enough of its content translated, DNS needs to be enabled. To do that get one of the Red Hat admins to submit a ticket to IT asking for XX domain:

We need a CNAME record set up for XX.quarkus.io to have it serve out GitHub pages. 

The CNAME record for XX.quarkus.io should point to "quarkusio.github.io.".

See Step 5 on https://docs.github.com/en/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site for more information.

Contributing

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

Important: the guides are maintained in the main Quarkus repository and pull requests should be submitted there: https://github.com/quarkusio/quarkus/tree/main/docs/src/main/asciidoc.

License

This website is licensed under the Creative Commons Attribution 3.0.