Lenz Grimmer
5378de7dc6
doc/dev: Updated component leads table
...
Signed-off-by: Lenz Grimmer <lgrimmer@suse.com>
2018-09-24 12:55:22 +02:00
Josh Durgin
2d79537236
doc/dev/index: update rados lead
...
Signed-off-by: Josh Durgin <jdurgin@redhat.com>
2018-09-19 00:26:13 -07:00
James McClune
288d9713c2
doc: used reST label for ceph-deploy reference
...
Updated ceph-deploy man page link with ref label. Fixes
404 error.
Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2018-08-16 22:17:47 -04:00
John Spray
7ad61cc032
doc: Rook/orchestrator doc fixes
...
Signed-off-by: John Spray <john.spray@redhat.com>
2018-08-07 10:13:31 -04:00
John Spray
751d32c137
doc: add development guide for Ceph+Rook in k8s
...
Signed-off-by: John Spray <john.spray@redhat.com>
2018-08-06 16:22:30 +01:00
Nathan Cutler
ef3ac5692b
doc: make it easier to reach the old dev doc TOC
...
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-07-26 10:49:11 +02:00
Alfredo Deza
1c0e179e3a
doc/dev: change ceph-disk suite examples for ceph-deploy
...
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2018-06-13 15:16:25 -04:00
Kefu Chai
776329abe1
doc: fix some redirected links reported by "build-doc linkcheck"
...
Signed-off-by: Kefu Chai <kchai@redhat.com>
2018-06-01 17:00:06 +08:00
Nathan Cutler
bdb674639d
Merge pull request #19594 from smithfarm/wip-doc-make-check
...
doc: expand developer documentation of unit tests
Reviewed-by: Lenz Grimmer <lgrimmer@suse.com>
2018-04-06 22:19:03 +02:00
Nathan Cutler
a9ba2011f6
doc: dev: improve headings within Testing chapter
...
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2018-04-06 14:18:37 +02:00
Nathan Cutler
e294dd5910
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 ed0653b493
This license declaration omitted a version number.
Some time later ef7418421b
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 18:59:02 +01:00
Nathan Cutler
fd8461b021
doc: expand developer documentation of unit tests
...
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-12-19 22:26:29 +01:00
Kefu Chai
6fb9540bd6
doc: update docs to remove references of ubuntu 14.04
...
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-12-04 15:42:56 +08:00
Kefu Chai
127d25ccbd
doc: fix warning reported by "build-doc linkcheck"
...
all the HTTP 301 (moved permanently) should be killed.
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-10-24 15:58:48 +08:00
Jos Collin
ded96388da
doc: Fix URL in Licensing
...
Fixed the unnecessary URL format in the text. Modify the URL formatting to highlight only the file name seems better.
Signed-off-by: Jos Collin <jcollin@redhat.com>
2017-09-30 07:40:01 +05:30
Jos Collin
41c4b3dbbe
doc: Fix typo and URL in Submitting patches
...
Dropped the repeated 'the' in the paragraph and Fixed the unnecessary URL format in the text.
Signed-off-by: Jos Collin <jcollin@redhat.com>
2017-09-29 20:20:33 +05:30
Sage Weil
f19214687f
doc/dev/index: update rados lead
...
Signed-off-by: Sage Weil <sage@redhat.com>
2017-08-08 13:37:42 -04:00
John Spray
ea37145131
doc: developer logging guidance
...
Signed-off-by: John Spray <john.spray@redhat.com>
2017-08-01 15:06:41 +01:00
Patrick Donnelly
f5bd6f09b5
doc: update CephFS PTL
...
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2017-07-24 10:43:45 -07:00
Nathan Cutler
b08b485ce8
Merge pull request #16079 from smithfarm/wip-doc-make-check
...
doc: dev: add notes on PR make check validation test
Reviewed-by: Loic Dachary <ldachary@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-07-09 13:14:42 +02:00
Kefu Chai
254e07441c
doc: kill sphinx warnings
...
* doc/release-notes.rst: escape asterisks not used for inline emphasis
fix bad hyper links
* doc/rados/troubleshooting/troubleshooting-osd.rst: escape asterisks
not used for inline emphasis
* doc/radosgw/index.rst: add orphan docs to toc
* doc/dev/perf_histograms.rst: indent block quote
* doc/install/manual-freebsd-deployment.rst: fix block quotes
* doc/mgr/administrator.rst: escape asterisks not used for inline emphasis
* doc/start/quick-rbd.rst: add missing hyper link target
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-07-07 11:50:33 +08:00
Nathan Cutler
5ec6c7c2c3
doc: dev: unit tests are not linked against tcmalloc
...
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-07-04 12:25:33 +02:00
Nathan Cutler
94d6012cb7
doc: dev: change "make check" into an internal Xref
...
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-07-03 15:44:30 +02:00
Nathan Cutler
7f14c6a238
doc: dev: add notes on PR make check test
...
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-07-03 15:44:27 +02:00
Sage Weil
0346998b5a
doc: recommend against btrfs
...
Signed-off-by: Sage Weil <sage@redhat.com>
2017-06-30 13:54:18 -04:00
Sage Weil
b6a5b946f8
Merge pull request #15180 from theanalyst/doc/rgw-dev-s3tests
...
doc: dev improve the s3tests doc to reflect current scripts
2017-06-09 08:32:10 -05:00
liuchang0812
998ee1d190
doc: kill some broken links
...
Signed-off-by: liuchang0812 <liuchang0812@gmail.com>
2017-06-07 16:13:45 +08:00
Kefu Chai
b85bf0e61e
doc: update sample explaning "%" operator in tes suites
...
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-06-06 20:49:51 +08:00
Abhishek Lekshmanan
8dcf8d6e5f
doc: dev: improve the s3tests with vstart document
...
update with the current qa workunits example and drop old info, also
update vstart doc dropping the -r and --num options to prefer env vars
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2017-05-19 22:49:40 +02:00
Kefu Chai
a0ee9e663a
Merge pull request #14478 from theanalyst/doc/dev/ccache
...
doc: dev add a note about ccache
Reviewed-by: Nathan Cutler <ncutler@suse.com>
Reviewed-by: Loic Dachary <ldachary@redhat.com>
Reviewed-by: Kefu Chai <kchai@redhat.com>
2017-05-09 20:46:29 +08:00
Abhishek Lekshmanan
1d9558ac42
doc: dev add a note about ccache
...
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2017-05-09 10:53:50 +02:00
Nathan Cutler
3509fa0b2a
doc: mention teuthology-worker security group
...
teuthology-openstack now creates a teuthology-worker security group, as well as
teuthology, so we need to delete that one as well when starting over.
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-04-24 16:03:37 +02:00
Nathan Cutler
0dd2dfce1d
doc: dev guide: how to run s3-tests locally against vstart
...
Add a bunch of verbiage to the Developer Guide
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-04-13 19:14:52 +02:00
Kefu Chai
059482dc25
doc/dev/index: fix sphinx warnings
...
- index.rst:822: ERROR: Unknown target name: "teuthology-suite".
add a ref to teuthology doc
- index.rst:3: WARNING: Duplicate explicit target name: "here".
use "Named hyperlink references" instead of "anonymous hyperlink
references"
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-03-16 16:39:40 +08:00
Nathan Cutler
6a0ffa22ae
doc: mention interactive task in developer guide
...
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-03-08 10:12:10 +01:00
Nathan Cutler
266fe30654
doc: rewrite Deploy a cluster for manual testing section
...
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-03-08 10:07:42 +01:00
Jan Fajerski
e0a00b3948
doc: update links to point to ceph/qa instead of ceph-qa-suite
...
Also fix two broken links to install task and two typos.
Signed-off-by: Jan Fajerski <jfajerski@suse.com>
2017-03-08 10:07:41 +01:00
Drunkard Zhang
bcb89fbe0d
doc: hyperlink typo fix in dev/index
...
The doc compiler complains about this.
Signed-off-by: Drunkard Zhang <gongfan193@gmail.com>
2017-03-02 11:04:35 +08:00
Nathan Cutler
63100b4f9b
doc: instructions for provisioning OpenStack VMs ad hoc
...
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-02-11 18:57:33 +01:00
Jan Fajerski
cc97e9d090
doc: minor change to a cloud testing paragraph
...
Use terminate for the instances to match the terminology used by the
horizon interface.
Signed-off-by: Jan Fajerski <jfajerski@suse.com>
2017-02-06 16:48:54 +01:00
Leo Zhang
5582407721
doc: drop start development cluster area in index.rst, quick_start.rst also documents this area
...
Signed-off-by: Leo Zhang <nguzcf@gmail.com>
2016-09-27 17:15:04 +08:00
Leo Zhang
ee1de7dc14
doc: fix start development cluster operation in index.rst
...
Signed-off-by: Leo Zhang <nguzcf@gmail.com>
2016-09-27 15:43:07 +08:00
Nathan Cutler
75e5a5d09c
doc: fix singleton example in Developer Guide
...
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-08-23 20:53:36 +02:00
Loic Dachary
98602ae6c6
Merge pull request #10457 from SUSE/wip-15497
...
doc: add Backporting section to Essentials chapter
Reviewed-by: Loic Dachary <ldachary@redhat.com>
2016-07-27 23:15:39 +02:00
Nathan Cutler
f2dc74e05a
doc: add Backporting section to Essentials chapter
...
... and fix some broken links.
Fixes: http://tracker.ceph.com/issues/15497
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-07-27 21:41:17 +02:00
Nathan Cutler
2f80519958
doc: add Upload logs to archive server section...
...
...to Testing in the cloud testing chapter
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-07-27 20:20:49 +02:00
Nathan Cutler
e6f2d4e8fc
doc: add "Prepare tenant" section to "Testing in the cloud" chapter
...
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-07-23 19:24:18 +02:00
Ken Dreyer
b7b1ecb4d8
doc: John Spray is now CephFS lead
...
Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2016-05-23 15:18:10 -06:00
Ken Dreyer
fbfb5c12bf
doc: Jason Dillaman is now RBD lead
...
Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2016-05-02 10:57:53 -06:00
luokexue
4ebd6b84a8
doc: Fixes "branch -b" to "checkout -b"
...
Signed-off-by: luokexue <luo.kexue@zte.com.cn>
2016-04-16 11:45:41 +08:00