Coda 323#330
Conversation
Updated the document to reflect the new vision and mission of the Open Documentation Academy, including core values and programs.
Add graphics to better explain a new contributors pathway.
Signed-off-by: Tara Nair <narahita211@gmail.com>
| # Open Documentation Academy | ||
|
|
||
| _Discover open source through documentation._ | ||
| __Document. Learn. Contribute. Lead: Discover open source through better documentation.__ | ||
|
|
||
| ## Mission | ||
| ## Our Vision | ||
|
|
||
| Canonical's Open Documentation Academy, or CODA, aspires to be the centre of open source collaboration through documentation. | ||
| __Documentation accessible to all. Contribution possible for everyone. Leadership within reach.__ | ||
|
|
||
| We create opportunities for people who are new to open source by connecting them with documentation tasks on projects of distinction. We provide assistance and mentoring on these tasks, so that members develop skills in a safe and supportive environment. With our help, your open source journey can be a valuable experience that you can be proud of and receive tangible recognition for. | ||
| At CODA, Canonical Open Documentation Academy, we envision a future where quality documentation is the foundation and lifeblood of open-source ecosystems—a world where clear, accessible, and thoughtful content demystifies technology, inviting both newcomers and experienced contributors from every corner of the globe to collaborate, innovate, and ensure open-source thrives for generations to come. | ||
|
|
||
| --- |
There was a problem hiding this comment.
Can we stick to @degville's version for the heading and introduction?
Our ambition for the Open Documentation Academy
We create opportunities for people who are new to open source by connecting them with documentation tasks on established projects. We provide assistance and mentoring on these tasks, so that members develop skills in a safe and supportive environment.
With our help, your open source journey can be a valuable experience that you can be proud of and receive tangible recognition for.
| --- | ||
|
|
||
| ## What drives us | ||
| ## Our Mission |
There was a problem hiding this comment.
We use sentence case for headings. Please see the Headings section of the Canonical Documentation Style Guide
| ## Our Core Values | ||
|
|
||
| We think open source can be done better. The most important concern of an open source project should be its people and how they collaborate, not its technical development. The very nature of any project is to be a social enterprise, in other words to be about the work between people. Successful and healthy projects operate with this understanding, and we want to connect people with them. | ||
| Anyone who participates in a CODA space or works on a CODA task is a CODA member, and we aim to collaborate with projects that share our values. By participating, you agree to uphold the spirit of the [Ubuntu code of conduct](https://discourse.ubuntu.com/t/ubuntu-code-of-conduct-v2-0/33111/1), champion the CODA values described below, and help set the standard for open-source collaboration. | ||
|
|
||
| **Transparency** | ||
| Our work is conducted openly. Documentation, workflows, and community platforms are freely available to anyone seeking to improve documentation. | ||
|
|
||
| ## Organisation | ||
| **Diversity** | ||
| We welcome and celebrate contributors from all backgrounds and geographies. Participation is encouraged regardless of prior expertise or origin. | ||
|
|
||
| CODA is arranged as a meta-project for other open source projects. We collaborate with any project that shares our values to coordinate opportunities for open source enthusiasts to participate with them. | ||
| **Partnership** | ||
| We thrive through collective effort. Through mentoring, peer assistance, and shared knowledge, we strengthen each other's capabilities in a safe and supportive environment. | ||
|
|
||
| It's like the hub and spokes on a bicycle wheel. CODA, the hub, is at the centre, and the connections to our affiliates are like spokes. Our members' work happens on those projects, on the rim, revolving around the coordination we provide. | ||
| **Quality** | ||
| We pursue industry-leading documentation standards, supporting contributors at their current level and facilitating professional development through experience in established projects. | ||
|
|
||
|  | ||
| --- |
There was a problem hiding this comment.
Let’s create a new page titled “Our values” for this section, as suggested by @degville in his branch. We can place the new page after the "Our vision" page.
| ## Our Vision for Your Journey at CODA | ||
|  |
There was a problem hiding this comment.
As mentioned earlier, we use sentence case for headings. Please see the Headings section of the Canonical Documentation Style Guide.
Also, it would be nice to have a blank line after every heading. This makes it clearer to read the markdown version.
Updated the vision and mission statements for clarity and coherence, moving values to new file.
Removed the section detailing the vision for member journeys at CODA.
Revised wording to emphasize community building in open source.
|
Hi @activus-d, I have made the changes you requested. I can squash all changes, if necessary, after all edits are done. Thanks. |
activus-d
left a comment
There was a problem hiding this comment.
Great work on this, @NaraHita. I have made some new suggestions, nothing major, just a few minor points to improve the document. Once you have implemented them, you may need to wait for other community members to review it before it's merged.
| __Documentation accessible to all. Contribution possible for everyone. Leadership within reach.__ | ||
|
|
There was a problem hiding this comment.
We can remove this part.
| __Documentation accessible to all. Contribution possible for everyone. Leadership within reach.__ |
There was a problem hiding this comment.
Hi @activus-d, I think a highlighted main point would help readers grasp the essence of the para to come. Can we leave this in for 1 more reviewer to look at?
There was a problem hiding this comment.
Yes, we can! Another community member will review the PR soon. Great job so far @NaraHita
| __Documentation accessible to all. Contribution possible for everyone. Leadership within reach.__ | ||
|
|
||
| The world of open source collaboration is diverse. There's no singular vision or definition of the idea, meaning that different people and projects hold different values and practice it differently. A person's introduction to it might not always be compassionate or helpful, and many people have rocky starts. There are a few different explanations for this. | ||
| At CODA—the Canonical Open Documentation Academy—we envision a future where *quality documentation forms the foundation and lifeblood of open-source ecosystems*. We see a world where *clear, accessible, and thoughtful content demystifies technology*. This environment welcomes both newcomers and experienced contributors from every corner of the globe. Together, we commit to build a collaborative and innovative community where open source thrives for generations to come. |
There was a problem hiding this comment.
Let’s introduce the full name first and put the abbreviation in parentheses. After that, we can use the abbreviation CODA throughout the rest of the document.
Also, we can make it more concise by removing the last sentence.
| At CODA—the Canonical Open Documentation Academy—we envision a future where *quality documentation forms the foundation and lifeblood of open-source ecosystems*. We see a world where *clear, accessible, and thoughtful content demystifies technology*. This environment welcomes both newcomers and experienced contributors from every corner of the globe. Together, we commit to build a collaborative and innovative community where open source thrives for generations to come. | |
| At the Canonical Open Documentation Academy (CODA), we envision a future where quality documentation is the foundation of open-source ecosystems. We see a world where clear, accessible, and thoughtful content demystifies technology and creates an environment that welcomes contributors of all experience levels. |
There was a problem hiding this comment.
The last sentence feels important to me. Can we leave it for one more reviewers to look at. Thnx.
There was a problem hiding this comment.
That’s fine, @NaraHita. Another community member will review the PR soon. Great job so far!
Co-authored-by: Damilola Oladele <98895460+activus-d@users.noreply.github.com>
Updated the vision and mission statements for clarity and consistency.
Improving the Initial Draft for CODA Vision Page.