Search

Tools

Creating a new guide

From FedoraProject

The term guide here refers to any piece of formal Fedora documentation maintained by the Fedora Documentation Project and published on http://docs.fedoraproject.org. Guides range from detailed manuals hundreds of pages long to short articles that describe specific tasks such as how to burn a DVD from an ISO file.

Your guide might be an entirely new piece of writing or a project that you are migrating to Fedora from elsewhere, for example, a Red Hat Enterprise Linux document that you are bringing upstream into Fedora. These instructions apply in either case.

If you are moving an existing project into Fedora, copy or move the files into this new directory. If the project was previously in a version-control system, be careful not to copy hidden directories such as .svn or .git directories. If the project was previously maintained in SVN or CVS and has multiple branches, only import the trunk at this stage. Import separate branches of the project into separate Git branches later, using the procedure described in Branching a document in git

When you have created or imported your source files, initialize the local git repository. In the directory created earlier by the git clone command, run:

git init

Now check the files into the remote repository. In the directory created earlier by the git clone command, run:

git add .
git commit -m"Initial check-in"
git push origin master

Request a Bugzilla component for your guide

All guides share the same product in Bugzilla: Fedora Documentation, and each one has a separate component. This is the component against which readers will file bugs and suggestions for improvement.

Open a bug in Bugzilla against the docs-requests component in the Fedora Documentation product (link)

Use the words New Bugzilla component in the Summary field, for example, New Bugzilla component for Fedora Astronomy Guide

When the new component is created, the bug will be updated with its details. Bugzilla components for Fedora documentation usually take the form of the title of the book in lower case, with words separated by dashes. For example: astronomy-guide

When you know the name of your Bugzilla component, be sure to update the BOOKID entity in the entity file of your book. For example:

Red Hat, Red Hat Enterprise Linux, the Shadowman logo, and JBoss are trademarks or registered trademarks of
Red Hat, Inc. or its subsidiaries in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.
The Fedora Project is maintained and driven by the community and sponsored by Red Hat. This is a community
maintained site. Red Hat is not responsible for content.