Skip to content

Commit d626ed3

Browse files
committed
Make next/previos links work
1 parent 0bd0888 commit d626ed3

File tree

14 files changed

+82
-60
lines changed

14 files changed

+82
-60
lines changed

_config.yml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,10 @@ exclude:
88
- script
99
- test
1010

11-
collections:
12-
content:
13-
output: true
14-
permalink: /:path/
11+
permalink: /:path/
1512

1613
defaults:
1714
- scope:
1815
path: ""
19-
type: "content"
2016
values:
2117
layout: article

_layouts/article.html

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<h1>{{ page.title }}</h1>
2+
3+
{{ content }}
4+
5+
{% assign previous = site.pages | where: "next", page.path | first %}
6+
{% if previous %}
7+
Previous: <a href="{{ previous.url | prepend: site.baseurl }}">{{ previous.title }}</a> |
8+
{% endif %}
9+
10+
{% if page.next %}
11+
{% assign next = site.pages | where: "path", page.next | first %}
12+
Next: <a href="{{ next.url | prepend: site.baseurl }}">{{ next.title }}</a>
13+
{% endif %}

_content/getting-started/branding.md renamed to getting-started/branding.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# **Branding**
1+
---
2+
title: Branding
3+
next: getting-started/preparing.md
4+
---
25

36
You’ve thought about who your users are, what they need from you, and what you might be able to offer them. Next, we’ll put that research into practice as we consider the brand of your project.
47

@@ -24,7 +27,7 @@ Make sure that your project’s name doesn’t infringe upon any trademarks. A c
2427

2528

2629

