Commit Graph

29 Commits

Author SHA1 Message Date
Kefu Chai
27bcb291ee doc/start: fix the link pointing to ceph doc
use https instead of http, the latter cannot be redirected to the valid
docs. also, we don't have "next" branch, so remove the document
mentioning it.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2021-03-10 12:28:28 +08:00
Zac Dover
2b90e77802 doc/start: update prompts in documenting-ceph.rst
This commit adds the ".. prompt:: bash $" directive
to the commands in "documenting-ceph.rst" so that
the permissions level of each command is evident
(through the presentation of the $ or the #), and
so that when the reader cuts and pastes the commands
from the documentation, they don't have to delete
the prompt (because that's how this directive
renders).

This commit also instructs the reader to add the
directory containing "build-doc" and
"serve-doc" to the PATH environment variable
in order to run the commands.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
Co-authored-by: Kefu Chai <tchaikov@gmail.com>
2020-11-17 00:13:05 +10:00
Anthony D'Atri
32375cb789 doc: misc clarity and capitalization
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
2020-10-12 13:41:46 -07: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
Neha Ojha
07aef79693 doc/start/documenting-ceph.rst: make better doc recommendations
I do not think "Editors" is relevant anymore.

Signed-off-by: Neha Ojha <nojha@redhat.com>
2019-09-09 15:40:45 -07:00
Kefu Chai
feb8cd1267 doc: add instructions about using "serve-doc" to preview built document
Signed-off-by: Kefu Chai <kchai@redhat.com>
2018-10-08 18:11:01 +08:00
James McClune
d772bd3b5f
doc: updated cross referencing locations link
Updated cross referencing locations link for doc/start/documenting-ceph.rst

Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2018-08-16 21:58:34 -04:00
Patrick Donnelly
aab25e41d9
Merge PR #23513 into master
* refs/pull/23513/head:
	doc: updated contact email for Ceph pull requests

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
2018-08-12 14:49:05 -07:00
Bryan Stillwell
791b00daa1 doc: Multiple spelling fixes
I ran a lot of the docs through aspell and found a number of spelling problems.

Signed-off-by: Bryan Stillwell <bstillwell@godaddy.com>
2018-08-09 14:51:25 -06:00
James McClune
89fc794995
doc: updated contact email for Ceph pull requests
Updated the contact email address for Ceph pull requests (per @johnwilkins' request).

Signed-off-by: James McClune <jmcclune@mcclunetechnologies.net>
2018-08-09 14:16:49 -04:00
Ken Dreyer
3abc975985 doc: eliminate useless cat statement
Useless Use of Cat Award!

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2017-08-22 09:15:31 -06:00
John Wilkins
c978a76b4d doc/start: Removed contractions for ESL speakers.
Signed-off-by: John Wilkins <jowilkin@redhat.com>
2017-07-27 09:59:00 -07:00
Drunkard Zhang
58ba14e2fd doc: hyperlink fixes
Signed-off-by: Drunkard Zhang <gongfan193@gmail.com>
2017-05-19 09:41:33 +08:00
Yu Shengzuo
41c902e532 doc: update dependent packages links and remove a 'important' tip
Some links in document has been deprecated, such as:
http://rpmfind.net/linux/centos/7.0.1406/, So update it;
The 'fc21, fc24, fc26(newest)' rpm 'ditaa' can be used in
CentOS/RHEL7 to build doc. So remove the '...important' tip.

Signed-off-by: Yu Shengzuo <yu.shengzuo@99cloud.net>
2017-04-20 03:39:29 +00:00
Kefu Chai
5b9ec53512 admin/build-doc: support optional argument for specifying sphinx builders
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-03-21 13:47:05 +08:00
Ken Dreyer
9411017fd3 doc: standardize EPEL instructions
Prior to this change, the documentation pages contained different ways
to enable EPEL. Pick a simple, secure (https) way and standardize on
that.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2016-10-25 20:02:48 -06:00
Li Peng
d1505b5408 doc: delete wrong description of installing RPMs
In CentOS/RHEL 6/7, gitk and git-gui are available in default repository actually.

Signed-off-by: Li Peng <lip@dtdream.com>
2015-09-16 14:05:05 +08:00
Li Peng
bbe27dc6d7 doc: Fixes a wrong directory name.
Signed-off-by: Li Peng <lip@dtdream.com>
2015-09-15 20:06:39 +08:00
Lee Revell
005d1f8a5c doc: Correct git push instructions adding branch name
Signed-off-by: Lee Revell <rlrevell@gmail.com>
2015-03-23 16:03:48 -04:00
Nilamdyuti Goswami
a5a0d5c83f doc: Adds build-doc guidelines for Fedora and CentOS/RHEL.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-11-14 21:06:15 +05:30
John Wilkins
2f43cef0ae doc: Extended discussion for building docs on CentOS / RHEL.
Fixes: #7722

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-07-15 13:42:13 -07:00
Abhishek Lekshmanan
2217f2bd0a doc: fix a typo in quickstart doc
* doc/start/documenting-ceph.rst: s/along side/alongside

Signed-off-by: Abhishek Lekshmanan <abhishek.lekshmanan@gmail.com>
2014-07-09 11:18:49 +05:30
Kevin Dalley
78b3c93dd6 doc: documenting links to get-involved
Create a link from documenting-ceph so that it is easy to find the
github repository used for ceph.

Signed-off-by: Kevin Dalley <kevin@kelphead.org>
2014-04-30 21:31:06 -07:00
John Wilkins
d7c4d6abc2 doc: Added init caps to Signed-off-by: and Fixes:
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-03-10 15:58:57 -07:00
John Wilkins
7ac98b2aff doc: Updated sign-off by to sign-off-by
sign-off-by: John Wilkins <john.wilkins@inktank.com>
2014-03-10 15:45:01 -07:00
John Wilkins
0f7d954b19 doc: Updated pull request with suggested changes.
signed-off by: John Wilkins <john.wilkins@inktank.com>
2014-03-10 11:58:53 -07:00
John Wilkins
2f85b8c8a3 doc: Incorporated feedback.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-01-31 21:58:23 -08:00
John Wilkins
6915053648 doc: Adding more information on style and usage for documenting Ceph.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-01-23 14:27:33 -08:00
John Wilkins
b88c8eae80 doc: Added Documenting Ceph (draft) document.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-01-21 14:18:55 -08:00