Skip to content

Latest commit

 

History

History
66 lines (42 loc) · 2.56 KB

CONTRIBUTING.md

File metadata and controls

66 lines (42 loc) · 2.56 KB

Contributing

Pull Requests

Creating a Pull Request

This book has been designed so that people can easily expand it. To request us to review changes that you create, you will need to create a pull request. Creating a pull request is described in this tutorial.

File Location/Types

This directory holds all of the translations of the eBook.

ebook/{LANG}

For English: ebook/en

In the ebook/{LANG} directory we have the translations of the eBook in particular languages.

If you are adding a new translation, make sure to make a copy of the ./ebook/en directory and use the language code as the new directory name.

ebook/{LANG}/assets

For English: ebook/en/assets

All the HTML files and cover image for the 'Introduction to Docker' guide are located within the assets directory.

ebook/{LANG}/content

For English: ebook/en/content

All the Markdown files for the 'Introduction to Docker' guide are located within the content directory for the specific language.

For example, if you are adding a Bulgarian translation, copy the ./ebook/en folder to ./ebook/bg, translate the .md files in the content directory, and submit a PR.

ebook/{LANG}/export

For English: ebook/en/export

Pdf version of 'Introduction to Docker' guide is located within the export directory in both light and dark themes for the specific language.

For example, if you are adding a Bulgarian translation, then ./ebook/bg/export will contain a pdf version of the book in both light and dark themes in Bulgarian.

PDF Generation

The project uses Ibis developed by Mohamed Said.

Make sure to follow the steps on how to get Ibis installed and how to use it here:

Getting started with Ibis

Issue Creation

In the event that you encounter an issue using the guide or have a change that you would like to propose, but do not want to make a contribution, we are more than happy to help. Make sure that when you create your issue, it follows the format for the type of issue you select (it has individual templates for each issue type).

Issue template types include the following:

  • Bug Reporting
  • Feature Requests
  • Help Requests