Skip to content

Related to #9 - Improved markdown in README.md #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 33 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,33 @@
# LearnDocker
This repository walks you through the basics of using docker.

# CONTRIBUTING

### Contributing Guidelines!

Read these instructions to understand the contribution guidelines. Please follow the guidelines to ensure a smooth contribution. Following the guidelines reflects your respect towards the open source contribution. The issues, potential changes and pull requests will be addressed in compliance with the quality of need and urgency.

### Expected Contribution:
In case you are willing to contribute in any form, you're most welcome! Improvements to documentation, reporting bugs and mistakes is expected in general.

# Getting started

## Ground Rules
Issues should be created to submit a change to the repository before opening a pull request. Communication in any form except the repository channels is not expected and will not be entertained.


# Your First Contribution
In case you have additions to the concepts, codebase, or anything relevant, you're most welcome to open an issue, followed by opening a pull request. You are again welcome to report a mistake in the existing content, and code obsolete issues.


### Know More about open Source Contributions:
Here are a couple of friendly tutorials you can go through: http://makeapullrequest.com/ and http://www.firsttimersonly.com/

<h1 align="center">Welcome to LearnDocker</h1>

<div align="center">

![Learn Docker](https://img.shields.io/badge/Docker-learn-blue)
![first-timers-only](https://img.shields.io/badge/first--timers--only-friendly-blueviolet)
![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen)

</div>

<h3>:whale2:About</h3>

<p><a href="https://github.com/docker">Docker</a> is an open source containerization platform. It enables developers to package applications into containers - standardized executable components combining application source code with the Operating System (OS) libraries and dependencies required to run that code in any environment. Containers simplify the delivery of distributed applications, and have become increasingly popular as organizations shift to cloud-native development and hybrid multicloud environments (<a href="https://www.ibm.com/in-en/cloud/learn/docker">IBM</a>, 2021). This repository will teach you the basics of Docker including:</p>

<ul>
<li>How to create a DockerFile</li>
<li>Networking in Docker</li>
<li>Understanding Docker Volumes</li>
<li>And the basics of running commands with a Docker File</li>
</ul>

<br />

<h3>:scroll:Contribution Guidelines</h3>
<p>This is an open source repository which means anyone can contribute to make this repository better...hopefully. To ensure that each contribution is an improvement, we ask that you follow a few basic guidelines:</p>

<ul>
<li>First and foremost <b>be polite</b>, you may be an open source veteran who's been in the game for who knows how long, we get it. This isn't your first rodeo. Please use your experience to help others out, we all start somewhere and sometimes a few tips & tricks are all we need to hit the ground running.</li>

<li>Second, <b>if you see something, say something</b>. There will always be things to fix, that's just the nature of collaborative work. If you come across a bug, or something that could use a little love, create an issue for it. Give it a descriptive title and add as much detail as you can so that you or whoever then fixes it knows where to start.</li>

<li>Third, <b>have some fun</b>. This is a great place to start your open source journey and learn what it means to contribute to larger workflows. And if/when you get stuck, or you simply don't know where to start, checkout <a href="http://makeapullrequest.com/">Make a Pull Request</a> or <a href="http://www.firsttimersonly.com/">First Timers Only</a> for some inspiration.</li>
</ul>