Build or Contribute to Documentation with a Git-based Workflow

Read the Docs is a great documentation platform used by many open source projects. This course teaches you how to create your own documentation project, use the reStructuredText markup language, and the basics of Git-based workflow for pull requests.
Course info
Level
Beginner
Updated
Dec 6, 2017
Duration
2h 1m
Table of contents
Free up Your Time or Give a Little Back: A Case for Documentation
Getting Started: Create Your Documentation Project
Leveraging the Power of reStructuredText Markup
Automating Updates with a Streamlined Workflow
Content That Goes Beyond reStructuredText
Hosting Alternatives for the Documentation and Its Source
Course Overview
Description
Course info
Level
Beginner
Updated
Dec 6, 2017
Duration
2h 1m
Description

Documentation of software applications and packages is often an afterthought at best, and frequently forgotten altogether. Putting together some good, easy-to-navigate documentation that can be updated by the community in a controlled fashion can really help avoid questions and make your application or package easier to use. In this course, Build or Contribute to Documentation with a Git-based Workflow, you'll explore a couple of options available to you, and then go into a full solution using Read the Docs by creating a documentation project. First, you'll learn about the reStructuredText syntax for some of the key elements you’ll likely want to include in your documentation. Then, you’ll delve into setting up a CI/CD workflow by putting your documentation in GitHub and show the standard workflow for pull requests. Additionally, you'll discover how to customize the look of your documentation, use Markdown, and have different versions of your documentation. Finally, you'll explore self-hosting documentation and code in the event that a Read the Docs hosted site is not a good option for you. By the end of this course, you'll have the necessary knowledge to efficiently create your own documentation projects, contribute to open source documentation, make pull requests, and know the hosting options available to you.

About the author
About the author

Full-stack developer, architect using the Microsoft stack and other key tools to create awesome solutions.

More from the author
Effective Logging in ASP.NET Core
Intermediate
2h 27m
Jul 26, 2019
More courses by Erik Dahl
Section Introduction Transcripts
Section Introduction Transcripts

Course Overview
Hi everyone, my name is Erik Dahl and welcome to my course Build or Contribute to Documentation with a Git-based Workflow. I'm a principle architect at Real Page. Do you author projects that other developers will be using and ever have to answer questions about your project? Or have you used an open source project and needed to pose questions in a forum or on Stack Overflow to get an answer about how to use the project in your application? If you answered yes to either of these questions, then this course is for you. We'll be addressing both the creation of a documentation project from scratch, as well as making updates or contributions using a Git-based workflow, which will include pull requests and continuous integration and delivery. No prior Git experience is assumed, so if you've been looking for that course that can help you hit the ground running with Git and pull requests, you've found it. Some of the major topics that we'll cover include setting up a brand new documentation project, learning the ReStructured Text markup syntax, setting up continuous integration and delivery, and reviewing the full Git workflow for a contribution via pull request. By the end of this course you'll know how to create your own doc project, how to contribute to open source docs, how to make pull requests, and even what hosting options are available for your source code and documentation site. I hope you'll join me on this exciting exploration of documentation tech and Git workflows with the Build or Contribute to Documentation With the Git-based workflow course, right here at Pluralsight.