27-
You’ll also want to look for open source projects with a similar name, especially if you share the same language or ecosystem. If your name overlaps with a popular existing project, you will confuse your audience and make it less likely that anyone will use what you’ve created. You can check for similar project names here: [http://ivantomic.com/projects/ospnc/](http://ivantomic.com/projects/ospnc/)
30+
You’ll also want to look for open source projects with a similar name, especially if you share the same language or ecosystem. If your name overlaps with a popular existing project, you will confuse your audience and make it less likely that anyone will use what you’ve created. You can check for similar project names here: [http://ivantomic.com/projects/ospnc/](http://ivantomic.com/projects/ospnc/)
2831

2932

3033

@@ -69,5 +72,3 @@ We’re almost there! Next, we’ll walk you through a few components that every
6972
### Further reading
7073

7174
* [http://producingoss.com/en/getting-started.html#choosing-a-name](http://producingoss.com/en/getting-started.html#choosing-a-name)
72-
73-
[Previous](setting-expecations.md) | [Next](preparing.md)

_content/getting-started/index.md renamed to getting-started/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Before You Get Started
1+
---
2+
title: Before you Get Started
3+
next: getting-started/setting-expectations.md
4+
---
25

36
## What does it mean to open source a project?
47

@@ -31,5 +34,3 @@ Remember: open source isn’t just for software! You can open source everything
3134
When you open source a project, you open yourself to feedback and suggestions from other people who are engaged with your work. It might feel intimidating to open source a project for the first time, but remember that you’re not alone.
3235

3336
In the next section, we’ll help you figure out your goals around open sourcing your project. Understanding these goals beforehand will make it easier to manage your and others’ expectations later on.
34-
35-
[Previous](../index.md) | [Next](setting-expectations.md)

_content/getting-started/legal.md renamed to getting-started/legal.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
# **The legal side of open source**
1+
---
2+
title: The legal side of open source
3+
---
24

35
Sharing your creative work with the world can be an exciting and rewarding experience. It can also mean a bunch of legal things you didn’t know you had to worry about.
46

@@ -100,14 +102,14 @@ If you use others’ open source code to create anything that could be considere
100102

101103

102104

103-
To learn more about the implications of different open source licenses, check out: [https://tldrlegal.com/](https://tldrlegal.com/)
105+
To learn more about the implications of different open source licenses, check out: [https://tldrlegal.com/](https://tldrlegal.com/)
104106

105107

106108

107109
### Related content
108110

109111
* [http://choosealicense.com](http://choosealicense.com)
110112
* [https://tldrlegal.com/](https://tldrlegal.com/)
111-
* [https://processmechanics.com/2015/07/23/a-model-ip-and-open-source-contribution-policy/](https://processmechanics.com/2015/07/23/a-model-ip-and-open-source-contribution-policy/)
113+
* [https://processmechanics.com/2015/07/23/a-model-ip-and-open-source-contribution-policy/](https://processmechanics.com/2015/07/23/a-model-ip-and-open-source-contribution-policy/)
112114
* [https://blog.docker.com/2014/01/docker-code-contributions-require-developer-certificate-of-origin/](https://blog.docker.com/2014/01/docker-code-contributions-require-developer-certificate-of-origin/)
113-
* [https://www.joyent.com/blog/broadening-node-js-contributions](https://www.joyent.com/blog/broadening-node-js-contributions)
115+
* [https://www.joyent.com/blog/broadening-node-js-contributions](https://www.joyent.com/blog/broadening-node-js-contributions)

_content/getting-started/preparing.md renamed to getting-started/preparing.md

Lines changed: 12 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# **Preparing for launch**
1+
---
2+
title: Preparing for launch
3+
previous: getting-started/branding.md
4+
next: marketing/index.md
5+
---
26

37
You’re almost ready to launch your project! In this section, we’ll talk about what to include in an open source project before releasing it to the world.
48

@@ -87,25 +91,20 @@ Sometimes, it will take a long time before people notice your open source projec
8791

8892
* Licenses
8993
* [https://github.com/blog/1530-choosing-an-open-source-license](https://github.com/blog/1530-choosing-an-open-source-license)
90-
* [http://choosealicense.com](http://choosealicense.com)
94+
* [http://choosealicense.com](http://choosealicense.com)
9195
* READMEs
9296
* [http://tom.preston-werner.com/2010/08/23/readme-driven-development.html](http://tom.preston-werner.com/2010/08/23/readme-driven-development.html)
9397
* [https://github.com/matiassingers/awesome-readme](https://github.com/matiassingers/awesome-readme)
9498
* [https://pages.18f.gov/open-source-guide/making-readmes-readable/](https://pages.18f.gov/open-source-guide/making-readmes-readable/)
9599
* [https://changelog.com/a-beginners-guide-to-creating-a-readme/](https://changelog.com/a-beginners-guide-to-creating-a-readme/)
96-
* [https://gist.github.com/jxson/1784669](https://gist.github.com/jxson/1784669)
100+
* [https://gist.github.com/jxson/1784669](https://gist.github.com/jxson/1784669)
97101
* Contributing guides
98102
* [https://github.com/blog/1184-contributing-guidelines](https://github.com/blog/1184-contributing-guidelines)
99-
* [http://www.contribution-guide.org/](http://www.contribution-guide.org/)
100-
* [https://github.com/nayafia/contributing-template](https://github.com/nayafia/contributing-template)
103+
* [http://www.contribution-guide.org/](http://www.contribution-guide.org/)
104+
* [https://github.com/nayafia/contributing-template](https://github.com/nayafia/contributing-template)
101105
* [http://mozillascience.github.io/working-open-workshop/contributing/](http://mozillascience.github.io/working-open-workshop/contributing/)
102106
* Codes of conduct
103-
* [http://contributor-covenant.org/](http://contributor-covenant.org/)
104-
* [https://github.com/django/code-of-conduct](https://github.com/django/code-of-conduct)
105-
* [https://adainitiative.org/2014/02/18/howto-design-a-code-of-conduct-for-your-community/](https://adainitiative.org/2014/02/18/howto-design-a-code-of-conduct-for-your-community/)
107+
* [http://contributor-covenant.org/](http://contributor-covenant.org/)
108+
* [https://github.com/django/code-of-conduct](https://github.com/django/code-of-conduct)
109+
* [https://adainitiative.org/2014/02/18/howto-design-a-code-of-conduct-for-your-community/](https://adainitiative.org/2014/02/18/howto-design-a-code-of-conduct-for-your-community/)
106110
* [https://github.com/docker/docker/blob/master/CONTRIBUTING.md#docker-community-guidelines/](https://github.com/docker/docker/blob/master/CONTRIBUTING.md#docker-community-guidelines/)
107-
108-
109-
[Previous](branding.md) | [Next](../marketing/index.md)
110-
111-

_content/getting-started/setting-expectations.md renamed to getting-started/setting-expectations.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Setting expectations
1+
---
2+
title: Setting expectations
3+
next: getting-started/branding.md
4+
---
25

36
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!).
47

@@ -36,7 +39,7 @@ If you’re hoping to get feedback on something you’ve created, consider askin
3639

3740
## Figure out what others need from you
3841

39-
Finally, open sourcing a project is a two-way street. People who use your project will probably ask you for things, too.
42+
Finally, open sourcing a project is a two-way street. People who use your project will probably ask you for things, too.
4043

4144
Try to anticipate these needs beforehand so you can add them to your project from the beginning. Successful open source projects try to document as much as they can in public. Much like reusable pieces of code, reusable information means less people need to ask you the same questions over and over again. (That means less work for you!)
4245

@@ -60,5 +63,3 @@ We’ll also use these answers in the next section, as you consider the brand of
6063

6164
* http://mozillascience.github.io/working-open-workshop/personas_pathways/
6265
* http://tom.preston-werner.com/2010/08/23/readme-driven-development.html
63-
64-
[Previous](index.md) | [Next](branding.md)

_content/index.md renamed to index.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Welcome
1+
---
2+
title: Welcome
3+
next: getting-started/index.md
4+
---
25

36
Welcome to the Open Source Handbook! We created this handbook to help creators like you successfully release and grow your projects.
47

_content/marketing/building-community.md renamed to marketing/building-community.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# **Building a Community**
1+
---
2+
title: Building a community
3+
next: marketing/measuring.md
4+
---
25

36
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.
47

@@ -54,13 +57,10 @@ You’re doing great so far! Now that you’re promoting your project and growin
5457

5558
### Further reading
5659

57-
* [http://radek.io/2015/10/12/marketing-for-open-source-projects-5/](http://radek.io/2015/10/12/marketing-for-open-source-projects-5/)
60+
* [http://radek.io/2015/10/12/marketing-for-open-source-projects-5/](http://radek.io/2015/10/12/marketing-for-open-source-projects-5/)
5861

59-
* [http://hood.ie/blog/welcoming-communities.html](http://hood.ie/blog/welcoming-communities.html)
62+
* [http://hood.ie/blog/welcoming-communities.html](http://hood.ie/blog/welcoming-communities.html)
6063

6164
* [https://ashfurrow.com/blog/building-popular-projects/](https://ashfurrow.com/blog/building-popular-projects/)
6265

63-
* [http://sarah.thesharps.us/2015/10/06/what-makes-a-good-community/](http://sarah.thesharps.us/2015/10/06/what-makes-a-good-community/)
64-
65-
66-
[Previous](spreading-word.md) | [Next](measuring.md)
66+
* [http://sarah.thesharps.us/2015/10/06/what-makes-a-good-community/](http://sarah.thesharps.us/2015/10/06/what-makes-a-good-community/)

_content/marketing/index.md renamed to marketing/index.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,8 @@
1-
# **Marketing your project**
1+
---
2+
title: Marketing your project
3+
next: marketing/spreading-word.md
4+
---
25

36
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.
47

58
Remember, reaching your audience takes time. It may take months or years for you to grow a community around your project. Don’t give up! It’s all part of the process.
6-
7-
[Previous](../getting-started/preparing.md) | [Next](spreading-word.md)

0 commit comments

Comments
 (0)