Create a "Git for Writers" Article #15

Open
opened 2026-02-24 17:40:24 +00:00 by jflory7 · 1 comment
Owner

Summary

Adapt the existing Server WG Git cheat sheet into a new, broadly applicable "Git for Writers" article for the main documentation.

Background

This issue is Part 5 of 5 in Ticket #1 aimed at improving the Fedora Local Authoring System. Version control is often the biggest hurdle for non-technical writers. We want to demystify Git by providing a cheat sheet specifically tailored to the basic needs of a documentation author, leaving out complex developer-focused commands.

It is important to avoid repeating documentation that already exists. This page must focus on the specific context that a Fedora Docs Writer should need to know. It should be tailored to our tools and workflows.

Details

We want to help you succeed! If you want to take this on, please mention @jflory7, @pboy, or @pbokoc for guidance.

To complete this task:

  1. Create a new article titled "Git for Writers".
  2. Use the existing A Git cheat sheet For Server Documentation Authors as your starting point.
  3. Adjust and improve the content so it is applicable to all Fedora Docs contributors, not just the Server Working Group.
  4. Keep it focused on basic commands (clone, add, commit, push, pull).

Outcome

A friendly, accessible Git cheat sheet that empowers Fedora Docs Writer to manage their contributions without feeling overwhelmed by developer-centric Git mechanics.

# Summary Adapt the existing Server WG Git cheat sheet into a new, broadly applicable "Git for Writers" article for the main documentation. # Background This issue is **Part 5 of 5** in Ticket #1 aimed at improving the Fedora Local Authoring System. Version control is often the biggest hurdle for non-technical writers. We want to demystify Git by providing a cheat sheet specifically tailored to the basic needs of a documentation author, leaving out complex developer-focused commands. It is important to avoid repeating documentation that already exists. This page must focus on the specific context that a Fedora Docs Writer should need to know. It should be tailored to our tools and workflows. # Details We want to help you succeed! If you want to take this on, please mention **@jflory7**, **@pboy**, or **@pbokoc** for guidance. To complete this task: 1. Create a new article titled "Git for Writers". 2. Use the existing [A Git cheat sheet For Server Documentation Authors](https://docs.fedoraproject.org/en-US/server-working-group/usr-docs-maintenance/gitcheatsheet-for-authors/) as your starting point. 3. Adjust and improve the content so it is applicable to all Fedora Docs contributors, not just the Server Working Group. 4. Keep it focused on basic commands (clone, add, commit, push, pull). # Outcome A friendly, accessible Git cheat sheet that empowers Fedora Docs Writer to manage their contributions without feeling overwhelmed by developer-centric Git mechanics.
jflory7 self-assigned this 2026-02-24 17:40:24 +00:00
egret added this to the (deleted) project 2026-04-22 08:34:03 +00:00
Member

Just adding https://learngitbranching.js.org/ as a potentially useful resource to reference in the article. It visually explains Git branching in an interactive way, which could help writers new to Git.

Just adding https://learngitbranching.js.org/ as a potentially useful resource to reference in the article. It visually explains Git branching in an interactive way, which could help writers new to Git.
Sign in to join this conversation.
No milestone
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Reference
docs/tickets#15
No description provided.