Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs...

23
Presented by Adam Samalik Fedora Classroom Writing Fedora documentation 101

Transcript of Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs...

Page 1: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Presented by Adam Samalik

Fedora Classroom Writing Fedora documentation 101

Page 2: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Agenda

• Introduction — The new site

• Antora — The build engine

• Git — The source control

• How — The complete workflow

• Q&A

Page 3: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Introduction The new site

Page 4: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

website tour

Page 5: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Antora The build engine

Page 6: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Docs Website

Component

Menu

Page

Page

Page

Component

Menu

Page

Page

Page

The Structure

Page 7: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Docs Website

Component : Version

Component : Version

Component : Version

ModulePage

Page

Component : Version

ModulePage

Page

ModulePage

PageMenu

Menu

Page 8: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Docs WebsiteAntora 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

https://pagure.io/fedora-docs/docs-fp-o
Page 9: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

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

https://pagure.io/fedora-docs/template
Page 10: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Virtual Catalog of all Pages

page ID

Page 11: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Git The source control

Page 12: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

1) Git structure • repository, commit, branch

2) Working with your repository • clone, commit, push, pull

3) Contributing to other repositories • fork, pull-request, merge

Page 13: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Installation Guide Repository

commit

commit

commit

commit

commit

commit

commit

commit

commit

commitf27

branch

master branch

f28 branch

Git StructureHEAD

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

Page 14: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Installation Guide Repository

commit

commit

commit

commit

commit

commit

commit

commit

commit

commitf27

branch

master branch

f28 branch

Working with your repositoryHEAD

$ git clone <URL>

$ git log --graph --all --decorate

$ git checkout <BRANCH>

$ git status

$ git add <FILES>

$ git commit -m <MESSAGE>

$ git push

Page 15: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Installation Guide Repository

commit

commit

commit

commit

commit

commit

commit

commit

commit

commitf27

branch

master branch

f28 branch

Contributing to other repos…

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

Page 16: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Installation Guide Repository

commit

commit

commit

commit

commit

commit

commit

commit

commit

commitf27

branch

master branch

f28 branch

Your fork of the Installation Guide

Repository

commit

commit

commit

commit commit

commitcommit

commit

commit

commit

f28 branch

master branch

f27 branch

1) Make a Fork

Page 17: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Installation Guide Repository

commit

commit

commit

commit

commit

commit

commit

commit

commit

commitf27

branch

master branch

f28 branch

Your fork of the Installation Guide

Repository

commit

commit

commit

commit commit

commitcommit

commit

commit

commit

f28 branch

master branch

f27 branch

Let’s make a change

in f27

Page 18: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Installation Guide Repository

commit

commit

commit

commit

commit

commit

commit

commit

commit

commitf27

branch

master branch

f28 branch

Your fork of the Installation Guide

Repository

commit

commit

commit

commit commit

commitcommit

commit

commit

commit

f28 branch

master branch

f27 branch

add-something branch

2) New Branch

Page 19: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Installation Guide Repository

commit

commit

commit

commit

commit

commit

commit

commit

commit

commitf27

branch

master branch

f28 branch

Your fork of the Installation Guide

Repository

commit

commit

commit

commit commit

commitcommit

commit

commit

commit

f28 branch

master branch

f27 branch

add-something branch

commit

3) make changes, commit

Page 20: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

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

commitcommit

commit

commit

commit

f28 branch

master branch

f27 branch

add-something branch

commitcommit

4) Pull-request

Page 21: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

How The complete

workflow

Page 22: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

Demo: Making a change to the Modularity docs

Page 23: Fedora Classroom · 2018. 8. 13. · Git repository: Fedora Council Docs Git repository: Quick Docs Git repository: Mentored Projects Git repository: Fedora Modularity Git repository:

#fedora-docs (FreeNode)[email protected]

Fedora Docs: https://docs.fedoraproject.org

Thank you!

Sources: https://pagure.io/fedora-docs

Feedback: https://goo.gl/forms/t63JjvUrT8Po3IOy1

https://pagure.io/fedora-docs/docs-fp-o
https://docs.fedoraproject.org
https://pagure.io/fedora-docs
https://goo.gl/forms/t63JjvUrT8Po3IOy1

Transferring Learning Objects through Fedora Repository Patrick Roth and Laurent Opprecht January 13, 2011.

Transferring Learning Objects through Fedora Repository Patrick Roth and Laurent Opprecht January 13, 2011.

new repository – clone · Initialized empty Git repository abaj ric@nb01 — Terminal git-demo . git in /home/abaj ric/git-demo.git/ Terminal abajric@nb01 -/git-demo-local S git

new repository – clone · Initialized empty Git repository abaj ric@nb01 — Terminal git-demo . git in /home/abaj ric/git-demo.git/ Terminal abajric@nb01 -/git-demo-local S git

Git for Developers - CollabNet · repository . Copy of your project with full history : remote . A repository on another computer that you cloned .git . Directory where repository

