Commit Graph

181 Commits

Author SHA1 Message Date
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
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
John Wilkins
d3a2c56566 doc: move documentation build instructions to doc/dev section
Signed-off-by: John Wilkins <john.wilkins@dreamhost.com>
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-05-02 11:21:12 -07:00
Tommi Virtanen
1ec47db1bd doc: Convert the mailing list mention to not be a section heading.
If toctree is inside a section, the subtree is inside the section too.
We don't want all of dev/* to be under "Mailing list".

I have not found a decent workaround for this. The toplevel toctree
avoids this purely by the fact that it is the topmost toctree. Right
now that means you should 1) avoid having more than a few paragraphs of
text before the toctree for that subtree (put most of the content after
the toctree; clumsy if the toctree is long), or 2) put the toptree
immediately after the document title, make it :hidden:, and let the
reader use links in the text or the ToC in the sidebar to navigate.
See start/index for an example of this.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-03-30 11:11:25 -07:00
Tommi Virtanen
b162696b32 doc: Fix reStructuredText syntax errors.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-03-30 11:11:12 -07:00
Greg Farnum
1814aac175 Merge branch 'misc-fixes-for-review' 2012-03-27 13:57:54 -07:00
Greg Farnum
d0ba27ae50 doc: add a short thing on kernel client troubleshooting.
I just noticed this sitting uncommitted in my tree.

Signed-off-by: Greg Farnum <gregory.farnum@dreamhost.com>
2012-03-27 13:57:45 -07:00
Sage Weil
6db7715897 doc/dev/peering.rst: fix typo
Signed-off-by: Sage Weil <sage.weil@dreamhost.com>
2012-03-26 10:15:07 -07:00
Sage Weil
21a170e8f3 doc: dev/peering.rst edits from Greg
Signed-off-by: Sage Weil <sage@newdream.net>
2012-03-22 14:41:30 -07:00
Sage Weil
8fa904a6ea doc: update dev/peering document
- fix discussion of last epoch started
- define terms for current and past intervals
- describe role of pg info
- remove mention of the backlog
- fix discussion of up_thru
- etc.

Signed-off-by: Sage Weil <sage@newdream.net>
2012-03-22 08:33:09 -07:00
Alex Elder
ac28b6036d ceph: document the way files are laid out
This adds a document that I wrote about how Ceph client file data
is striped across Ceph objects to the repository.  It's a text
document.  Someone with better document preparation skills than I
should use the content below as a basis for something prettier if
that's appropriate.

[Made a few edits... -sage]

Signed-off-by: Alex Elder <elder@dreamhost.com>
Signed-off-by: Sage Weil <sage@newdream.net>
2012-03-08 15:18:59 -08:00
Sage Weil
bd97923ceb doc: fix misc typos, bad phrasing
Signed-off-by: Sage Weil <sage.weil@dreamhost.com>
2012-03-06 21:03:58 -08:00
Sage Weil
70360f840e github.com/NewDreamNetwork -> github.com/ceph 2012-03-02 11:00:08 -08:00
Sage Weil
f317028f42 doc: beginnings of documentation of stuck pgs and pg states
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
Reviewed-by: Sage Weil <sage@newdream.net>
2012-02-27 15:41:57 -08:00
Josh Durgin
dd31ff2e5c doc: add short section on documenting code
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2012-01-09 19:10:10 -08:00
Tommi Virtanen
81feae12e1 doc: Add misc explanations of Ceph internals from email.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-12-14 11:19:00 -08:00
Mark Kampe
06228716e3 Doc: add a conceptual overview of the peering process
Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
2011-12-02 11:28:38 -08:00
Mark Kampe
813523a681 Doc: delete gratuitous index.html
It was not an index, and seems to contain recommendations
for system configuration.  I have renamed it to confusing.txt
and will merge it in a future commit.

Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
2011-12-01 16:13:12 -08:00
Mark Kampe
3c7a82a6dc Doc: deleted gratuitious PlanningImplementation.html,
which was a copy of PlanningImplementation.txt
(and not html at all).

restored previous index.rst, which was overwritten with a copy
of PlanninImplementation.txt, but removed all of the recursively
included content from the document.

I will cherry-pick merge the new contents in a subsequent commit.

Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
2011-12-01 16:12:12 -08:00
Samuel Just
1c696b6566 doc: Add peering state diagram
Signed-off-by: Samuel Just <samuel.just@dreamhost.com>
2011-11-29 16:35:59 -08:00
Sondra.Menthers
d9dfd14761 rgw: handle swift PUT with incorrect etag 2011-10-27 11:16:51 -07:00
Sage Weil
6103ee9e88 more radosgw_admin -> radosgw-admin
Signed-off-by: Sage Weil <sage@newdream.net>
2011-10-03 11:25:44 -07:00
Sage Weil
fba541e4e8 libceph -> libcephfs
Signed-off-by: Sage Weil <sage@newdream.net>
2011-09-22 15:08:25 -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
c448c4c004 doc: Clean reStructuredText syntax.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-21 13:46:03 -07:00
Colin Patrick McCabe
cb7f5534f0 doc/dev/logs.rst: Add performance counter writeup
Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>
2011-09-16 15:43:47 -07:00
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
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
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
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