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

▶
fedora classroom writing fedora documentation 101
SMART_READER_LITE
LIVE PREVIEW

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

Sep 13, 2023 101 likes •352 views

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

slide-1
SLIDE 1

Presented by Adam Samalik

Fedora Classroom Writing Fedora documentation 101

slide-2
SLIDE 2

Agenda

  • Introduction — The new site
  • Antora — The build engine
  • Git — The source control
  • How — The complete workflow
  • Q&A
slide-3
SLIDE 3

Introduction The new site

slide-4
SLIDE 4

website tour

slide-5
SLIDE 5

Antora The build engine

slide-6
SLIDE 6

Docs Website Component Menu

Page Page Page

Component Menu

Page Page Page

The Structure

slide-7
SLIDE 7

Docs Website Component : Version Component : Version Component : Version Module

Page Page

Component : Version Module

Page Page

Module

Page Page

Menu Menu

slide-8
SLIDE 8

Docs Website Antora Builder Git repository: Installation Guide Git repository: Release Notes Git repository: System Admins Guide Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository: Remix Building Git repository: CommOps

https://pagure.io/fedora-docs/docs-fp-o

The Sources

slide-9
SLIDE 9

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

Source Structure

slide-10
SLIDE 10

Virtual Catalog of all Pages

page ID

slide-11
SLIDE 11

Git The source control

slide-12
SLIDE 12

1) Git structure

  • repository, commit, branch

2) Working with your repository

  • clone, commit, push, pull

3) Contributing to other repositories

  • fork, pull-request, merge
slide-13
SLIDE 13

Installation Guide Repository commit commit commit commit commit commit commit commit commit commit f27 branch master branch f28 branch

Git Structure

HEAD

Repository — The place your source lives in Commit — A unit of change to the source Branch — A version / variant of the source HEAD — The current view

slide-14
SLIDE 14

Installation Guide Repository commit commit commit commit commit commit commit commit commit commit f27 branch master branch f28 branch

Working with your repository

HEAD

$ git clone <URL> $ git log --graph --all --decorate $ git checkout <BRANCH> $ git status $ git add <FILES> $ git commit -m <MESSAGE> $ git push

slide-15
SLIDE 15

Installation Guide Repository commit commit commit commit commit commit commit commit commit commit f27 branch master branch f28 branch

Contributing to other repos…

1) Make a fork 2) New branch 3) Make changes, commit 4) Pull-request

slide-16
SLIDE 16

Installation Guide Repository commit commit commit commit commit commit commit commit commit commit f27 branch master branch f28 branch Your fork of the Installation Guide Repository commit commit commit commit commit commit commit commit commit commit f28 branch master branch f27 branch

1) Make a Fork

slide-17
SLIDE 17

Installation Guide Repository commit commit commit commit commit commit commit commit commit commit f27 branch master branch f28 branch Your fork of the Installation Guide Repository commit commit commit commit commit commit commit commit commit commit f28 branch master branch f27 branch

Let’s make a change in f27

slide-18
SLIDE 18

Installation Guide Repository commit commit commit commit commit commit commit commit commit commit f27 branch master branch f28 branch Your fork of the Installation Guide Repository commit commit commit commit commit commit commit commit commit commit f28 branch master branch f27 branch add-something branch

2) New Branch

slide-19
SLIDE 19

Installation Guide Repository commit commit commit commit commit commit commit commit commit commit f27 branch master branch f28 branch Your fork of the Installation Guide Repository commit commit commit commit commit commit commit commit commit commit f28 branch master branch f27 branch add-something branch commit

3) make changes, commit

slide-20
SLIDE 20

Installation Guide Repository commit commit commit commit commit commit commit commit commit commit f27 branch master branch f28 branch Your fork of the Installation Guide Repository commit commit commit commit commit commit commit commit commit commit f28 branch master branch f27 branch add-something branch commit commit

4) Pull-request

slide-21
SLIDE 21

How The complete workflow

slide-22
SLIDE 22

Demo: Making a change to the Modularity docs

slide-23
SLIDE 23

#fedora-docs (FreeNode) docs@lists.fedoraproject.org Fedora Docs: https://docs.fedoraproject.org

Thank you!

Sources: https://pagure.io/fedora-docs Feedback: https://goo.gl/forms/t63JjvUrT8Po3IOy1