Git for Developers - CollabNet · repository . Copy of your project with full history : remote . A repository on another computer that you cloned .git . Directory where repository

Git: Introduction Commands. 1. Create a folder and change into it 2. git init Creating local git repository. Git and files • Git keeps track of files and changes within them •

Git: Introduction Commands. 1. Create a folder and change into it 2. git init Creating local git repository. Git and files • Git keeps track of files and changes within them •

ETD Repository: Drupal, Solr Islandora, and Fedora … Repository: Drupal, Solr, Islandora, and Fedora Commons Aaron Collie, Devin Higgins, Lucas Mak, Shawn Nicholson Library Collections

ETD Repository: Drupal, Solr Islandora, and Fedora … Repository: Drupal, Solr, Islandora, and Fedora Commons Aaron Collie, Devin Higgins, Lucas Mak, Shawn Nicholson Library Collections

Modernising DiVA : The Integration of the Fedora Repository Software

Modernising DiVA : The Integration of the Fedora Repository Software

GIT AND GITHUB, C++ DATA TYPES BASIC CONTROL FLOW · What is Git and Github? •Git is an example of “version control” •Git performs version control on “repositories” •Repository

GIT AND GITHUB, C++ DATA TYPES BASIC CONTROL FLOW · What is Git and Github? •Git is an example of “version control” •Git performs version control on “repositories” •Repository

AnIntroduction to Git-researchcomputing.github.io/meetup_spring_2014/pdfs/git_tutorial.pdf · Git-• Git operates so that each working copy carries its own repository with it (found

AnIntroduction to Git-researchcomputing.github.io/meetup_spring_2014/pdfs/git_tutorial.pdf · Git-• Git operates so that each working copy carries its own repository with it (found

Cloud Digital Repository Automation...- Fedora 4 using Amazon Web Services (AWS). A working CICD deployment staging server for Fedora 4 allows for the Fedora to maintain a streamlined

Cloud Digital Repository Automation...- Fedora 4 using Amazon Web Services (AWS). A working CICD deployment staging server for Fedora 4 allows for the Fedora to maintain a streamlined

How to configure a Git repository and push to a remote repository…

How to configure a Git repository and push to a remote repository…

A brief introduction to git & GitHubkbroman/presentations/Git...git clone git@github.com:username/repo Change things locally, git add, git commit Push your changes to your GitHub repository

A brief introduction to git & GitHubkbroman/presentations/Git...git clone [email protected]:username/repo Change things locally, git add, git commit Push your changes to your GitHub repository

Fedora 4 The Incredible Shrinking Repository Esmé Cowles Code4Lib Raleigh, NC 2014-03-26.

Fedora 4 The Incredible Shrinking Repository Esmé Cowles Code4Lib Raleigh, NC 2014-03-26.

Gitana: a SQL-based Git Repository Inspector

Gitana: a SQL-based Git Repository Inspector

GIT & GITHUB · 2019-11-26 · $ git init: git 저장소(Repository) 생성, 작업하는 환경의 가장 상위폴더에서 실행 GIT으로 버전 관리 시작하기: git init

GIT & GITHUB · 2019-11-26 · $ git init: git 저장소(Repository) 생성, 작업하는 환경의 가장 상위폴더에서 실행 GIT으로 버전 관리 시작하기: git init

Version Control with Git - lucydot.github.io · Configuring Git • git config Creating a repository • git init, git status Tracking the changes to your files • git add, git commit,

Version Control with Git - lucydot.github.io · Configuring Git • git config Creating a repository • git init, git status Tracking the changes to your files • git add, git commit,

Git and GitHub€¦ · Git Branches Git Rebasing Distributed Version Control. Git and GitHub GitHub is a code hosting platform for version control and collaboration ... Git repository

Git and GitHub€¦ · Git Branches Git Rebasing Distributed Version Control. Git and GitHub GitHub is a code hosting platform for version control and collaboration ... Git repository

Building Personal Collections and Networks of Digital Objects in a Fedora Repository Using VUE Anoop Kumar Nikolai Schwertner Tufts University Fedora User.

Building Personal Collections and Networks of Digital Objects in a Fedora Repository Using VUE Anoop Kumar Nikolai Schwertner Tufts University Fedora User.

Eclipse, Python, Git, and Vim - Fedora People · PDF fileEclipse, Python, Git, and Vim Oh My! Jesse Keating PRESENTED BY: ... Thread data and flow manipulation Variable data Smaller

Eclipse, Python, Git, and Vim - Fedora People · PDF fileEclipse, Python, Git, and Vim Oh My! Jesse Keating PRESENTED BY: ... Thread data and flow manipulation Variable data Smaller

Versioning of Digital Objects in a Fedora-based Repository

Versioning of Digital Objects in a Fedora-based Repository

Export from DSpace to Fedora Repository Bridge Project October 2005.

Export from DSpace to Fedora Repository Bridge Project October 2005.