Ceph, Release dev
For example:
git config --global user.name "John Doe"
git config --global user.email johndoe@example.com
3. Create a github account (if you don’t have one).
4. Fork the Ceph project. See https://github.com/ceph/ceph.
5. Clone your fork of the Ceph project to your local host.
Ceph organizes documentation into an information architecture primarily by its main components.
• Ceph Storage Cluster: The Ceph Storage Cluster documentation resides under the doc/rados directory.
• Ceph Block Device: The Ceph Block Device documentation resides under the doc/rbd directory.
• Ceph Object Storage: The Ceph Object Storage documentation resides under the doc/radosgw directory.
• Ceph Filesystem: The Ceph Filesystem documentation resides under the doc/cephfs directory.
• Installation (Quick): Quick start documentation resides under the doc/start directory.
• Installation (Manual): Manual installation documentation resides under the doc/install directory.
• Manpage: Manpage source resides under the doc/man directory.
• Developer: Developer documentation resides under the doc/dev directory.
• Images: If you include images such as JPEG or PNG files, you should store them under the doc/images
directory.
Select a Branch
When you make small changes to the documentation, such as fixing typographical errors or clarifying explanations,
use the master branch (default). You should also use the master branch when making contributions to features
that are in the current release. master is the most commonly used branch.
git checkout master
When you make changes to documentation that affect an upcoming release, use the next branch. next is the second
most commonly used branch.
git checkout next
When you are making substantial contributions such as new features that are not yet in the current release; if your
contribution is related to an issue with a tracker ID; or, if you want to see your documentation rendered on the
Ceph.com website before it gets merged into the master branch, you should create a branch. To distinguish
branches that include only documentation updates, we prepend them with wip-doc by convention, following the
form wip-doc-{your-branch-name}. If the branch relates to an issue filed in http://tracker.ceph.com/issues,
the branch name incorporates the issue number. For example, if a documentation branch is a fix for is-
sue #4000, the branch name should be wip-doc-4000 by convention and the relevant tracker URL will be
http://tracker.ceph.com/issues/4000.
Note: Please do not mingle documentation contributions and source code contributions in a single pull request.
Editors review the documentation and engineers review source code changes. When you keep documentation pull
requests separate from source code pull requests, it simplifies the process and we won’t have to ask you to resubmit
the requests separately.
Before you create your branch name, ensure that it doesn’t already exist in the local or remote repository.
1.4. Documenting Ceph 13