Skip to content

Latest commit

 

History

History
75 lines (50 loc) · 2.25 KB

CONTRIBUTING.md

File metadata and controls

75 lines (50 loc) · 2.25 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

ebook

This directory holds all of the translations of the eBook.

ebook/{LANG}

In the ebook directory we have the translations of the eBook in different 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}/content

All the Markdown files for the '101 Linux commands' eBook 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 Generation

The project uses Ibis Next developed by Roberto Butti, forked from the original Ibis by Mohamed Said.

Ibis Next supports generating PDF, EPUB, and HTML formats from Markdown content.

Setup and Usage

  1. Install dependencies:
composer install
  1. Generate PDF (light theme):
composer run pdf
  1. Generate PDF (dark theme):
composer run pdf-dark
  1. Generate EPUB:
composer run epub
  1. Generate HTML:
composer run html

For more information about Ibis Next, visit: Getting started with Ibis Next

Issue Creation

In the event that you have an issue using the guide or have a suggestion for a change but don't want to contribute changes, 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