RepoMirrors
/
ceph
mirror of https://github.com/ceph/ceph
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ceph/doc/dev/developer_guide/index.rst

24 lines
792 B
ReStructuredText
Raw Normal View History

doc/dev/index.rst: fix headings This commit fixes the headings so they render properly on http://ceph.com Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-02 23:30:24 +00:00
============================================
Contributing to Ceph: A Guide for Developers
============================================
Doc: deleted gratuitious PlanningImplementation.html, which was a copy of PlanningImplementation.txt (and not html at all). restored previous index.rst, which was overwritten with a copy of PlanninImplementation.txt, but removed all of the recursively included content from the document. I will cherry-pick merge the new contents in a subsequent commit. Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
2011-12-01 23:29:00 +00:00
doc/dev/index.rst: begin writing Contributing to Ceph Replace existing index.rst with the beginnings of a comprehensive developer guide. Move the old index.rst to index-old.rst. Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-11-29 23:51:11 +00:00
:Author: Loic Dachary
:Author: Nathan Cutler
legal: remove doc license ambiguity The license applicable to the files under doc/ was originally declared (in the top-level file COPYING) to be "Creative Commons Attribution-ShareAlike (CC BY-SA)" by ed0653b493a3f919a3abc37a0aa9b5aa29ae0b0e This license declaration omitted a version number. Some time later ef7418421b3748c712019c8aedd02b8005c1e1ea was merged, mentioning CC-BY-SA-1.0 as one of the Ceph source code licenses. Although the purpose of that commit was only to summarize the canonical license information from COPYING, it unintentionally became the only place in the source code where the doc license version was specified. In March 2018, the Debian project warned that CC-BY-SA-1.0 does not meet its criteria for inclusion in the "free" section of the Debian distribution. (For that, at least version 3.0 must be used.) This new commit removes the doc license ambiguity by setting it to CC-BY-SA-3.0 in all places where the license is mentioned. The exact spelling of the license name is taken from https://spdx.org/licenses/ Fixes: http://tracker.ceph.com/issues/23336 Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-03-13 16:36:00 +00:00
:License: Creative Commons Attribution Share Alike 3.0 (CC-BY-SA-3.0)
doc/dev/index.rst: begin writing Contributing to Ceph Replace existing index.rst with the beginnings of a comprehensive developer guide. Move the old index.rst to index-old.rst. Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-11-29 23:51:11 +00:00
doc: make it easier to reach the old dev doc TOC Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-07-26 04:21:04 +00:00
.. note:: You may also be interested in the :doc:`/dev/internals` documentation.
doc/dev/index.rst: begin writing Contributing to Ceph Replace existing index.rst with the beginnings of a comprehensive developer guide. Move the old index.rst to index-old.rst. Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-11-29 23:51:11 +00:00
doc: split index.rst of dev guide Move every section to a different file. Also, fix minor issues like line-wrapping along. Signed-off-by: Rishabh Dave <ridave@redhat.com>
2020-01-06 07:40:50 +00:00
.. toctree::
:maxdepth: 1
Introduction <intro>
Essentials <essentials>
What is Merged and When <merging>
Issue tracker <issue-tracker>
Basic workflow <basic-workflow>
Tests: Unit Tests <tests-unit-tests>
Tests: Integration Tests <tests-integration-tests>
Running Tests Locally <running-tests-locally>
Running Integration Tests using Teuthology <running-tests-using-teuth>
Running Tests in the Cloud <running-tests-in-cloud>