09-09-2023, 08:08 AM
Fedora - Docs workshop: Virtually writing together
<div><p>At the Fedora Linux 38 release party, the Docs team suggested that we take advantage of a virtual meetup to bring teamwork into documentation writing. Documentation writing shouldn’t be a solitary pursuit. </p>
<p>An interactive session at <a href="https://pboy.fedorapeople.org/Flock2023-Docs-talk.pdf" target="_blank" rel="noreferrer noopener">Flock 2023</a> helped exchange ideas on a collaborative way to run meetings and invite more contributions for documentation. </p>
<p>After months of waiting for ideas to be finalized, the Docs team is pleased to announce the workshop will begin September 2023.</p>
<p>If you fancy coming along, just let us know your preferred timeslot in the <strong><a href="https://whenisgood.net/qrnxqwp" target="_blank" rel="noreferrer noopener">When-is-good scheduler</a> by September 15 2023</strong>.</p>
<h3 class="wp-block-heading">But why and how?</h3>
<p>The idea behind a virtual writing session is to combine the power of the Fedora Podcast with advocacy of writing and maintaining excellent user documentation. Here is why.</p>
<ul>
<li>Documentation in any free and open source software project provides reasons for users and contributors to stay loyal to the project and software.</li>
<li>The Docs workshop aims to facilitate individual and collaborative work through a supportive community of documentarians.</li>
<li>Documentation is more than a fix of visual presentation. We’re writing, reviewing, and deploying docs.</li>
<li>In accordance with the Fedora project motto “First”, we like to try new things in toolset, automation, and UI improvement.</li>
</ul>
<p>Building on feedback from each session, the Docs team wants to empower people to learn about templates, issue tickets, review processes, and tool chains to improve documentation for Fedora Linux users and contributors.</p>
<p> <span id="more-38668"></span> </p>
<h3 class="wp-block-heading">Program agenda</h3>
<p>A monthly agenda will be posted in <a href="https://calendar.fedoraproject.org/docs/">Fedocal</a> and Fosstodon (@[email protected]).</p>
<p><strong>Track 1: Introduction and onboarding (odd months)<br /></strong>– What the Docs team is all about. What role will interest you?<br />– The types of user documentation Fedora Linux publishes<br />– How you can help improve Fedora Documentation.</p>
<p><strong>Track 2: Skill-based workshop (even months)<br /></strong>– Technical review, Git workshop, AsciiDoc template and attributes<br />– Use of local build and preview script<br />– Test documentation quality</p>
<p>Format of Track 2<br />– Demo<br />– Try it yourself<br />– Q&A</p>
<p>If you come along to the Track 2 workshop, all you need is a <a href="https://accounts.fedoraproject.org/">Fedora account</a> and <a href="https://pagure.io/">Pagure account</a> with your computer, preferably with Git and Podman (or Docker) installed.</p>
<p>In the meantime, if you have questions, feel free to drop by our <a href="https://discussion.fedoraproject.org/t/write-together-virtually/82564" target="_blank" rel="noreferrer noopener">Discussion</a> forum. I’m looking forward to saying hello at our first virtual docs workshop someday in late September (the exact date depends on the when-is-good responses)! Let’s do it!</p>
</div>
https://www.sickgaming.net/blog/2023/08/...-together/
<div><p>At the Fedora Linux 38 release party, the Docs team suggested that we take advantage of a virtual meetup to bring teamwork into documentation writing. Documentation writing shouldn’t be a solitary pursuit. </p>
<p>An interactive session at <a href="https://pboy.fedorapeople.org/Flock2023-Docs-talk.pdf" target="_blank" rel="noreferrer noopener">Flock 2023</a> helped exchange ideas on a collaborative way to run meetings and invite more contributions for documentation. </p>
<p>After months of waiting for ideas to be finalized, the Docs team is pleased to announce the workshop will begin September 2023.</p>
<p>If you fancy coming along, just let us know your preferred timeslot in the <strong><a href="https://whenisgood.net/qrnxqwp" target="_blank" rel="noreferrer noopener">When-is-good scheduler</a> by September 15 2023</strong>.</p>
<h3 class="wp-block-heading">But why and how?</h3>
<p>The idea behind a virtual writing session is to combine the power of the Fedora Podcast with advocacy of writing and maintaining excellent user documentation. Here is why.</p>
<ul>
<li>Documentation in any free and open source software project provides reasons for users and contributors to stay loyal to the project and software.</li>
<li>The Docs workshop aims to facilitate individual and collaborative work through a supportive community of documentarians.</li>
<li>Documentation is more than a fix of visual presentation. We’re writing, reviewing, and deploying docs.</li>
<li>In accordance with the Fedora project motto “First”, we like to try new things in toolset, automation, and UI improvement.</li>
</ul>
<p>Building on feedback from each session, the Docs team wants to empower people to learn about templates, issue tickets, review processes, and tool chains to improve documentation for Fedora Linux users and contributors.</p>
<p> <span id="more-38668"></span> </p>
<h3 class="wp-block-heading">Program agenda</h3>
<p>A monthly agenda will be posted in <a href="https://calendar.fedoraproject.org/docs/">Fedocal</a> and Fosstodon (@[email protected]).</p>
<p><strong>Track 1: Introduction and onboarding (odd months)<br /></strong>– What the Docs team is all about. What role will interest you?<br />– The types of user documentation Fedora Linux publishes<br />– How you can help improve Fedora Documentation.</p>
<p><strong>Track 2: Skill-based workshop (even months)<br /></strong>– Technical review, Git workshop, AsciiDoc template and attributes<br />– Use of local build and preview script<br />– Test documentation quality</p>
<p>Format of Track 2<br />– Demo<br />– Try it yourself<br />– Q&A</p>
<p>If you come along to the Track 2 workshop, all you need is a <a href="https://accounts.fedoraproject.org/">Fedora account</a> and <a href="https://pagure.io/">Pagure account</a> with your computer, preferably with Git and Podman (or Docker) installed.</p>
<p>In the meantime, if you have questions, feel free to drop by our <a href="https://discussion.fedoraproject.org/t/write-together-virtually/82564" target="_blank" rel="noreferrer noopener">Discussion</a> forum. I’m looking forward to saying hello at our first virtual docs workshop someday in late September (the exact date depends on the when-is-good responses)! Let’s do it!</p>
</div>
https://www.sickgaming.net/blog/2023/08/...-together/