Commit Graph

1977 Commits

Author SHA1 Message Date
Colin Patrick McCabe
89c06e71f4 doc: Add section about changing config values
Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>
2011-09-16 15:41:13 -07:00
Tommi Virtanen
668afd7d33 doc: Typo.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-14 10:42:11 -07:00
Tommi Virtanen
2f3cfa174a doc: Instructions how to build RPMs.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-14 08:58:03 -07:00
Tommi Virtanen
b68eaf1875 doc: Say "radosgw" not "rgw".
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-14 08:42:06 -07:00
Tommi Virtanen
ecd368c230 doc: Shrinking of MDSes is not supported yet.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-14 08:42:06 -07:00
Tommi Virtanen
60aea05423 doc: Convert manpages to doc/man/.
Includes various content cleanups: layout of synopsis, layout
of comments in examples, typos.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-09 16:26:40 -07:00
Tommi Virtanen
80f54606b4 doc: Hide TODO note in rbd.8
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-09 16:26:40 -07:00
Tommi Virtanen
3f199beeaf doc: Make rbd.8 "pool-name", like the old man page.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-09 16:26:40 -07:00
Tommi Virtanen
c25b95552b doc: Remove duplicate paragraph from rbd.8
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-09 16:26:39 -07:00
Tommi Virtanen
37c7067351 doc: Note that mkcephfs can't do upgrades etc.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-06 16:08:58 -07:00
Tommi Virtanen
ecefa8e697 doc: mkcephfs ssh's directly as root@
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-06 15:57:17 -07:00
Tommi Virtanen
1a52cbdeb7 doc: Explicitly say ceph.conf host= must not include domain name.
Hopefully this will work some day, but it doesn't right now.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-06 13:48:44 -07:00
Tommi Virtanen
28539ccde8 doc: Document mkcephfs-style installation.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-06 13:19:44 -07:00
Tommi Virtanen
62f3c460d6 doc: Deb install should work now.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-02 12:35:58 -07:00
Tommi Virtanen
39b0354a7d doc: Write about deb installation.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-02 12:34:05 -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
0a14c75b1a doc: Make object store diagram fit in 1024 pix wide browser.
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
Colin Patrick McCabe
2e63eace85 Add object store architecture overview picture
It requires graphviz / dot to be installed. It generates a nice graph
of the dependencies between classes in the object store.

Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>
2011-08-31 18:09:52 -07:00
Colin Patrick McCabe
5bcea24d69 architecture.rst: describe debug logs, cephcontext
Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>
2011-08-31 16:08:42 -07:00
Colin Patrick McCabe
4dce9fe5ea doc/architecture: describe lib arch, config arch
Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>
2011-08-30 19:35:13 -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
df0f32b73a doc: Disable static file copying, we don't use it.
Avoids a warning from sphinx on every run.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-30 12:38:37 -07:00
Tommi Virtanen
3144fd73d9 doc: Flesh out librados API example, to show doxygen & sphinx integration.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-30 12:37:12 -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