The Documentation Project produces documentation written in DocBook XML. Earlier documentation used a CVS instance for collaboration. The DocBook XML files are now maintained in git repositories, which provide better features and future proofing. DocBook XML documentation can be built into HTML and other formats for use on the Web and in Fedora itself.
You can help maintain content on the wiki, but it is also helpful to know how to make changes in this repository as well. The following guide will show you, step by step, how to do that.
publican-fedora packages with
su -c 'yum install git-all publican-fedora'
Create your global
git config --global user.name 'John Doe' git config --global user.email 'firstname.lastname@example.org' git config --global color.diff auto git config --global color.status auto git config --global color.branch auto
Getting a Copy of the Files
To get a copy of a module, in this example the
install-guide project for the source of the Fedora Installation Guide:
mkdir projects cd projects git clone git://git.fedorahosted.org/git/docs/install-guide.git
A copy of the files from this repository are now in the
install-guide directory in your current working directory.
Using the Right Branch
git branches to separate releases of any guides that are tied to specific Fedora releases. For instance, the Installation Guide has multiple active versions at any one time. Right now, those versions are 26, 27, and 28. (Releases for Fedora 28 will be on the main or "master" branch.)
Before you start working, make sure you are on the proper branch (f26, f27, or master) using one of these commands:
cd install-guide git checkout <branch>
git application uses branches in a novel way, to allow you to keep your work separated from the files that you just retrieved. You should always make a branch of the files and do your work there. Then after you've done appropriate testing, you can merge those changes into the branch you retrieved and send them to the maintainers via email, or (if you have access) push them back to the repository here.
First, make a branch called "mywork" and move onto it to do your actual work:
cd install-guide git checkout -b mywork
(Note this doesn't retrieve files, it puts you on the new
mywork branch you created. To check that you've moved branches, you can use the
git branch command again:
Now make a desired change. Remember that you don't want to make a bunch of changes at one time -- make one meaningful change (like cleaning up one file, or cleaning up one issue that happens in a number of files) at a time.
To check the status of your branch (how it differs from the last recorded change), run the
git status command. If you need to add or delete files, use the
git add or
git rm commands. To rename or relocate a file, use the
git mv command.
Once you've finished making a meaningful change, commit it.
git commit -a -m 'Some short message about the commit'
The commit goes to your local branch, not back up to the server as in some other version control systems.
Once you have finished with all the changes, DOUBLE CHECK THEM! Don't go any further until the changes you made to the Release Notes produce a fully working document. Run a validation test to check (this example is using the original "en_US" language):
If everything works, you can email your changes back to the maintainers even if you're not authorized to write to the repository:
git-format-patch -o /tmp/mywork origin
This puts a series of patch files in the new directory
/tmp/mywork. Then you can email those patch files to the maintainers.
Merging and Pushing (Authorized Version)
If you're authorized, you can send your commits back to the repository. To push the results up to the repository here at Fedora Hosted:
git push origin master
If you mistakenly used
git:// for cloning instead of
git+ssh://, you can fix that by editing the
.git/config file before pushing.
- http://excess.org/article/2008/07/ogre-git-tutorial/ -- complete tutorial that includes an explanation of SCM (source code management)