January 2018
Beginner
171 pages
3h 31m
English
Content preview from Introducing GitHub, 2nd Edition
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.
Chapter 6. Publishing Content
Providing good documentation for how to get started on a project, troubleshoot certain problems, and share ideas, or just providing a better landing page for people to find out about your project, can be just as important as the code itself. It can help new developers or users learn how to fix common problems and how to contribute back to build a stronger ecosystem, or allow you to find new contributors for your project. In this chapter we’ll be taking a look at writing and maintaining higher-level documentation on GitHub so that you can encourage more people to contribute to your repository or more effectively use your code and applications.
Wikis
If you’re familiar with wikis, continuing to use them is a great way to have some additional long-form documentation. Though the workflow for using them and accepting changes to them is different from any other contribution workflow on GitHub (you can’t use pull requests), it’s a good way for your users to find out more about your project if you have not yet created a GitHub Pages site.
A wiki is a very simple content management system that makes it easy for a group of collaborators to build a set of interlinked pages. Typically, GitHub’s wikis are used for capturing end user documentation, developer documentation, or both so that all of the information relating to a project is accessible through the project’s GitHub page.
Getting Started with a Wiki
If your project doesn’t yet have a wiki, start by ...
Become an O’Reilly member and get unlimited access to this title plus top books and audiobooks from O’Reilly and nearly 200 top publishers, thousands of courses curated by job role, 150+ live events each month,
and much more.
Read now
Unlock full access
More than 5,000 organizations count on O’Reilly
O’Reilly covers everything we've got, with content to help us build a world-class technology community, upgrade the capabilities and competencies of our teams, and improve overall team performance as well as their engagement.Julian F.
I wanted to learn C and C++, but it didn't click for me until I picked up an O'Reilly book. When I went on the O’Reilly platform, I was astonished to find all the books there, plus live events and sandboxes so you could play around with the technology.Addison B.
I’ve been on the O’Reilly platform for more than eight years. I use a couple of learning platforms, but I'm on O'Reilly more than anybody else. When you're there, you start learning. I'm never disappointed.Amir M.
I'm always learning. So when I got on to O'Reilly, I was like a kid in a candy store. There are playlists. There are answers. There's on-demand training. It's worth its weight in gold, in terms of what it allows me to do.