Commit Graph

40 Commits

Author SHA1 Message Date
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
Tommi Virtanen
5465e81097 doc: Whitespace cleanup.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-03 10:15:21 -07:00
John Wilkins
d49c3d29a7 Removed "Ceph Development Status" per Bryan
Modified title syntax per Tommi
Modified paragraph width to 80-chars per Dan
Moved "Build from Source" out of Install
Renamed create_cluster to config-cluster
Added config-ref with configuration reference tables
Added a toc ref for man/1/obsync per Dan
Removed redundant sections from Ops
Deleted "Why use Ceph" and "Introduction to Storage Clusters"



Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
2012-05-02 20:31:35 -07:00
John Wilkins
0fb0ef9ee3 Corrections.
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-02 12:09:56 -07:00
John Wilkins
f53c8206f8 Minor edits. Still WIP.
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-02 12:09:56 -07:00
John Wilkins
f8b00f3ebe Added a new landing page graphic, and made some minor edits on the landing page.
Submitted by: John Wilkins <john.wilkins@dreamhost.com>

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-02 12:09:55 -07:00
John Wilkins
859da18e5e Building out information architecture. Modified getting involved, why use ceph, etc.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-02 12:09:55 -07:00
John Wilkins
541a875cba Restructuring documentation.
Submitted by: John Wilkins <john.wilkins@dreamhost.com>

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-02 12:09:55 -07:00
John Wilkins
a1b31ddfda Initial cut of introduction, getting started, and installing. More to do on installation. RADOS gateway to follow.
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-02 12:09:54 -07:00
Sage Weil
e455d38838 doc: update project status/stability blurb
Signed-off-by: Sage Weil <sage.weil@dreamhost.com>
Reviewed-by: Mark Kampe <mark.kampe@dreamhost.com>
2012-03-13 13:48:53 -07:00
Tommi Virtanen
bc16ac3b16 doc: Fix sentence that ended too abruptly.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-12-14 11:19:00 -08:00
Tommi Virtanen
f5cfdbb7a3 doc: Split intro to talk about the DFS separately. Mention petabytes.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-12-14 11:19:00 -08:00
Andre Noll
78b7a25598 doc: Import the list of ceph subcommands from wiki.
This adds the content of the wiki page at

http://ceph.newdream.net/wiki/Monitor_commands

to doc/control.rst in order to make it available at the new official
location for the ceph documentation. This first patch is just the
result of a cut-and-paste operation. There are no changes in content,
but the text was converted to rst format.

Signed-Off-By: Andre Noll <maan@systemlinux.org>
2011-12-12 14:31:10 -08:00
Tommi Virtanen
200d7c89a6 doc: Switch diagram tools from dia to ditaa.
Now you can create diagrams easily with the ".. ditaa::"
directive in the Sphinx documents.

admin/build-doc now checks for debs required for building
the documentation, or just lists commands missing for hosts
not using dpkg.

For more on Ditaa, see http://ditaa.sourceforge.net/

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-12-06 12:07:59 -08:00
Tommi Virtanen
b2d46ef35a doc: Search page is always in sidebar, no need to have it on page.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-23 15:55:01 -07:00
Tommi Virtanen
76fbdfb3dd doc: Add index entries, remove glossary as it's practically replaced by the index.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-23 15:55:00 -07:00
Sage Weil
6f8f140350 c* -> ceph-*
Hopefully I didn't miss too much...

Signed-off-by: Sage Weil <sage@newdream.net>
2011-09-22 15:08:25 -07:00
Tommi Virtanen
f488908c79 doc: Content for Getting Started with cephfs and rbd.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-21 14:55:11 -07:00
Tommi Virtanen
c3fae7e777 doc: Structure for Getting Started.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-21 13:46:04 -07:00
Tommi Virtanen
c01d36cf5a doc: Move config reference to top-level.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-21 13:46:04 -07:00
Tommi Virtanen
8648b7a55d doc: Move recommendations under /rec.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-21 13:46:04 -07:00
Tommi Virtanen
e09d4a9602 doc: Architecture, placeholder in install, and first appendix.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-01 13:28:12 -07:00
Tommi Virtanen
66ee58f691 doc: Move internals into a new section, /dev.
Most of the doc is user-oriented, let's isolate internals more.

Split into multiple files. Clean up RST.

Use Sphinx's graphviz plugin for graphs.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-01 13:28:12 -07:00
Tommi Virtanen
cc1cb8da7e doc: Hide empty and broken "module index" page.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-30 12:47:24 -07:00
Tommi Virtanen
c85c2f7535 doc: Adjust how table of contents is presented.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-30 11:26:56 -07:00
Tommi Virtanen
afede55c83 Integrate Doxygen into Sphinx docs.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-29 17:27:14 -07:00
Tommi Virtanen
f1d8964499 First draft of the documentation overhaul.
To build the docs, run ./admin/build-doc. To browse them, either get
them on any static website, or just run ./admin/serve-doc to serve
them quickly off of port 8080.

build-doc sets up a virtualenv to avoid needing Sphinx installed
system-wide. serve-doc needs thttpd installed.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-29 17:27:14 -07:00