github-docs VS unseen-oss

In college, an English professor would ask me and other students the following question when reviewing our essays, “Where are the examples?” Developers ask the same question when reading your documentation. To write good technical writing documents, include examples that developers can see themselves implementing in their work. How can this be done? By adding examples from your product’s codebase! 🙂 Let’s look at this code snippet from my contribution to GitHub’s documentation:

Need an example? Check the GitHub docs contributing guide.

git clone https://github.com/github/docs.git 123.57s user 37.02s system 74% cpu 3:35.73 total

git clone --depth 1 https://github.com/github/docs.git 3.37s user 1.83s system 35% cpu 14.521 total

Not a scientific test at all, but the second one was literally 35x faster, wall clock time.

Docs

The strange thing is that I only have this problem with github, all other websites work just fine. And even docs.github.com works fine...

99.9 at best for enterprise cloud: https://github.com/github/docs/blob/main/content/site-policy/site-policy-deprecated/github-enterprise-service-level-agreement.md

A project repository typically has a license file at the top-level indicating which license the code falls under. See here for an example license file.

"Why is it important?" you might ask. According to ZD Net 78% of companies around the world are running open source software. Elsewhere, you might hear stats like how the majority of the world's software is built on open source. GitHub pointed out in one of their latest blog posts that people "use more open source software than [they] think". With all these statistics floating around the internet, there's definitely cause to not take open source for granted.

You use more open source software than you think\ (3 comments)

I got a bit of a shock when I visited https://github.com/readme/unseen-oss and it wasn't a GitHub repository, it was a custom designed page!

Not a lot of URLs on GitHub sit outside of their regular /owner/repo pattern - the only other section I can think of that does that is https://github.com/about - things like documentation tend to live on separate subdomains, like https://docs.github.com/