Skip to content

Commit b922fb0

Browse files
committed
Added README file
1 parent 95bfb92 commit b922fb0

9 files changed

+248
-1
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
name: 🐛 Bug report
3+
about: Create a report to help us improve the guide 🤘
4+
title: "Bug: "
5+
labels: bug
6+
---
7+
8+
<!-- Before creating a bug report, try disabling browser extensions to see if the bug is still present. -->
9+
10+
### Describe the bug
11+
12+
<!-- A clear and concise description of what the bug is. -->
13+
14+
### To Reproduce
15+
16+
<!-- Steps to reproduce the behavior: -->
17+
18+
<!-- 1. Go to '...' -->
19+
<!-- 2. Click on '....' -->
20+
<!-- 3. Scroll down to '....' -->
21+
<!-- 4. See error -->
22+
23+
### Expected behavior
24+
25+
<!-- A clear and concise description of what you expected to happen. -->
26+
27+
### Screenshots
28+
29+
<!-- If applicable, add screenshots to help explain your problem. -->
30+
31+
### Additional context
32+
33+
<!-- Add any other context about the problem or helpful links here. -->
+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
name: 🚀 Feature request
3+
about: Suggest an idea for this project 💡
4+
title: "Feature: "
5+
labels: feature, enhancement
6+
---
7+
8+
### Is your feature request related to a problem? Please describe.
9+
10+
<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
11+
12+
### Describe the solution you'd like
13+
14+
<!-- A clear and concise description of what you want to happen. -->
15+
16+
### Additional context
17+
18+
<!-- Add any other context or screenshots about the feature request here. -->
+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: 🖐 Help request
3+
about: I need help with an issue 😕
4+
title: "Help: "
5+
labels: help wanted
6+
---
7+
8+
### Please fill out this template
9+
10+
<!-- A clear and concise description of what the problem is. Ex. I need help with [...] -->
11+
12+
13+
### Additional context
14+
15+
<!-- Add any other context or screenshots about the feature request here. -->

.github/PULL_REQUEST_TEMPLATE.md

+37
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<!--
2+
For Work In Progress Pull Requests, please use the Draft PR feature,
3+
see https://github.blog/2019-02-14-introducing-draft-pull-requests/ for further details.
4+
5+
For a timely review/response, please avoid force-pushing additional
6+
commits if your PR already received reviews or comments.
7+
8+
Before submitting a Pull Request, please ensure you've done the following:
9+
- 📖 Read the Contributing Guide: https://github.com/bobbyiliev/introduction-to-bash-scripting/blob/HEAD/CONTRIBUTING.md#creating-a-pull-request.
10+
- 👷‍♀️ Create small PRs. In most cases, this will be possible.
11+
- 📝 Use descriptive commit messages.
12+
- 📗 Update any related documentation and include any relevant screenshots.
13+
-->
14+
15+
## What type of PR is this? (check all applicable)
16+
17+
- [ ] ♻️ Refactor
18+
- [ ] ✨ Feature
19+
- [ ] 🐛 Bug Fix
20+
- [ ] 👷 Optimization
21+
- [ ] 📝 Documentation Update
22+
- [ ] 🚩 Other
23+
24+
## Description
25+
26+
27+
28+
## Related Tickets & Documents
29+
30+
31+
32+
## Added to documentation?
33+
34+
- [ ] 📜 readme
35+
- [ ] 🙅 no documentation needed
36+
37+
## [optional] What gif best describes this PR or how it makes you feel?

CONTRIBUTING.md

