Fedora Classroom Writing Fedora documentation 101 Presented by Adam - PowerPoint PPT Presentation

Fedora Classroom Writing Fedora documentation 101 Presented by Adam Samalik

Agenda • Introduction — The new site • Antora — The build engine • Git — The source control • How — The complete workflow • Q&A

Introduction The new site

website tour

Antora The build engine

The Structure Docs Website Component Page Menu Page Page Component Page Menu Page Page

Docs Website Component : Version Component : Version Module Page Page Menu Module Page Page Component : Version Component : Version Module Page Menu Page

The Sources Git repository: Installation Guide Git repository: Release Notes Git repository: System Admins Guide Git repository: Fedora Council Docs Git repository: Quick Docs Antora Builder Docs Website Git repository: Mentored Projects Git repository: Fedora Modularity Git repository: Remix Building https://pagure.io/fedora-docs/docs-fp-o Git repository: CommOps

Source Structure 1) Component metadata 2, 3, 4) Local preview 5) Module 6) Images 7) Menu definition 8) Pages https://pagure.io/ fedora-docs/template

Virtual Catalog of all Pages page ID

Git The source control

1) Git structure • repository, commit, branch 2) Working with your repository • clone, commit, push, pull 3) Contributing to other repositories • fork, pull-request, merge

master Git Structure branch f28 branch commit HEAD commit commit f27 branch commit commit Repository — The place your source lives in commit commit Commit — A unit of change to the source Branch — A version / variant of the source commit commit HEAD — The current view commit Installation Guide Repository

Working with master branch your repository f28 branch commit HEAD commit commit $ git clone <URL> f27 branch commit commit $ git log --graph --all --decorate commit commit $ git checkout <BRANCH> commit commit $ git status commit $ git add <FILES> $ git commit -m <MESSAGE> $ git push Installation Guide Repository

Contributing master branch to other repos… f28 branch commit commit commit f27 branch commit commit commit commit 1) Make a fork commit commit 2) New branch 3) Make changes, commit commit 4) Pull-request Installation Guide Repository

master master branch branch 1) Make a Fork f28 f28 branch branch commit commit commit commit commit commit f27 f27 branch branch commit commit commit commit commit commit commit commit commit commit commit commit commit commit Your fork of the Installation Guide Installation Guide Repository Repository

Let’s make master master branch branch a change f28 f28 branch in f27 branch commit commit commit commit commit commit f27 f27 branch branch commit commit commit commit commit commit commit commit commit commit commit commit commit commit Your fork of the Installation Guide Installation Guide Repository Repository

master master branch branch 2) New Branch f28 f28 branch branch commit commit commit commit commit commit add-something f27 branch branch commit commit commit commit f27 commit commit commit commit branch commit commit commit commit commit commit Your fork of the Installation Guide Installation Guide Repository Repository

3) make changes, master master branch branch commit f28 f28 branch branch commit commit add-something branch commit commit commit commit f27 branch commit commit commit commit commit f27 commit commit commit commit branch commit commit commit commit commit commit Your fork of the Installation Guide Installation Guide Repository Repository

master master 4) Pull-request branch branch f28 f28 branch branch commit commit add-something f27 branch branch commit commit commit commit commit commit commit commit commit commit f27 commit commit commit commit branch commit commit commit commit commit commit Your fork of the Installation Guide Installation Guide Repository Repository

How The complete workflow

Demo: Making a change to the Modularity docs

Thank you! Feedback: https://goo.gl/forms/t63JjvUrT8Po3IOy1 Fedora Docs: https://docs.fedoraproject.org Sources: https://pagure.io/fedora-docs #fedora-docs (FreeNode) docs@lists.fedoraproject.org