Create a "Git for Writers" Article #15
Labels
No labels
Contributors' Guidance
Improve written Material
Contributors' Guidance
technical support measures
effort
high
effort
low
effort
medium
good first issue
help wanted
meeting topic
needs changes
needs reporter feedback
needs review
priority
high
priority
low
priority
medium
priority
on hold
type/content
type/misc
No milestone
No project
2 participants
Notifications
Due date
No due date set.
Blocks
Reference
docs/tickets#15
Loading…
Add table
Add a link
Reference in a new issue
No description provided.
Delete branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
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:
Outcome
A friendly, accessible Git cheat sheet that empowers Fedora Docs Writer to manage their contributions without feeling overwhelmed by developer-centric Git mechanics.
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.