+36
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Contributing
2+
3+
## Pull Requests
4+
5+
### Creating a Pull Request
6+
7+
This book has been designed so that people can easily expand it.
8+
To request us to review changes that you create, you will need to create a pull request.
9+
Creating a pull request is described in
10+
[this tutorial](https://www.digitalocean.com/community/tutorials/how-to-create-a-pull-request-on-github).
11+
12+
### File Location/Types
13+
14+
### [`content`](./content)
15+
16+
All the Markdown files for the 'Introduction to Bash Scripting' guide are located within the [`content`](./content) directory.
17+
18+
### PDF Generation
19+
20+
The project uses [Ibis](https://github.com/themsaid/ibis/) developed by [Mohamed Said](https://github.com/themsaid).
21+
22+
Make sure to follow the steps on how to get Ibis installed and how to use it here:
23+
24+
[Getting started with Ibis](https://github.com/themsaid/ibis/#installation)
25+
26+
## Issue Creation
27+
28+
In the event that you have a issue using the guide or have a suggest for a change but don't want to contribute changes,
29+
we are more than happy to help.
30+
Make sure that when you create your issue, it follows the format for the type of issue you select
31+
(it has individual templates for each issue type).
32+
33+
Issue template types include the following:
34+
- Bug Reporting
35+
- Feature Requests
36+
- Help Requests

LICENSE

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2020 Bobby Iliev
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

+88-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,88 @@
1-
# Introduction to Bash Scripting
1+
<p align="center"><img src="https://imgur.com/eXCcDPp.png" height="450" width="auto"></p>
2+
3+
## 💡 Introduction to Bash Scripting
4+
5+
This is an open-source introduction to Bash scripting guide that will help you learn the basics of Bash scripting and start writing awesome Bash scripts that will help you automate your daily SysOps, DevOps, and Dev tasks. No matter if you are a DevOps/SysOps engineer, developer, or just a Linux enthusiast, you can use Bash scripts to combine different Linux commands and automate boring and repetitive daily tasks, so that you can focus on more productive and fun things.
6+
7+
The guide is suitable for anyone working as a developer, system administrator, or a DevOps engineer and wants to learn the basics of Bash scripting.
8+
9+
## 📘 Chapters
10+
11+
The first 13 chapters would be purely focused on getting some solid Bash scripting foundations then the rest of the chapters would give you some real life examples and scripts.
12+
13+
* **About the book**
14+
* **Introduction to Bash scripting**
15+
* **Bash Structure**
16+
* **Bash Hello World**
17+
* **Bash Variables**
18+
* **Bash User Input**
19+
* **Bash Comments**
20+
* **Bash Arguments**
21+
* **Bash Arrays**
22+
* **Bash Conditional Expressions**
23+
* **Bash Conditionals**
24+
* **Bash Loops**
25+
* **Bash Functions**
26+
* **Debugging and testing**
27+
* **Creating custom bash commands**
28+
* **Write your first Bash script**
29+
* **Creating an interactive menu in Bash**
30+
* **Executing BASH scripts on Multiple Remote Servers**
31+
* **Work with JSON in BASH using jq**
32+
* **Working with Cloudflare API with Bash**
33+
* **BASH Script parser to Summarize Your NGINX and Apache Access Logs**
34+
* **Wrap Up**
35+
36+
## 🌟 Sponsors
37+
38+
This book is made possible thanks to these fantastic companies!
39+
40+
### 💙 DigitalOcean
41+
42+
DigitalOcean is a cloud services platform delivering the simplicity developers love and businesses trust to run production applications at scale.
43+
44+
It provides highly available, secure, and scalable compute, storage, and networking solutions that help developers build great software faster.
45+
46+
Founded in 2012 with offices in New York and Cambridge, MA, DigitalOcean offers transparent and affordable pricing, an elegant user interface, and one of the largest libraries of open source resources available.
47+
48+
For more information, please visit [https://www.digitalocean.com](https://www.digitalocean.com) or follow [@digitalocean](https://twitter.com/digitalocean) on Twitter.
49+
50+
If you are new to DigitalOcean, you can get a free $100 credit and spin up your own servers via this referral link here:
51+
52+
[Free $100 Credit For DigitalOcean](https://m.do.co/c/2a9bba940f39)
53+
54+
### 👩‍💻 DevDojo
55+
56+
The DevDojo is a resource to learn all things web development and web design. Learn on your lunch break or wake up and enjoy a cup of coffee with us to learn something new.
57+
58+
Join this developer community, and we can all learn together, build together, and grow together.
59+
60+
[Join DevDojo](https://devdojo.com?ref=bobbyiliev)
61+
62+
For more information, please visit [https://www.devdojo.com](https://www.devdojo.com?ref=bobbyiliev) or follow [@thedevdojo](https://twitter.com/thedevdojo) on Twitter.
63+
64+
## 👋 About the author
65+
66+
My name is Bobby Iliev, and I have been working as a Linux DevOps Engineer since 2014. I am an avid Linux lover and supporter of the open-source movement philosophy. I am always doing that which I cannot do in order that I may learn how to do it, and I believe in sharing knowledge.
67+
68+
I think it's essential always to keep professional and surround yourself with good people, work hard, and be nice to everyone. You have to perform at a consistently higher level than others. That's the mark of a true professional.
69+
70+
For more information, please visit my blog at [https://bobbyiliev.com](https://bobbyiliev.com), follow me on Twitter [@bobbyiliev_](https://twitter.com/bobbyiliev_) and [YouTube](https://www.youtube.com/channel/UCQWmdHTeAO0UvaNqve9udRw).
71+
72+
## 🔥 PDF Generation
73+
74+
The project uses [Ibis](https://github.com/themsaid/ibis/) developed by [Mohamed Said](https://github.com/themsaid).
75+
76+
Ibis is a PHP tool that helps you write eBooks in markdown.
77+
78+
## 🔗 Links
79+
80+
- [My blog at](https://bobbyiliev.com)
81+
- [Free $100 Credit For DigitalOcean](https://m.do.co/c/2a9bba940f39)
82+
- [Join DevDojo](https://devdojo.com?ref=bobbyiliev)
83+
84+
## 🤲 Contributing
85+
86+
If you are contributing 🍿 please read the [contributing file](CONTRIBUTING.md) before submitting your pull requests.
87+
88+
0 Bytes
Binary file not shown.
0 Bytes
Binary file not shown.

0 commit comments

Comments
 (0)