Commit Graph

286 Commits

Author SHA1 Message Date
lafont
54ec7556bc doc: update the "building doc" part
* In the doc, the explicit and outdated list of required
  dependencies is removed. Now, launching `./admin/build-doc`
  is suggested because the script gives the missing dependencies.
* Little refactoring of the "Debian checking dependencies" part
  in the script `./admin/build-doc`.
* In the suggested "apt-get" command to install dependencies, the
  option `-o APT::Install-Recommends=true` is added just in case.

Signed-off-by: François Lafont <francois.lafont@ac-versailles.fr>
2016-05-18 16:23:08 +02:00
Ken Dreyer
5904d89247 doc: remove references to old EOL releases
There were several references to old releases like "dumpling",
"emperor", and "firefly", throughout the docs. Remove these and update
the examples to use jewel instead.

Remove references to CentOS 6 and RHEL 6, since we only support CentOS 7
now.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2016-05-02 13:54:24 -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
Sage Weil
61c4c1c99b doc: list ext4 last
Signed-off-by: Sage Weil <sage@redhat.com>
2016-04-12 08:48:25 -04:00
Sage Weil
ae97840fa1 doc/dev: remove ancient filestore-filesystem-compat doc
This describes a problem we fixed years ago.

Signed-off-by: Sage Weil <sage@redhat.com>
2016-04-12 08:39:00 -04:00
Loic Dachary
919ff4ff29 releases: what is merged where and when ?
Signed-off-by: Loic Dachary <loic@dachary.org>
2016-03-31 15:10:40 +02:00
Loic Dachary
43d63ee456 Merge pull request #8228 from SUSE/wip-15218
doc/dev: add "Deploy a cluster for manual testing" section

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2016-03-29 13:01:23 +02:00
Sage Weil
a09da43201 Merge pull request #8207 from theanalyst/doc/mstart
doc: very basic doc on mstart
2016-03-23 12:17:53 -04:00
Nathan Cutler
57c57548aa doc/dev: add "Deploy a cluster for manual testing" section
http://tracker.ceph.com/issues/15218 Fixes: #15218

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-20 14:23:37 +01:00
Abhishek Lekshmanan
39317e8d7d doc: very basic doc on mstart
A very basic explanation of getting started with using mstart to deploy
multiple clusters on a machine

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-03-18 14:01:20 +01:00
Nathan Cutler
917e06b8e2 doc/dev: add section on interrupting a running suite
This commit adds a new section, entitled "Interrupt a running suite", to
the "Testing in the cloud" chapter.

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-15 14:14:09 +01:00
Nathan Cutler
323c267971 doc/dev: Continue writing Testing in the cloud chapter
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-09 09:23:39 +01:00
Nathan Cutler
4a5875a184 doc/dev: start Testing in the cloud chapter
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-07 16:00:01 +01:00
Nathan Cutler
37afe5c53b doc/dev: various refinements
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-07 10:27:42 +01:00
Nathan Cutler
5b570653f5 doc/dev: integrate testing into the narrative
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-06 20:41:35 +01:00
Nathan Cutler
a0572bc55c doc: detailed description of bugfixing workflow
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2016-03-05 15:54:09 +01:00
Samuel Just
c9861a0f79 doc/.../throttles*: update the docs to reflect the throttle changes
Signed-off-by: Samuel Just <sjust@redhat.com>
2016-02-25 11:11:46 -08:00
Abhishek Lekshmanan
dd3c87d78c doc: update PG doc with the backfill change
Since the state reported is `backfilling` and `backfill_wait`

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-02-02 17:03:46 +01:00
Abhishek Lekshmanan
5793df4cdf doc: vstart update a few commandline switches
Add a few more available commandline switches to vstart quickstart
documentation

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2016-01-21 13:53:50 +01:00
Loic Dachary
279e9fb1e7 doc: dev: document ceph-qa-suite
Signed-off-by: Loic Dachary <loic@dachary.org>
2016-01-07 14:20:54 +01:00
Nathan Cutler
fec545839c doc: fix typo in developer guide
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-15 15:25:45 +01:00
Loic Dachary
736532cac9 Merge pull request #6934 from smithfarm/wip-14070
doc: Update list of admin/build-doc dependencies

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2015-12-15 13:24:47 +01:00
Nathan Cutler
eadc771d27 doc: Update list of admin/build-doc dependencies
http://tracker.ceph.com/issues/14070 Fixes: #14070

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-15 12:41:29 +01:00
Loic Dachary
9c34d0c4e4 Merge pull request #6910 from dachary/wip-dev-guide-ceph-qa-suite
doc: dev: introduction to tests

