Skip to content

Refactor the guidebook as Markdown-first #241

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 77 commits into from
May 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
77 commits
Select commit Hold shift + click to select a range
b6df787
Create SUMMARY.md
semioticrobotic Nov 20, 2024
b4c1bc2
Update SUMMARY.md to include initial README
semioticrobotic Nov 20, 2024
1ccd8f9
Refactor Measuring Success section
semioticrobotic Nov 20, 2024
f80bd5c
Link new section to table of contents
semioticrobotic Nov 20, 2024
6002f4b
Create section folders
semioticrobotic Nov 20, 2024
102fd3c
Fix table of contents spacing
semioticrobotic Nov 20, 2024
6405f71
Edit README and CONTRIBUTING
semioticrobotic Nov 20, 2024
bc24733
Change capitalization to conform to style guide
semioticrobotic Nov 20, 2024
11803d4
Add chapter on Community 101
semioticrobotic Nov 21, 2024
7134c38
Fix typo in file name
semioticrobotic Nov 21, 2024
fd57d94
Refactor New Project Checklist
semioticrobotic Nov 21, 2024
eaabac8
Link new section
semioticrobotic Nov 21, 2024
77b3789
Add chapter on open source product strategy
semioticrobotic Nov 22, 2024
461288a
Remove deprecated file
semioticrobotic Nov 22, 2024
e06b531
Remove two deprecated files
semioticrobotic Nov 22, 2024
a780f8b
Add introductory chapter
semioticrobotic Nov 22, 2024
4c4f110
Attempt to fix footnote
semioticrobotic Nov 22, 2024
979e073
Attempt another footnote fix
semioticrobotic Nov 22, 2024
9f64e83
Remove footnote
semioticrobotic Nov 22, 2024
63056ad
Change #2: No subject
semioticrobotic Nov 22, 2024
85754c6
Change #1: No subject
semioticrobotic Nov 22, 2024
8971181
Another footnote fix
semioticrobotic Nov 22, 2024
4f09f76
Revert change "Another footnote fix"
semioticrobotic Nov 22, 2024
69484f9
Remove deprecated file
semioticrobotic Nov 22, 2024
ecb4d51
Remove blank files intended for future versions
semioticrobotic Nov 22, 2024
6e64a3f
Remove more empty files intended for new versions
semioticrobotic Nov 22, 2024
8315e89
Change #3: Refresh Community 101
semioticrobotic Nov 23, 2024
6a9fdcc
Change #4: Refresh new project checklist
semioticrobotic Nov 23, 2024
db8240a
Change #5: Refresh Community 101 again
semioticrobotic Nov 23, 2024
43099d5
Update spacing in community-101.md
semioticrobotic Nov 23, 2024
1525ae0
Change #6: No subject
semioticrobotic Nov 23, 2024
cd8b18e
Update new-project-checklist.md to add missing field
semioticrobotic Nov 23, 2024
837f74c
Change #7: Refresh product strategy chapter
semioticrobotic Nov 23, 2024
23ce077
Fix headings in creating-an-open-source-product-strategy.md
semioticrobotic Nov 23, 2024
e5cfc10
Change #8: No subject
semioticrobotic Nov 23, 2024
b116fdf
Remove metadata from README.md
semioticrobotic Nov 23, 2024
ee5c9db
Convert chapter on participant motivations
semioticrobotic Nov 23, 2024
61b60d7
Merge upstream changes
semioticrobotic Nov 23, 2024
5971b72
Reformat chapter defining contributions
semioticrobotic Nov 24, 2024
b559bcf
Reformat chapter on defining healthy communities
semioticrobotic Nov 24, 2024
2c85d64
Remove even more empty files
semioticrobotic Nov 24, 2024
a072df5
Change #9: Refresh chapter on defining healthy communities
semioticrobotic Nov 24, 2024
0f449cc
Fix malformed footnote
semioticrobotic Nov 24, 2024
4d068d8
Reformat chapter on community metrics
semioticrobotic Nov 25, 2024
355b573
Merge upstream changes
semioticrobotic Nov 25, 2024
f60360a
Reformat chapter on announcing releases
semioticrobotic Nov 25, 2024
8b017b8
Reformat chapter on turning users to contributors
semioticrobotic Nov 25, 2024
2a94766
Update spacing in introduction
semioticrobotic Nov 25, 2024
3cc792c
Relocate stub of chapter on meetings
semioticrobotic Nov 25, 2024
a5c285c
Relocate stub of chapter on bug reports
semioticrobotic Nov 25, 2024
c4e3fa3
Relocate stub of chapter on notifications
semioticrobotic Nov 25, 2024
12d5c22
Relocate stub of chapter on includive discussions
semioticrobotic Nov 25, 2024
4d1ad3e
Relocate stub of chapter on defining participants
semioticrobotic Nov 25, 2024
fd25cd2
Relocate stub of chapter on community of practice
semioticrobotic Nov 25, 2024
47f0d2e
Remove deprecated outlines
semioticrobotic Nov 25, 2024
9e38c50
Update and link license statement
semioticrobotic Nov 25, 2024
77c0bcb
Reformat chapter on community essentials
semioticrobotic Nov 25, 2024
c1c6bc9
Update Bryan's email address
semioticrobotic Nov 25, 2024
2d0e630
Reformat chapter on communication norms
semioticrobotic Nov 26, 2024
317d5ab
Change #10: Refresh chapter on communication norms
semioticrobotic Nov 26, 2024
baed15b
Remove superfluous formatting
semioticrobotic Nov 26, 2024
adcaaae
Change #11: Refresh README
semioticrobotic Nov 26, 2024
966cf10
Reformat chapter on community roles
semioticrobotic Nov 26, 2024
2eb00a4
Reformat chapter on onboarding experiences
semioticrobotic Nov 26, 2024
cb28406
Reformat chapter on governance
semioticrobotic Nov 26, 2024
44569e8
Change #12: Refresh chapter on governance
semioticrobotic Nov 26, 2024
9f14d39
Remove deprecated chapter file
semioticrobotic Nov 26, 2024
bd5ea1e
Reformat chapter on rewarding participants
semioticrobotic Nov 26, 2024
270af52
Reformat chapter on cultures of mentorship
semioticrobotic Nov 27, 2024
375a12f
Remove deprecated chapter file
semioticrobotic Nov 27, 2024
f2f2b4c
Reformat chapter on building diverse communities
semioticrobotic Nov 27, 2024
c0709d7
Change #13: Reformat chapter on self-care
semioticrobotic Nov 27, 2024
7abe5eb
Remove deprecated chapter file
semioticrobotic Nov 27, 2024
3e6c541
Fix headings and add metadata
semioticrobotic Nov 27, 2024
a456a3b
Add contributor list and sync with summary
semioticrobotic Nov 27, 2024
e87c52d
Remove depracated contributors.adoc
semioticrobotic Dec 10, 2024
4d086aa
Delete outdated .gitignore
semioticrobotic Dec 10, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .gitignore

