docs/tickets

Revise "Create a new documentation module" Article #12

New issue

Open

opened 2026-02-24 17:36:35 +00:00 by jflory7 · 1 comment

jflory7 commented

2026-02-24 17:36:35 +00:00

Owner

Summary

Update the "Create a new documentation module" article to emphasize the local authoring workflow.

Background

This issue is Part 2 of 5 in Ticket #1 to simplify the Fedora Local Authoring System instructions. Creating a new module is a core task for documentation writers, but the current instructions can feel heavy. By tailoring this guide to the local authoring method, we can make it significantly easier for contributors to spin up new content.

Details

This is a mentored issue! If you need help getting started, please reach out to @jflory7, @pboy, or @pbokoc here in the comments.

To complete this task, update the Create a new documentation module article:

Shift the primary focus of the guide to using the local authoring environment.
Leave the legacy processes in place, but prominently add a warning that those sections are "outdated".
Ensure the tone is encouraging and straightforward.

Outcome

Clearer, modern instructions for module creation that rely on the simplified local workflow rather than legacy systems.

# Summary Update the ["Create a new documentation module" article](https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/contrib-new-documentation/) to emphasize the local authoring workflow. # Background This issue is **Part 2 of 5** in Ticket #1 to simplify the Fedora Local Authoring System instructions. Creating a new module is a core task for documentation writers, but the current instructions can feel heavy. By tailoring this guide to the local authoring method, we can make it significantly easier for contributors to spin up new content. # Details This is a mentored issue! If you need help getting started, please reach out to **@jflory7**, **@pboy**, or **@pbokoc** here in the comments. To complete this task, update the [Create a new documentation module](https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/contrib-new-documentation/) article: 1. Shift the primary focus of the guide to using the local authoring environment. 2. Leave the legacy processes in place, but prominently add a warning that those sections are "outdated". 3. Ensure the tone is encouraging and straightforward. # Outcome Clearer, modern instructions for module creation that rely on the simplified local workflow rather than legacy systems.

jflory7 self-assigned this

2026-02-24 17:36:35 +00:00

pbokoc was assigned by jflory7

2026-02-24 17:36:35 +00:00

pboy was assigned by jflory7

2026-02-24 17:36:35 +00:00

jflory7 added a new dependency

2026-02-24 17:40:57 +00:00

#1 Improvement of the instructions for the Fedora Local Authoring System.

jflory7 added the

good first issue

help wanted

labels

2026-02-24 17:54:34 +00:00

egret added this to the (deleted) project

2026-04-22 08:33:03 +00:00

pbokoc added the

labels

2026-05-29 12:24:05 +00:00

egret modified the project from (deleted) to Improving the Contributor’s Guidance

2026-06-03 12:05:58 +00:00

pboy added the

Contributors' Guidance

Improve written Material

label

2026-06-28 17:37:54 +00:00

pboy commented

2026-06-30 11:34:10 +00:00

Owner

This document covers the creation of a new module, for example when completely new documentation needs to be produced for a new edition. It goes far beyond the ‘normal’ process of contributing content. It should be moved from its current central location.

pboy added

and removed

labels