Reviewed-by: Nathan Cutler <ncutler@suse.com>
2015-12-15 11:21:51 +01:00
Sage Weil
d5cee59b02 doc/cephfs/posix: update
Signed-off-by: Sage Weil <sage@redhat.com>
2015-12-14 10:45:30 -05:00
Loic Dachary
5440334dec doc: dev: introduction to tests
Signed-off-by: Loic Dachary <loic@dachary.org>
2015-12-13 22:02:27 +01:00
Nathan Cutler
c1daf4e6f8 doc/dev/index.rst: wholesale refactor
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-04 23:58:11 +01:00
Nathan Cutler
6807b35a21 doc/dev/index.rst: fix links
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-03 18:11:37 +01:00
Nathan Cutler
f3366401eb doc/dev/index.rst: Flesh out the IRC section
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-03 18:11:25 +01:00
Nathan Cutler
8d281bc5f0 doc/dev/index.rst: Make Issue tracker a separate chapter
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-03 18:11:09 +01:00
Nathan Cutler
6e7f9c8ed3 doc/dev/index.rst: start writing Bugfixing chapter
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-03 13:31:28 +01:00
Nathan Cutler
002d26b097 doc/dev/index.rst: rewrite introductory material
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2015-12-03 09:53:35 +01:00
Nathan Cutler
bc21a23555 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-03 00:30:24 +01:00
Nathan Cutler
b6f9a9b2b1 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-12-02 23:37:06 +01:00
Javier M. Mellid
71909b64b8 doc: rgw: update x-amz-request-id status
Signed-off-by: Javier M. Mellid <jmunhoz@igalia.com>
2015-09-10 11:25:17 +02:00
Kefu Chai
351d957992 doc: fix the typo in command example
always indent using tab, the rendered html looks good, but it helps with
editor to highlight the codeblock properly.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-09-06 19:30:02 +08:00
Sage Weil
7d781f7a09 doc: 'ceph --admin-daemon ...' -> 'ceph daemon ...'
Signed-off-by: Sage Weil <sage@redhat.com>
2015-09-04 15:59:34 -04:00
Zhiqiang Wang
89aacaf699 doc: add the doc for min_write_recency_for_promote
Signed-off-by: Zhiqiang Wang <zhiqiang.wang@intel.com>
2015-09-02 14:00:40 +08:00
Kefu Chai
6dc9ed5814 Merge pull request #5603 from wonzhq/doc-read-recency
doc: add the description for min_read_recency_for_promote

Reviewed-by: Kefu Chai <kchai@redhat.com>
2015-08-31 18:12:43 +08:00
Sage Weil
dfb9fea3a9 Merge pull request #5660 from badone/doc_snaps_typo
doc: Fix typo and redundant word in snaps section
2015-08-25 11:54:29 -04:00
Kefu Chai
665de0a91f Merge pull request #5657 from badone/master
doc: Fix typo in recovery reservation section

Reviewed-by: Kefu Chai <kchai@redhat.com>
2015-08-25 19:35:53 +08:00
Brad Hubbard
699fca8089 doc: Fix typo and redundant word in snaps section
Fix typo and remove identifying from "filtering identifying" in
doc/dev/osd_internals/snaps.rst

Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2015-08-25 21:31:43 +10:00
Brad Hubbard
6ee7068c4c doc: Fix typo in writeback throttle section
Fix typo in doc/dev/osd_internals/wbthrottle.rst

Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2015-08-25 21:04:55 +10:00
Brad Hubbard
07a28d6ce2 doc: Fix typo in recovery reservation section
Fix typo in doc/dev/osd_internals/recovery_reservation.rst

Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2015-08-25 20:51:09 +10:00
Zhiqiang Wang
d5a56c497a doc: update some of the outdated cache tiering doc
Signed-off-by: Zhiqiang Wang <zhiqiang.wang@intel.com>
2015-08-20 10:58:45 +08:00
Zhiqiang Wang
de00f6d0df doc: add the description for min_read_recency_for_promote
This cache tiering option is introduced in proxy read.

Signed-off-by: Zhiqiang Wang <zhiqiang.wang@intel.com>
2015-08-20 10:49:30 +08:00
Zhiqiang Wang
73d4b7dbf2 doc: fix the format of peering.rst
Fix an incorrent number in the ordered list and some indention issue.
Make the ordered list to use '1' or 'a' for the first item, and '#' for
the remaining items.

Signed-off-by: Zhiqiang Wang <zhiqiang.wang@intel.com>
2015-08-20 09:48:07 +08:00
Brad Hubbard
370e4a71a2 doc: remove duplicate word in Motivation section.
Remove to\nto typo in doc/dev/osd_internals/erasure_coding/pgbackend.rst

Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2015-08-10 11:51:49 +10:00
Sage Weil
edd68e3ade Merge pull request #5188 from athanatos/wip-11687
PG::find_best_info: ignore info.les for incomplete peer

Reviewed-by: Sage Weil <sage@redhat.com>
2015-07-16 11:03:18 -04:00