Rjthapaa's blog
Day 25 - Complete Jenkins CI/CD Project - Continued with Documentation

Day 25 - Complete Jenkins CI/CD Project - Continued with Documentation

Rajendra Thapa's photo
Rajendra Thapa
·

2 min read

Did you finish Day 24?

  • Day 24 will give you an End to End project and adding it to your resume will be a cherry on the top.

  • take more time, finish the project, add a Documentation, add it to your Resume and post about it today.

Task-01

  • Document the process from cloning the repository to adding webhooks, and Deployment, etc. as a README , go through this example

  • A well written readme file will help others to understand your project and you will understand how to use the project again without any problems.

README.md file

A README file is an essential guide that gives other developers a detailed description of your GitHub project.

You may be wondering, Why anyone should spend time writing a README file. Well, here are some reasons to help convince you that it’s a good idea:

  1. A good README helps your project to stand out from other projects and should be as good as your project itself.

  2. It’s the first thing to notice while encountering your project, so it should be pretty brief but detailed.

  3. The quality of a README description differentiates a good project from bad ones.

  4. Many times README.md is hosted as a website; make sure your webpage looks as cool as your project!

Let's create our first README.md file today

Step 1: Navigate to Github and create a new repository with Add a README.md file checked and click on create repository.

A new repo with README.md file will be created inside

Step 2: Click on the README.md file to provide all the installation and required steps for the project

A good README file should provide information about your project, including what it does, how to install it, and how to use it. You should also include any dependencies, licensing information, and other important details. You can use Markdown to format your text, add images, and create links to other resources.

Step 4: After all the necessary content is added click on commit changes, so all the content is pushed to github project.

In conclusion, adding a README file to GitHub is an important step in managing your software projects. By following these simple steps, you can create a clear and informative README file that will help potential users and contributors understand your project. Remember to keep your README file up to date as your project evolves.

https://github.com/rjthapaa/README--Day25webhook

For Reference and entire hands-on Project visit here

DevopsTrainWithShubham#90daysofdevops