This file was deleted.

25 changes: 25 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,31 @@
We aim to make contributing to The Open Source Way a pleasant and enriching experience for all project participants, and we welcome contributions of all kinds.

## Getting started
This project uses Markdown and a git-based workflow. We track editorial, technical, governance, and marketing discussions on [their respective project boards](https://github.com/theopensourceway/guidebook/projects).

Each chapter is a Markdown file that is associated with an issue.
The chapter contains its own outline, content, and lexicon.

Each section is folder that contains files of chapters for that section.
Each section has one or more chapters in it.
There is not an issue associated with a section, unless a new section is being created.

Want to get involved?

Come talk with us on [the mailing list](https://lists.theopensourceway.org/admin/lists/contrib.theopensourceway.org/) and see [CONTRIBUTING.md](https://github.com/theopensourceway/guidebook/blob/master/CONTRIBUTING.md) to learn how to make your first contribution.

## Community architecture
For the 2.0 refresh, we've defined a set of roles and responsibilities around an initial, core group of contributors most familiar with the goals of the project. Beyond that, we'll evolve with the participation of new contributors and update [CONTRIBUTING.md](https://github.com/theopensourceway/guidebook/blob/master/CONTRIBUTING.md) to reflect current contribution guidelines.

At the moment:

* Project Lead Karsten Wade (@quaid) is responsible for providing vision and leadership to evolve from his original 1.0 work
* Lead Editor Brian Proffitt (@bproffitt) is responsible for leading a team of editors to work with multiple authors and content sources toward a cohesive, highly readable guide
* Lead Writer Shaun McCance (@shaunix) is responsible for working directly with writers to shape their content into the level, style, and narrative of the overall guide
* Editing team (Brian Proffitt, Karsten Wade, Shaun McCance) is responsible for polishing and integrating submissions to ensure consistency of quality and voice
* Writing team (Bryan Behrenshausen (@semioticrobotic), Brian Proffitt, Karsten Wade, Shaun McCance) is responsible for composing, collecting, and otherwise curating materials included in the guidebook.

## Contribution process

### 1. Review outstanding issues

Expand Down
58 changes: 58 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Contributors

## Chapter authors

* Introduction: Presenting The Open Source Way
* Author(s): [Karsten Wade](mailto:[email protected])
* Community 101
* Author(s): [Bryan Behrenshausen](mailto:[email protected]), [Dave Neary](mailto:[email protected]), [Karsten Wade](mailto:[email protected])
* New Project Checklist
* Author(s): [Lisa Caywood](mailto:[email protected]), [Josh Berkus](mailto:[email protected]), [Bryan Behrenshausen](mailto:[email protected]), [Karsten Wade](mailto:[email protected])
* Creating an Open Source Product Strategy
* Author(s): [Dave Neary](mailto:[email protected])
* Communication Norms in Open Source Software Projects
* Author(s): [Leslie Hawthorn](mailto:[email protected])
* Editor(s)/Reviewer(s): [Paula Dickerson](mailto:[email protected]) (lead), Editorial team
* Building Diverse Open Source Communities by Making Them Inclusive First
* Author(s): [Lauren Maffeo](mailto:[email protected])
* Editor(s)/Reviewer(s): [Bryan Behrenshausen](mailto:[email protected]) (lead), [Marina Zhurakhinskaya](mailto:[email protected]) (subject matter expert (SME) reviewer), Editorial team
* Why People Participate in Open Source Communities
* Author(s): [Gordon Haff](mailto:[email protected])
* Editor(s)/Reviewer(s): [Brian Proffitt](mailto:[email protected]) (lead), Editorial team
* Incentivizing and Rewarding Participants
* Author(s): [Bryan Behrenshausen](mailto:[email protected])
* From Users to Contributors
* Author(s): [Dave Neary](mailto:[email protected])
* What Is a Contribution?
* Author(s): [Karsten Wade](mailto:[email protected])
* Essentials of Building a Community
* Author(s): [Andy Oram](mailto:[email protected])
* Constructing an Onboarding Experience
* Author(s): [Ray Paik](mailto:[email protected]), [Bryan Behrenshausen](mailto:[email protected])
* Creating a Culture of Mentorship
* Author(s): [Karsten Wade](mailto:[email protected]), [Guedis Cardenas](mailto:[email protected])
* Project and Community Governance
* Author(s): [Dave Neary](mailto:[email protected]), [Josh Berkus](mailto:[email protected]), [Bryan Behrenshausen](mailto:[email protected])
* Editor(s)/Reviewer(s): [Bryan Behrenshausen](mailto:[email protected]) (lead), Editorial team
* Understanding Community Roles
* Author(s): [Andy Oram](mailto:[email protected]), [Karsten Wade](mailto:[email protected])
* Community Manager Self-Care
* Author(s): [Ashley Nicolson](mailto:[email protected])
* Editor(s)/Reviewer(s): [Karsten Wade](mailto:[email protected]) (lead), [Dr. Karen Hixson](https://www.karenhixsonlpc.com/) (subject matter expert (SME) reviewer), Editorial team
* Defining Healthy Communities
* Author(s): [Karsten Wade](mailto:[email protected])
* Understanding Community Metrics
* Author(s): [Ray Paik](mailto:[email protected]), [Brian Proffitt](mailto:[email protected]), [Bryan Behrenshausen](mailto:[email protected])
* Editor(s)/Reviewer(s): [Brian Proffitt](mailto:[email protected]) (lead), [Bryan Behrenshausen](mailto:[email protected]), Editorial team
* Announcing Software Releases
* Author(s): [Brian Proffitt](mailto:[email protected])

## Project teams

### Editorial team

* Brian Proffitt (lead)
* Shaun McCance (lead writer)
* Bryan Behrenshausen
* Paula Dickerson
* Karsten Wade
2 changes: 2 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# License

Attribution-ShareAlike 4.0 International (CC BY-SA 4.0)

You are free to:
Expand Down
48 changes: 0 additions & 48 deletions OUTLINE-mapped.adoc

This file was deleted.

34 changes: 0 additions & 34 deletions OUTLINE.adoc

This file was deleted.

30 changes: 3 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,5 @@
# Guidebook
# The Open Source Way

This repository contains source materials for [The Open Source Way 2.0](https://www.theopensourceway.org/), a (somewhat opinionated) guidebook for anyone interested in managing open source communities. It collects best practices for initiating, nurturing, growing, and maintaining groups of passionate contributors.
[The Open Source Way](https://www.theopensourceway.org/) is a (somewhat opinionated) guidebook for anyone interested in managing open source communities.

The Open Source Way 2.0 refreshes [pre-existing materials](https://www.theopensourceway.org/wiki) on these topics.

## Getting started

This project uses AsciiDoc and a git-based workflow. We track editorial, technical, governance, and marketing discussions on [their respective project boards](https://github.com/theopensourceway/guidebook/projects).

Each chapter is an .adoc file that is associated with an issue. The chapter contains its own outline, content, and lexicon.

Each section is an .adoc file that contains the outline of chapters for that section. Each section has one or more chapters in it. There is not an issue associated with a section, unless a new section is being created.

Want to get involved?

Come talk with us on [the mailing list](https://lists.theopensourceway.org/admin/lists/contrib.theopensourceway.org/) and see [CONTRIBUTING.md](https://github.com/theopensourceway/guidebook/blob/master/CONTRIBUTING.md) to learn how to make your first contribution.

## Community architecture

For the 2.0 refresh, we've defined a set of roles and responsibilities around an initial, core group of contributors most familiar with the goals of the project. Beyond that, we'll evolve with the participation of new contributors and update [CONTRIBUTING.md](https://github.com/theopensourceway/guidebook/blob/master/CONTRIBUTING.md) to reflect current contribution guidelines.

At the moment:

* Project Lead Karsten Wade (@quaid) is responsible for providing vision and leadership to evolve from his original 1.0 work
* Lead Editor Brian Proffitt (@bproffitt) is responsible for leading a team of editors to work with multiple authors and content sources toward a cohesive, highly readable guide
* Lead Writer Shaun McCance (@shaunix) is responsible for working directly with writers to shape their content into the level, style, and narrative of the overall guide
* Editing team (Brian Proffitt, Karsten Wade, Shaun McCance) is responsible for polishing and integrating submissions to ensure consistency of quality and voice
* Writing team (Bryan Behrenshausen (@semioticrobotic), Brian Proffitt, Karsten Wade, Shaun McCance) is responsible for composing, collecting, and otherwise curating materials included in the guidebook.
It collects best practices for initiating, nurturing, growing, and maintaining groups of passionate contributors.
29 changes: 29 additions & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# Table of contents

* [The Open Source Way](README.md)
* [Introduction: Presenting The Open Source Way](presenting-the-open-source-way.md)
* [Getting Started](getting-started/README.md)
* [Community 101](getting-started/community-101.md)
* [New Project Checklist](getting-started/new-project-checklist.md)
* [Creating an Open Source Product Strategy](getting-started/creating-an-open-source-product-strategy.md)
* [Attracting Users](attracting-users/README.md)
* [Communication Norms in Open Source Projects](attracting-users/communication-norms-in-open-source-software-projects.md)
* [Building Diverse Open Source Communities by Making Them Inclusive First](attracting-users/building-diverse-open-source-communities-by-making-them-includive-first.md)
* [Guiding Participants](guiding-participants/README.md)
* [Why People Participate in Open Source Communities](guiding-participants/why-people-participate-in-open-source-communities.md)
* [Incentivizing and Rewarding Participants](guiding-participants/incentivizing-and-rewarding-participants.md)
* [Growing Contributors](growing-contributors/README.md)
* [From Users to Contributors](growing-contributors/from-users-to-contributors.md)
* [What Is a Contribution?](growing-contributors/what-is-a-contribution.md)
* [Essentials of Building a Community](growing-contributors/essentials-of-building-a-community.md)
* [Constructing an Onboarding Experience](growing-contributors/constructing-an-onboarding-experience.md)
* [Creating a Culture of Mentorship](growing-contributors/creating-a-culture-of-mentorship.md)
* [Project and Community Governance](growing-contributors/project-and-community-governance.md)
* [Understanding Community Roles](growing-contributors/understanding-community-roles.md)
* [Community Manager Self-Care](growing-contributors/community-manager-self-care.md)
* [Measuring Success](measuring-success/README.md)
* [Defining Healthy Communities](measuring-success/defining-healthy-communities.md)
* [Understanding Community Metrics](measuring-success/understanding-community-metrics.md)
* [Announcing Software Releases](measuring-success/announcing-software-releases.md)
* [Contributors](CONTRIBUTORS.md)
* [License](LICENSE.md)
Loading