Millan Kaul

First of all I thank you ❤️ very much for taking the time to contribute (author/co-author a post with me).

You can follow these simple instructions to publish a post for review:

If you have no clue how to write a post, here are all that I have published in markdown format .md files. This has got some examples on how you can add a hero/banner image etc. at the top of your post like this welcome post.

If you decide to add an image, make sure you also upload that under the \assets\images\ folder.

Steps to contribute 🪜

  1. Fork this repository with your GitHub account
    1. If you don’t have a GitHub account, continue reading…
  2. Create a markdown file (.md extension) and put your content in it. All markdown heading, bold, italic, links, code formatting are acceptable.
    1. You can use any IDE to preview your content, or
    2. Use one of the online readme editors or search one on Google to preview your content before sending.
  3. Make sure your post is submitted without a date in your file name.
    1. So that it looks something like this my-first-blog-on-christmas.md (all words in lowercase, separated by hyphens -. No space or special characters please)
    2. Once it’s reviewed, I will add a date in front of it, something like this: YYYY-MM-DD-your-file-name.md (e.g. 2022-12-25-my-first-blog-on-christmas.md)
  4. You can associate your blog with a category
    1. Make sure to pick only one category, looking at the published Categories page
    2. You can add a new category if none of these suits your work: blog, post, tutorial, adventure, travel etc.
  5. You can put multiple tags to your post, ideally limit them from 3 to 5 for a better reader experience.
    1. You can have a look at all published tags here
  6. If you want to run locally follow instructions here or run bundle install followed by bundle exec jekyll serve. Some helpful troubleshooting below.
  7. Or simply run using Docker
    1. Create a Docker image named qwm: docker build -t qwm .
    2. Run the local server docker-compose up or docker run -p 4000:4000 -v "$PWD:/srv/jekyll" qwm jekyll serve --force_polling
    3. Go to http://localhost:4000

If you see some errors:

  • Remove Gemfile.lock
  • run bundle add webrick [ It seems that in the latest version of ruby that is installed with homebrew webrick is not included by default. ]

  • run bundle and again bundle exec jekyll serve.

  • error
    Your user account isn't allowed to install to the system RubyGems. You can cancel this installation and run:

      bundle install --path vendor/bundle

Some tips to format your Blog and images

  1. Once done raise a PR to prod branch, or send me the document(s).

I will ( or you can ) add Author details about yourself in authors.yml file

Finally, once your work (post) is merged. GitHub actions Will auto-pick new files/changes and published it 🚀.

I will keep on improving this document with your feedback.

Once again thank you for your time to sharing Knowledge with the community for free. 🙏

Best

Millan