Commit Graph

76 Commits

Author SHA1 Message Date
Sebastian Wagner
5d9291e59e doc: fix "getting started" link
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-04-24 18:43:24 +02:00
Sage Weil
ce2066e623 doc: reorganize cephadm docs
- reorganized cephadm into a top-level item with a series of sub-items.
- condensed the 'install' page so that it doesn't create a zillion items
in the toctree on the left
- started updating the cephadm/install sequence (incomplete)

Signed-off-by: Sage Weil <sage@redhat.com>
2020-03-17 17:52:43 -05:00
Sebastian Wagner
d231eb90ce doc: Move ceph-deploy docs to doc/install/ceph-deploy
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-03-13 15:52:41 +01:00
Sebastian Wagner
aad35bacc0 doc: move bootstrap.rst to cephadm
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2020-02-26 12:29:37 +01:00
Sage Weil
6b41b6cd7b doc/index: remove quick start from front page for now
1- wait until this works on a production version,
2- maybe a shorter procedure, or just the initial steps and then
link off to bootstrap.rst?

This effectively reverts 79040c2 (PR #32531)

Signed-off-by: Sage Weil <sage@redhat.com>
2020-02-11 13:08:13 -06:00
Sage Weil
20205e70c4 mgr/orch: 'ceph orchestrator ...' -> 'ceph orch ...'
Less typing for all!

Signed-off-by: Sage Weil <sage@redhat.com>
2020-02-09 15:39:57 -06:00
Zac Dover
97df0b5274 More commits to the landing page project.
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-02-03 11:21:34 +10:00
Zac Dover
e334cd4287 doc: Added the crisp getting started guide to index.rst
This commit adds the 3-node getting started procedure to the
doc/index.rst file and represents the first large action taken
toward making the Ceph documentation more user-friendly and more
comprehensible to readers who have never used Ceph before.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

Added jdurgin's notes.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

Removed "podman" per jdurgin's direction.

Signed-off-by: Zac Dover <zac.dover@gmail.com>

changed a path from sdb1 to /by-id/[long string]w

Signed-off-by: Zac Dover <zac.dover@gmail.com>

changed the command for copying the keyring and the conf file, per jdurgin

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2020-01-22 11:41:30 +10:00
Sage Weil
64b69572b5 Merge PR #32009 into master
* refs/pull/32009/head:
	doc: removes kube-helm installation instructions

Reviewed-by: Sebastian Wagner <swagner@suse.com>
2019-12-09 08:23:44 -06:00
Zac Dover
01fc9bd33a doc: removes kube-helm installation instructions
This commit removes the material in the documentation
pertaining to the use of "kube-helm". The "kube-helm"
installation page has been deleted, and its entry in
the side-pane menu removed.

This commit fixes Bug number 3 in the list here:
https://pad.ceph.com/p/Report_Documentation_Bugs

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2019-12-05 02:55:41 +10:00
Sage Weil
8b20bb016d doc/foundation: add ceph foundation info here
Signed-off-by: Sage Weil <sage@redhat.com>
2019-12-03 10:45:45 -06:00
Nathan Cutler
626daf4b20
Merge pull request #30598 from smithfarm/wip-doc-releases-toc
doc/releases: access main releases page from top-level TOC

Reviewed-by: Abhishek Lekshmanan <abhishek@suse.com>
2019-11-05 13:18:25 +01:00
Sage Weil
3b228a45a4 doc/bootstrap: add new bootstrap documentation
Signed-off-by: Sage Weil <sage@redhat.com>
2019-10-05 14:28:50 -05:00
Nathan Cutler
e12ac2ddd1 doc/releases: access main releases page from top-level TOC
Before this commit, one had to go through the releases index to get to the main
releases page. This should be the other way around.

Also, the main releases page should not be called "schedule.rst" - while it
contains a release timeline, that's not its principal purpose. Rename the page
to "general.rst" and move the "Understanding the release cycle" section before
the timeline.

Signed-off-by: Nathan Cutler <ncutler@suse.com>
2019-09-27 12:49:43 +02:00
Patrick Donnelly
e7a7cf429e
doc: filesystem to file system
"Filesystem" is not a word (although fairly common in use).

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2019-09-10 08:43:28 -07:00
Nathan Cutler
64fc87a483 doc: move Developer Guide to its own subdirectory
Fixes: ef3ac5692b
Fixes: https://tracker.ceph.com/issues/38934
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2019-03-25 16:34:36 +01:00
Nathan Cutler
99493b4a28 doc: add Ceph Manager Dashboard to top-level TOC
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2019-02-12 18:17:11 +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
Sage Weil
89b90a7de7 doc/governance.rst: a few notes on ceph project governance
Signed-off-by: Sage Weil <sage@redhat.com>
2018-06-01 13:21:26 -05:00
Abhishek Lekshmanan
e37e49b205 doc: reorganize releases
Making one file per release, and in a separate folder

Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2018-03-07 23:36:11 +01:00
Alexandre Marangone
25324164dc doc: Kube + Helm installation
Signed-off-by: Alexandre Marangone <amarango@redhat.com>
2017-10-24 13:57:35 -07:00
Alfredo Deza
8f654a0daa docs: include ceph-volume's index file in the main toctree
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-21 11:44:54 -04:00
Alfredo Deza
e44f6d5b12 doc: bump the max depth of the toctree, so that it can find nested indexes
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-16 08:19:59 -04:00
Jason Dillaman
34ff1ddca1 doc: re-ordered rbd table of contents
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2017-08-08 12:40:50 -04:00
Sage Weil
0e5d7b8821 doc/index: minor cleanup
Signed-off-by: Sage Weil <sage@redhat.com>
2017-07-07 15:31:55 -04:00
John Spray
567b9fb692 doc: add initial ceph-mgr docs
Signed-off-by: John Spray <john.spray@redhat.com>
2016-09-29 17:27:05 +01:00
Jason Dillaman
9d2d090e5c doc: initial draft of RBD mirroring admin documentation
Fixes: #15041

Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2016-03-16 17:51:43 -04:00
Loic Dachary
14c02d8fae doc: release timeline
Signed-off-by: Loic Dachary <ldachary@redhat.com>
2015-03-15 22:02:59 +01:00
John Wilkins
ab886c4a0b doc: Removed quick guide and wireshark from top-level IA.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-08-18 14:29:09 -07:00
Kevin Cox
46d8c97e72 doc: Add documentation about Wireshark dissector.
Signed-Off-By: Kevin Cox <kevincox@kevincox.ca>
2014-08-14 16:42:56 -04:00
Luis Pabón
52cf693e8d Developer quick start guide
Signed-off-by: Luis Pabón <lpabon@redhat.com>
2014-08-05 14:48:47 -04:00
John Wilkins
ed605f0dfb doc: Fixed hyperlink.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-01-08 14:37:20 -08:00
John Wilkins
31fff93b85 doc: Added Intro to Ceph to Index.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-17 13:22:35 -07:00
John Wilkins
5f0007e6a9 doc: Reworked the landing page.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-06-11 15:32:23 -07:00
John Wilkins
c4001b12fc doc: Removed FAQ from the index.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-30 20:21:48 -07:00
John Wilkins
c20751690c doc: Added glossary to TOC.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-05-07 07:58:04 -07:00
John Wilkins
afd4da735f doc: Added FAQ back into toc tree.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-11-21 09:48:18 -08:00
John Wilkins
0a2a0c075c doc: config-cluser move to new IA.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-11-14 14:57:51 -08:00
John Wilkins
f2fbe7a74d doc: Removed source/index from top-level toc tree per new IA.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-11-07 22:42:12 -08:00
John Wilkins
ee07b224df doc: Added new info per Ross's request.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-11-07 14:07:55 -08:00
John Wilkins
8853469040 doc: Added space for Emacs users.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-09-23 21:54:44 -07:00
John Wilkins
b311a408a3 doc: Updating the index to remove legacy and uneeded entries.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-09-19 16:21:08 -07:00
John Wilkins
6957ae78e1 :doc: Modified the index page to point to the new cluster-ops section.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-09-05 17:25:34 -07:00
Sage Weil
8b462019f2 doc: release notes for 0.48
Signed-off-by: Sage Weil <sage@inktank.com>
2012-07-02 20:20:14 -07:00
John Wilkins
e34dfc3b6a doc: removing old 'todo' configuration reference.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-06-26 12:30:01 -07:00
John Wilkins
0be2611158 doc: Published RADOS GW docs and install as is for now. Needs more work.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-06-26 08:21:05 -07:00
John Wilkins
87327c2d5c doc: Added mount cephfs and included it in quick start.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-06-06 10:45:26 -07:00
John Wilkins
fb7ce59b9a doc: Added preliminary rbd and ko info.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-05-31 15:35:33 -07:00
Ross Turk
6149fb700f doc: Added a FAQ page.
Added a FAQ page, which we will need to put more content in.

Signed-off-by: Ross Turk <ross@inktank.com>
2012-05-21 18:21:39 -07:00
John Wilkins
812989bf35 doc: misc updates
doc/architecture.rst - removed broken reference.
doc/config-cluster - cleanup and added chef
doc/install - Made generic to add Chef, OpenStack and libvert installs
doc/init - Created light start | stop and health section
doc/source - Removed $ from code examples. Trimmed paras to 80 char
doc/images - Added preliminary diagram for Chef.
doc/rec - Added reference to hardware. Added filesystem info.

Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
2012-05-21 16:39:15 -07:00