diff --git a/getting-started/index.md b/_articles/getting-started.md similarity index 88% rename from getting-started/index.md rename to _articles/getting-started.md index 9e0281ce4d3..fcd4025947b 100644 --- a/getting-started/index.md +++ b/_articles/getting-started.md @@ -1,13 +1,13 @@ --- title: How to start an open source project nav: Getting started -next: getting-started/defining.md +following: _articles/getting-started/defining.md contents: - - getting-started/defining.md - - getting-started/setting-expectations.md - - getting-started/branding.md - - getting-started/preparing.md - - getting-started/legal.md + - _articles/getting-started/defining.md + - _articles/getting-started/setting-expectations.md + - _articles/getting-started/branding.md + - _articles/getting-started/preparing.md + - _articles/getting-started/legal.md --- First things first: we're here to help you launch projects of all shapes and sizes, but you may find certain sections more or less useful, depending on what you need. diff --git a/getting-started/branding.md b/_articles/getting-started/branding.md similarity index 99% rename from getting-started/branding.md rename to _articles/getting-started/branding.md index 277da74c2d1..99d5dac1814 100644 --- a/getting-started/branding.md +++ b/_articles/getting-started/branding.md @@ -1,7 +1,7 @@ --- title: Branding your open source project nav: Branding -next: getting-started/preparing.md +following: _articles/getting-started/preparing.md --- Wondering what to name your project? Let's talk about your project's brand. diff --git a/getting-started/defining.md b/_articles/getting-started/defining.md similarity index 98% rename from getting-started/defining.md rename to _articles/getting-started/defining.md index 9258f24a3f6..6e24cee3ad5 100644 --- a/getting-started/defining.md +++ b/_articles/getting-started/defining.md @@ -1,7 +1,7 @@ --- title: What is an open source project? nav: What it means to open source -next: getting-started/setting-expectations.md +following: _articles/getting-started/setting-expectations.md --- So you're interested in making your project open source? Congratulations! ๐ŸŽ‰ The world appreciates your contribution. diff --git a/getting-started/legal.md b/_articles/getting-started/legal.md similarity index 100% rename from getting-started/legal.md rename to _articles/getting-started/legal.md diff --git a/getting-started/preparing.md b/_articles/getting-started/preparing.md similarity index 99% rename from getting-started/preparing.md rename to _articles/getting-started/preparing.md index d2c268fbe77..0548ba05fc8 100644 --- a/getting-started/preparing.md +++ b/_articles/getting-started/preparing.md @@ -1,7 +1,7 @@ --- title: Launching your open source project nav: Preparing for launch -next: marketing/index.md +following: _articles/marketing.md --- You've written down your goals, you've chosen a name and an idea, and hopefully you've been hard at work building your project. (Haven't started yet? [Create a repository!](https://help.github.com/articles/create-a-repo/)) diff --git a/getting-started/setting-expectations.md b/_articles/getting-started/setting-expectations.md similarity index 98% rename from getting-started/setting-expectations.md rename to _articles/getting-started/setting-expectations.md index 6a1158fb1b4..8aeec20faaa 100644 --- a/getting-started/setting-expectations.md +++ b/_articles/getting-started/setting-expectations.md @@ -1,7 +1,7 @@ --- title: Setting expectations for your open source project nav: Setting expectations -next: getting-started/branding.md +following: _articles/getting-started/branding.md --- There are many reasons to open source a project. It's a good idea to figure out yours before going public with your project. What you want to get out of the experience will guide how you manage your project and help you figure out where to say yes (and no!). diff --git a/marketing/index.md b/_articles/marketing.md similarity index 75% rename from marketing/index.md rename to _articles/marketing.md index c2356d5367e..66b91da7d8b 100644 --- a/marketing/index.md +++ b/_articles/marketing.md @@ -1,11 +1,11 @@ --- title: Marketing your open source project nav: Marketing your project -next: marketing/spreading-word.md +following: _articles/marketing/spreading-word.md contents: -- marketing/spreading-word.md -- marketing/building-community.md -- marketing/measuring.md +- _articles/marketing/spreading-word.md +- _articles/marketing/building-community.md +- _articles/marketing/measuring.md --- This section of the handbook will help you spread the word about your project and grow your initial community of users and contributors. If you're looking for feedback on your project, or want people to use and share your work, this part is for you. diff --git a/marketing/building-community.md b/_articles/marketing/building-community.md similarity index 99% rename from marketing/building-community.md rename to _articles/marketing/building-community.md index e9fbfc40ba4..bca7e985bed 100644 --- a/marketing/building-community.md +++ b/_articles/marketing/building-community.md @@ -1,7 +1,7 @@ --- title: Building an open source community nav: Building a community -next: marketing/measuring.md +following: _articles/marketing/measuring.md --- You've launched your project, you're spreading the word, and people are checking out your project. Awesome! Now, how do you get them to stick around? In this section, we'll discuss ways to encourage people to use, contribute to, and evangelize your project. diff --git a/marketing/measuring.md b/_articles/marketing/measuring.md similarity index 99% rename from marketing/measuring.md rename to _articles/marketing/measuring.md index a364965e28f..4a9da476895 100644 --- a/marketing/measuring.md +++ b/_articles/marketing/measuring.md @@ -1,7 +1,7 @@ --- title: Measuring the success of your open source project nav: Measuring success -next: sustaining/index.md +following: _articles/sustaining.md --- Your project is starting to grow. ๐ŸŒฑ Well, you think it's growing. Is it growing? Let's talk about how to measure and track the success of your open source project. diff --git a/marketing/spreading-word.md b/_articles/marketing/spreading-word.md similarity index 99% rename from marketing/spreading-word.md rename to _articles/marketing/spreading-word.md index eb5f0a7203c..f2cd6dd5686 100644 --- a/marketing/spreading-word.md +++ b/_articles/marketing/spreading-word.md @@ -1,7 +1,7 @@ --- title: Promoting your open source project nav: Spreading the word -next: marketing/building-community.md +following: _articles/marketing/building-community.md --- You've just published your projectโ€“what's next? It's time to tell everybody about your hard work! diff --git a/sustaining/index.md b/_articles/sustaining.md similarity index 74% rename from sustaining/index.md rename to _articles/sustaining.md index a6d6739966b..fd051392364 100644 --- a/sustaining/index.md +++ b/_articles/sustaining.md @@ -1,11 +1,11 @@ --- title: Sustaining growth of your open source project nav: Sustaining growth -next: sustaining/best-practices.md +following: _articles/sustaining/best-practices.md contents: -- sustaining/best-practices.md -- sustaining/healthy-communities.md -- sustaining/leadership.md +- _articles/sustaining/best-practices.md +- _articles/sustaining/healthy-communities.md +- _articles/sustaining/leadership.md --- Congratulations! You launched a project into the universe, and it managed to hit escape velocity. People are using your project, contributing back, and telling their friends. Your project has a bright future ahead of it. ๐Ÿ‘ ๐Ÿš€ ๐ŸŒ  diff --git a/sustaining/best-practices.md b/_articles/sustaining/best-practices.md similarity index 99% rename from sustaining/best-practices.md rename to _articles/sustaining/best-practices.md index 40629216d8a..b8137d2eb36 100644 --- a/sustaining/best-practices.md +++ b/_articles/sustaining/best-practices.md @@ -1,7 +1,7 @@ --- title: Best practices for open source project maintenance nav: Best practices for maintainers -next: sustaining/healthy-communities.md +following: _articles/sustaining/healthy-communities.md --- We spend plenty of time talking about how to make other people happy. But first and foremost, make yourself happy. Maintainer happiness is a non-negotiable requirement for the survival of any open source project. diff --git a/sustaining/healthy-communities.md b/_articles/sustaining/healthy-communities.md similarity index 99% rename from sustaining/healthy-communities.md rename to _articles/sustaining/healthy-communities.md index 0f0a4389647..9de13d5258b 100644 --- a/sustaining/healthy-communities.md +++ b/_articles/sustaining/healthy-communities.md @@ -1,7 +1,7 @@ --- title: Sustaining healthy open source communities nav: Sustaining healthy communities -next: sustaining/leadership.md +following: _articles/sustaining/leadership.md --- Your project's community is extremely powerful. That power can be a blessing or a curse, depending on how you wield it. In this section, we'll look at ways to structure your community to become a force of construction, not destruction. diff --git a/sustaining/leadership.md b/_articles/sustaining/leadership.md similarity index 99% rename from sustaining/leadership.md rename to _articles/sustaining/leadership.md index a4cef511df6..4a301e788dd 100644 --- a/sustaining/leadership.md +++ b/_articles/sustaining/leadership.md @@ -1,7 +1,7 @@ --- title: Open source project leadership & governance nav: Leadership & governance -next: troubleshooting/index.md +following: _articles/troubleshooting.md --- Your project is growing, people are engaged, and you're committed to keeping this thing going. At this stage, you're probably starting to wonder about governance. diff --git a/troubleshooting/index.md b/_articles/troubleshooting.md similarity index 80% rename from troubleshooting/index.md rename to _articles/troubleshooting.md index 93138e54fe0..741413db275 100644 --- a/troubleshooting/index.md +++ b/_articles/troubleshooting.md @@ -2,11 +2,11 @@ title: Open source project troubleshooting & maintenance nav: Troubleshooting contents: -- troubleshooting/conduct.md -- troubleshooting/burnout.md -- troubleshooting/finding-consensus.md -- troubleshooting/contributions.md -- troubleshooting/getting-paid.md +- _articles/troubleshooting/conduct.md +- _articles/troubleshooting/burnout.md +- _articles/troubleshooting/finding-consensus.md +- _articles/troubleshooting/contributions.md +- _articles/troubleshooting/getting-paid.md --- This section of the handbook addresses some common situations that may come up as you maintain your open source project. diff --git a/troubleshooting/burnout.md b/_articles/troubleshooting/burnout.md similarity index 100% rename from troubleshooting/burnout.md rename to _articles/troubleshooting/burnout.md diff --git a/troubleshooting/conduct.md b/_articles/troubleshooting/conduct.md similarity index 100% rename from troubleshooting/conduct.md rename to _articles/troubleshooting/conduct.md diff --git a/troubleshooting/contributions.md b/_articles/troubleshooting/contributions.md similarity index 100% rename from troubleshooting/contributions.md rename to _articles/troubleshooting/contributions.md diff --git a/troubleshooting/finding-consensus.md b/_articles/troubleshooting/finding-consensus.md similarity index 100% rename from troubleshooting/finding-consensus.md rename to _articles/troubleshooting/finding-consensus.md diff --git a/troubleshooting/getting-paid.md b/_articles/troubleshooting/getting-paid.md similarity index 100% rename from troubleshooting/getting-paid.md rename to _articles/troubleshooting/getting-paid.md diff --git a/_config.yml b/_config.yml index 04a1e375826..0a5daa90604 100644 --- a/_config.yml +++ b/_config.yml @@ -16,6 +16,11 @@ exclude: permalink: /:path/ +collections: + articles: + output: true + permalink: /:path/ + defaults: - scope: path: "" diff --git a/_data/fields.yml b/_data/fields.yml index dda7f0227ac..b1c49230822 100644 --- a/_data/fields.yml +++ b/_data/fields.yml @@ -6,7 +6,7 @@ title: contents: type: Array -next: +following: type: String nav: diff --git a/_includes/contents.html b/_includes/contents.html index cb27b23f266..63ac04a90d2 100644 --- a/_includes/contents.html +++ b/_includes/contents.html @@ -6,7 +6,7 @@