From 5cd08314ee849eff5081300f45616e00c740e2d9 Mon Sep 17 00:00:00 2001 From: Brandon Keepers Date: Sat, 13 Aug 2016 12:04:36 -0500 Subject: [PATCH 1/2] Update lint config for headings --- script/test-prose | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/script/test-prose b/script/test-prose index 06d268adeae..fa9a992f025 100755 --- a/script/test-prose +++ b/script/test-prose @@ -26,6 +26,10 @@ var options = { "no-html": false, // Sadly, need HTML for video embeds "no-heading-punctuation": false, "list-item-spacing": false, + "first-heading-level": 2, // Page title is h1, so start with h2 + + // FIXME: Eventually remove these + "maximum-heading-length": 80, }, "readability": { "age": 18 From 1001303c30f64e91d8a7136ec59775dc91c4c7d7 Mon Sep 17 00:00:00 2001 From: Brandon Keepers Date: Sat, 13 Aug 2016 12:06:17 -0500 Subject: [PATCH 2/2] Normalize headings --- getting-started/branding.md | 4 ++-- getting-started/legal.md | 2 +- getting-started/preparing.md | 2 +- marketing/building-community.md | 4 ++-- marketing/measuring.md | 2 +- marketing/spreading-word.md | 4 ++-- sustaining/best-practices.md | 4 ++-- sustaining/healthy-communities.md | 4 ++-- sustaining/leadership.md | 2 +- troubleshooting/conduct.md | 4 ++-- troubleshooting/finding-consensus.md | 2 +- troubleshooting/getting-paid.md | 10 +++++----- 12 files changed, 22 insertions(+), 22 deletions(-) diff --git a/getting-started/branding.md b/getting-started/branding.md index 9951c961341..6e294264e3c 100644 --- a/getting-started/branding.md +++ b/getting-started/branding.md @@ -41,10 +41,10 @@ It isn’t necessary to write a style guide for your project when you’re just We’re almost there! Next, we’ll walk you through a few components that every open source project should include when you launch. -### Footnotes +## Footnotes [1] [http://writing.jan.io/2015/11/20/sustainable-open-source.html](http://writing.jan.io/2015/11/20/sustainable-open-source.html) -### Further reading +## Further reading * [http://producingoss.com/en/getting-started.html#choosing-a-name](http://producingoss.com/en/getting-started.html#choosing-a-name) diff --git a/getting-started/legal.md b/getting-started/legal.md index ccb09510b28..d2716109499 100644 --- a/getting-started/legal.md +++ b/getting-started/legal.md @@ -74,7 +74,7 @@ If you use others’ open source code to create anything that could be considere To learn more about the implications of different open source licenses, [TLDRLegal](https://tldrlegal.com/) is a great resource. -### Further reading +## Further reading * [http://choosealicense.com](http://choosealicense.com) * [https://tldrlegal.com/](https://tldrlegal.com/) diff --git a/getting-started/preparing.md b/getting-started/preparing.md index 510c0c3dfc6..2f6a5d7b543 100644 --- a/getting-started/preparing.md +++ b/getting-started/preparing.md @@ -84,7 +84,7 @@ Launching your project is only the first step. If you’re hoping people will di Sometimes, it will take a long time before people notice your open source project. Your project will likely go through multiple phases of activity and contributorship. That’s okay! Some of the most popular projects today took years to reach high levels of activity. The rest of this handbook is designed to help you manage your project every step of the way. -### Further reading +## Further reading * Licenses * [https://github.com/blog/1530-choosing-an-open-source-license](https://github.com/blog/1530-choosing-an-open-source-license) diff --git a/marketing/building-community.md b/marketing/building-community.md index 5fe852414a8..70bc1bc746b 100644 --- a/marketing/building-community.md +++ b/marketing/building-community.md @@ -47,13 +47,13 @@ For casual or first-time contributors, be open-minded about the types of contrib You’re doing great so far! Now that you’re promoting your project and growing a community, you’re probably wondering whether you’re doing it right. In the next section, we’ll talk about metrics to measure your project’s success and how to track them. -### Footnotes +## Footnotes [1] [https://docs.google.com/presentation/d/1hsJLv1ieSqtXBzd5YZusY-mB8e1VJzaeOmh8Q4VeMio/edit#slide=id.g43d857af8_0177](https://docs.google.com/presentation/d/1hsJLv1ieSqtXBzd5YZusY-mB8e1VJzaeOmh8Q4VeMio/edit#slide=id.g43d857af8_0177) [2] [https://speakerdeck.com/mikemcquaid/the-open-source-contributor-funnel](https://speakerdeck.com/mikemcquaid/the-open-source-contributor-funnel) -### Further reading +## Further reading * [http://radek.io/2015/10/12/marketing-for-open-source-projects-5/](http://radek.io/2015/10/12/marketing-for-open-source-projects-5/) diff --git a/marketing/measuring.md b/marketing/measuring.md index eb8b82f64b8..7190815d86a 100644 --- a/marketing/measuring.md +++ b/marketing/measuring.md @@ -51,7 +51,7 @@ Here are a few types of contributor metrics you may want to regularly keep track * **Types of contributions:** For example, commits, fixing typos or bugs, or commenting on an issue. -### Further reading +## Further reading * [http://blog.smartbear.com/news/measuring-success-in-an-open-source-project/](http://blog.smartbear.com/news/measuring-success-in-an-open-source-project/) diff --git a/marketing/spreading-word.md b/marketing/spreading-word.md index fe24ad3d998..e0bdd2ef9cc 100644 --- a/marketing/spreading-word.md +++ b/marketing/spreading-word.md @@ -47,13 +47,13 @@ Spreading the word is an important step in growing the popularity of your projec In the next section, we’ll talk about how to retain those early enthusiasts and grow an engaged community around your project. -### Footnotes +## Footnotes [1] [https://news.ycombinator.com/item?id=7531689](https://news.ycombinator.com/item?id=7531689) [2] [https://github.com/swinton/codeconf/blob/master/the-hashicorp-formula-to-open-source.md](https://github.com/swinton/codeconf/blob/master/the-hashicorp-formula-to-open-source.md) -### Further reading +## Further reading * [https://hacks.mozilla.org/2013/05/how-to-spread-the-word-about-your-code/](https://hacks.mozilla.org/2013/05/how-to-spread-the-word-about-your-code/) diff --git a/sustaining/best-practices.md b/sustaining/best-practices.md index d8aa9a14aa7..4bdb5900210 100644 --- a/sustaining/best-practices.md +++ b/sustaining/best-practices.md @@ -81,7 +81,7 @@ If you want to get a little more advanced, style guides and linters can help sta Hopefully, you’re feeling more empowered to say no, set and enforce rules, and take breaks when you need them. In the next section, we’ll talk about how you can leverage your community to grow a sustainable project. -### Footnotes +## Footnotes [1] [https://lord.io/blog/2014/oss-tips/](https://lord.io/blog/2014/oss-tips/) @@ -89,7 +89,7 @@ Hopefully, you’re feeling more empowered to say no, set and enforce rules, and [3] [https://blog.jessfraz.com/post/the-art-of-closing/](https://blog.jessfraz.com/post/the-art-of-closing/) -### Further reading +## Further reading * [http://www.kennethreitz.org/essays/be-cordial-or-be-on-your-way](http://www.kennethreitz.org/essays/be-cordial-or-be-on-your-way) diff --git a/sustaining/healthy-communities.md b/sustaining/healthy-communities.md index 16afdd3f1a0..ab9efc58355 100644 --- a/sustaining/healthy-communities.md +++ b/sustaining/healthy-communities.md @@ -55,7 +55,7 @@ Do your best to adopt a zero-tolerance policy towards these types of people. If When you see negative behavior happening on your project, call it out publicly. Explain, in a kind but firm tone, why their behavior is not acceptable. If the problem persists, you may need to [ask them to leave](../../troubleshooting/conduct/). Your code of conduct can be a constructive guide for these conversations. -### Footnotes +## Footnotes [1] [http://gustavopinto.org/lost+found/saner2016.pdf](http://gustavopinto.org/lost+found/saner2016.pdf) @@ -67,7 +67,7 @@ When you see negative behavior happening on your project, call it out publicly. [6] [https://peerj.com/preprints/1233.pdf](https://peerj.com/preprints/1233.pdf) -### Further reading +## Further reading * [https://opensource.com/life/16/5/growing-contributor-base-modern-open-source](https://opensource.com/life/16/5/growing-contributor-base-modern-open-source) diff --git a/sustaining/leadership.md b/sustaining/leadership.md index 707543b1804..0dd310277ab 100644 --- a/sustaining/leadership.md +++ b/sustaining/leadership.md @@ -87,7 +87,7 @@ Congratulations on making it this far, and welcome to the ranks of open source m As you grow into your leadership role, you'll inevitably come across some tough situations. Check out our [Troubleshooting](../../troubleshooting/) section for help when you need it. And from the bottom of our hearts, thank you for sharing your work and making a positive contribution to the world. 💕 -### Footnotes +## Footnotes [1] [http://felixge.de/2013/03/11/the-pull-request-hack.html](http://felixge.de/2013/03/11/the-pull-request-hack.html) diff --git a/troubleshooting/conduct.md b/troubleshooting/conduct.md index ae852254c1c..c5d29fd7c30 100644 --- a/troubleshooting/conduct.md +++ b/troubleshooting/conduct.md @@ -48,11 +48,11 @@ Banning members should not be taken lightly and represents a permanent and irrec It’s not always easy to enforce your code of conduct, but this type of work is necessary to maintain a healthy and active community. When a project seems hostile or unwelcoming, even if it’s just one person whose behavior is tolerated by the rest of the community, you risk losing the contributions of many others, some of whom you may never even meet. -### Footnotes +## Footnotes [1] [https://github.com/dib-lab/khmer/blob/master/CODE_OF_CONDUCT.rst](https://github.com/dib-lab/khmer/blob/master/CODE_OF_CONDUCT.rst) -### Further reading +## Further reading * [https://www.djangoproject.com/conduct/enforcement-manual/](https://www.djangoproject.com/conduct/enforcement-manual/) diff --git a/troubleshooting/finding-consensus.md b/troubleshooting/finding-consensus.md index 43384a1467c..2a93e9bf4ef 100644 --- a/troubleshooting/finding-consensus.md +++ b/troubleshooting/finding-consensus.md @@ -50,7 +50,7 @@ With a good attitude and clear communication, most difficult situations are reso Your tiebreaker should be a last resort. Divisive issues can be an opportunity for your community to grow and learn. Embrace these opportunities and try to use a collaborative process to move to a resolution wherever possible. -### Further reading +## Further reading * [http://producingoss.com/en/producingoss.html#common-pitfalls](http://producingoss.com/en/producingoss.html#common-pitfalls) diff --git a/troubleshooting/getting-paid.md b/troubleshooting/getting-paid.md index 4801576c3ae..0d2f2d47113 100644 --- a/troubleshooting/getting-paid.md +++ b/troubleshooting/getting-paid.md @@ -6,7 +6,7 @@ If you make regular, substantial contributions to open source, or you’re just Today, some open source work is paid. Projects sometimes raise money from companies, individuals, or others to fund ongoing work. [Ruby Together](https://rubytogether.org/), for example, is a foundation that pays for work on [bundler](https://github.com/bundler/bundler), [RubyGems](https://github.com/rubygems/rubygems), and other Ruby infrastructure projects. -For an individual contributor, a company may hire an employee to work on an open source project, or encourage employees to make open source contributions during work hours. [Nodesource](https://github.com/nodesource) and [Rackspace](https://blog.rackspace.com/rackspaces-policy-on-contributing-to-open-source/) are two companies with these types of arrangements. +For an individual contributor, a company may hire an employee to work on an open source project, or encourage employees to make open source contributions during work hours. [Nodesource](https://github.com/nodesource) and [Rackspace](https://blog.rackspace.com/rackspaces-policy-on-contributing-to-open-source/) are two companies with these types of arrangements. Other open source work is unpaid or volunteered. For example, someone might come across a bug in a project they use and submit a quick fix, or they might enjoy tinkering with an open source project in their spare time. (Did you know that [@gvanrossum ](https://github.com/gvanrossum)started [Python](https://github.com/python) over a Christmas holiday?) @@ -26,12 +26,12 @@ As open source’s popularity increases, availability of funding has not yet cau If you’d like to explore other different funding options, you can check out [this list](https://github.com/nayafia/lemonade-stand). Different types of funding require different skills, so consider your strengths to figure out which funding option works best for you. -### Further reading +## Further reading -* [http://lifeofaudrey.com/essays/love_and_money.html](http://lifeofaudrey.com/essays/love_and_money.html) +* [http://lifeofaudrey.com/essays/love_and_money.html](http://lifeofaudrey.com/essays/love_and_money.html) -* [http://blog.cocoapods.org/Why-we-dont-accept-donations/](http://blog.cocoapods.org/Why-we-dont-accept-donations/) +* [http://blog.cocoapods.org/Why-we-dont-accept-donations/](http://blog.cocoapods.org/Why-we-dont-accept-donations/) -* [http://marijnhaverbeke.nl/blog/sustainable-maintenance.html](http://marijnhaverbeke.nl/blog/sustainable-maintenance.html) +* [http://marijnhaverbeke.nl/blog/sustainable-maintenance.html](http://marijnhaverbeke.nl/blog/sustainable-maintenance.html) * [https://medium.com/open-source-life/money-and-open-source-d44a1953749c#.nyk44wmm1](https://medium.com/open-source-life/money-and-open-source-d44a1953749c#.nyk44wmm1)