Skip to content

Commit

Permalink
finish off the book
Browse files Browse the repository at this point in the history
  • Loading branch information
loftwah committed Aug 19, 2023
1 parent 42c62b8 commit 9dc9c79
Show file tree
Hide file tree
Showing 27 changed files with 73 additions and 3,473 deletions.
151 changes: 2 additions & 149 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,150 +1,3 @@
# Contributing to Linux for Pirates!
# Contrubuting

Thank you for your interest in contributing to the Linux for Pirates! guide! Our mission is to provide a comprehensive and user-friendly resource for learning about the Linux operating system and advancing as a professional in the field. We welcome contributions from individuals of all backgrounds and experience levels.

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
**Table of Contents**

- [Purpose and Goals](#purpose-and-goals)
- [Contributions](#contributions)
- [Process for Accepting Contributions](#process-for-accepting-contributions)
- [Communication and Collaboration](#communication-and-collaboration)
- [Resources for Contributors](#resources-for-contributors)
- [Using Pirate Speak](#using-pirate-speak)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Purpose and Goals

The Linux for Pirates! guide is designed to be a comprehensive and approachable resource for learning about Linux and advancing as a professional in the field. Our goal is to make it easy for individuals of all skill levels, including beginners and experienced users, to learn Linux and apply it in their professional lives. With a focus on Cloud Computing and DevOps, this book will provide you with the knowledge and skills you need to succeed in the Linux job market and secure a job as a Linux administrator.

## Contributions

We welcome a wide range of contributions to Linux for Pirates!, including:

- Writing new content
- Editing existing content
- Providing technical review
- Process for Accepting Contributions

To contribute to Linux for Pirates!, please follow these steps:

- Fork the repository
- Create a new branch for your contribution
- Make your changes and commit them to your branch
- Create an issue for your contribution
- If your issue is accepted, create a pull request for your contribution
- Submit a pull request for review
- We will review your contribution and provide feedback as needed. Once your contribution has been reviewed and accepted, it will be merged into the main branch of the repository.

### Process for Accepting Contributions

To contribute to the Linux for Pirates! guide, please follow these steps:

- Open an issue. Before you start working on a contribution, we recommend opening an issue to discuss it with the team. This will allow us to provide feedback and guidance, and ensure that your contribution is in line with the goals and vision of the project.

> **Note** No pull requests will be accepted without an issue, except in specific cases that will be approved on an ad-hoc basis.
- To open an issue, go to the [issue tracker](https://github.com/loftwah/linux-for-pirates/issues) and click the "New Issue" button. Provide a clear and concise description of your proposed contribution, and any relevant details or questions.

- Fork the repository

A repository is a collection of files that make up the Linux for Pirates! guide. To contribute to the guide, you'll need to create a copy of the repository on your own GitHub account. This is called "forking" the repository.

To fork the repository, go to the main page of the Linux for Pirates! repository on GitHub and click the "Fork" button. This will create a copy of the repository on your own account.

- Clone the repository

Now that you have a copy of the repository on your own account, you'll need to download it to your computer so you can make changes to it. This is called "cloning" the repository.

To clone the repository, open a terminal or command prompt and enter the following command:

```bash
`git clone https://github.com/YOUR-USERNAME/linux-for-pirates.git`
```

Replace `"YOUR-USERNAME"` with your actual GitHub username. This will download the repository to your computer.

- Create a new branch

When you make changes to the Linux for Pirates! guide, you should do so in a separate branch. This is a good practice because it allows you to test your changes without affecting the main branch of the repository.

To create a new branch, enter the following command in the terminal:

```bash
`git branch NEW-BRANCH-NAME`
```

Replace `"NEW-BRANCH-NAME"` with a descriptive name for your branch.

- Switch to the new branch

Now that you've created a new branch, you need to switch to it. Enter the following command in the terminal:

`git checkout NEW-BRANCH-NAME`

- Make your changes

Open the files in the Linux for Pirates! repository in your text editor and make the changes you want to contribute.

- Commit your changes

When you're finished making changes, you need to "commit" them to the repository. This is like saving your changes, but it also allows you to add a message explaining what you did.

To commit your changes, enter the following command in the terminal:

`git commit -am "YOUR COMMIT MESSAGE"`

Replace `"YOUR COMMIT MESSAGE"` with a brief description of your changes.

- Push your changes to GitHub

Now that you've committed your changes, you need to "push" them to your fork of the repository on GitHub. This will make your changes visible to the rest of the team.

To push your changes, enter the following command in the terminal:

`git push origin NEW-BRANCH-NAME`

- Submit a pull request

Once you've pushed your changes to GitHub, you can submit a "pull request" to merge your changes into the main branch of the repository.

To submit a pull request, go to the main page of your fork of the repository on GitHub and click the "Compare and pull request" button. Provide a clear and concise description of your changes, and any relevant details or questions.

The team will review your pull request and provide feedback as needed. Once your pull request has been reviewed and accepted, it will be merged into the main branch of the repository.

## Communication and Collaboration

We encourage all contributors to communicate with the team and collaborate with one another to create the best possible resource for learning about Linux.

Here are some guidelines for communication and collaboration:

- Use the repository's issue tracker to report bugs, suggest improvements, or ask questions
- Use the repository's pull request system to submit contributions for review
- Be respectful and considerate of others when communicating
- Follow the Code of Conduct

## Resources for Contributors

To help you get started contributing to Linux for Pirates!, here are some resources you may find useful:

- Style Guide (TBA)
- [Code of Conduct](CODE_OF_CONDUCT.md)

Linux for Pirates! is committed to creating a positive and inclusive environment for contributors. We have adopted the Contributor Covenant as our code of conduct, which outlines the expectations for behavior and conduct in our community.

We expect all contributors to adhere to the code of conduct, and we will not tolerate any form of harassment or discrimination.

## Using Pirate Speak

Ahoy mateys! We encourage all contributors to use Pirate speak as much as possible when writing content for Linux for Pirates!. This adds a fun and lighthearted tone to the project.

Here are some common Pirate phrases you can use:

- "Ahoy matey!"
- "Shiver me timbers!"

Please use Pirate speak in a humorous and respectful manner, and avoid appropriating or mocking other cultures. For more information on the proper usage of Pirate speak, see this resource.

Thank you for considering a contribution to Linux for Pirates!. We look forward to working with you!
This is going to be finished off and nothing more will be added.
19 changes: 0 additions & 19 deletions Content/Backend/Backend.md

This file was deleted.

41 changes: 0 additions & 41 deletions Content/Cloud/Cloud.md

This file was deleted.

Loading

0 comments on commit 9dc9c79

Please sign in to comment.