RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-01-10 21:20:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
117,128 Commits 213 Branches 394 Tags 1.2 GiB
f637a4f99d
Commit Graph

771 Commits

Author SHA1 Message Date
zdover23
11311241c7
Merge pull request #38144 from anthonyeleven/anthonyeleven/docs-46365 
doc/dev/developer_guide: prefer Latinate verbs to English phrasal verbs

Reviewed-by: Zac Dover <zac.dover@gmail.com>
 2020-11-25 04:51:13 +10:00
Anthony D'Atri
d4b0215a84 doc/dev/developer_guide: prefer Latinate verbs to English phrasal verbs 
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
Fixes: https://tracker.ceph.com/issues/46365
 2020-11-23 13:07:19 -08:00
Neha Ojha
a24f40bb8d
Merge pull request #38172 from zdover23/wip-doc-dev-unit-test-list-update 
doc/dev: update list in unit test section

Reviewed-By: Nathan Cutler <ncutler@suse.com>
 2020-11-18 15:50:01 -08:00
Neha Ojha
becb9b6db2
Merge pull request #38133 from zdover23/wip-doc-dev-unit-tests-1-of-7 
doc/dev: update unit test 1 of 7

Reviewed-by: Neha Ojha <nojha@redhat.com>
 2020-11-18 12:19:42 -08:00
Neha Ojha
42c599bd1f
Merge pull request #38134 from zdover23/wip-doc-dev-unit-tests-2-of-7 
doc/dev: update unit tests 2 of 7

Reviewed-by: Neha Ojha <nojha@redhat.com>
 2020-11-18 12:18:55 -08:00
pcuzner
9ba45ee661
Merge pull request #37607 from pcuzner/docs-cephadm-host-maintenance 
doc/dev/cephadm: Doc defining the design for host maintenance
 2020-11-19 09:03:19 +13:00
Zac Dover
491a2fa8dc doc/dev: update list in unit test section 
This commit removes an unwanted extra
nested list layer from a list.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2020-11-19 03:35:19 +10:00
Zac Dover
0dd7b26fb3 doc/dev: update unit test declaration 
This commit updates the text in the "How
Unit Tests Are Declared" section of
tests-unit-tests.rst. This commit breaks
long sentences into shorter sentences and
breaks a sentence into a bulleted list that
might reduce the reader's cognitive load.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2020-11-19 01:13:37 +10:00
Zac Dover
19d34666a8 doc/dev: update unit test 1 of 7 
This commit updates the language at the beginning
of the Unit Test section of the developer guide.
The language in this edit is more grammatical than
it used to be, and should now reduce the reader's
cognitive load.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2020-11-18 18:25:05 +10:00
Zac Dover
7425e96c86 doc/dev: update unit tests 2 of 7 
This commit updates the "What does 'make
check' mean" section of the "Unit Tests" chapter
of the Developer Guide. It makes the wording a
bit less editorial and attempts to reduce the
reader's cognitive load.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2020-11-18 18:13:35 +10:00
Neha Ojha
a0e1a8f173
Merge pull request #38057 from zdover23/wip-doc-dev-guide-essentials-source-clean-update 
doc/dev: update essentials.rst

Reviewed-by: Neha Ojha <nojha@redhat.com>
 2020-11-13 09:42:20 -08:00
Neha Ojha
a0e7802863
Merge pull request #38036 from zdover23/wip-doc-dev-guide-basic-workflow-make-check-nov-2020 
doc/dev: improve make check text

Reviewed-by: Neha Ojha <nojha@redhat.com>
 2020-11-13 09:38:28 -08:00
Zac Dover
ef0a9db668 doc/dev: update essentials.rst 
This commit changes the noun "backup" to the
intended verb "back up" (this is one of my
technical documentation pet peeves and I couldn't
resist), and it also removes the verb "to nuke"
and replaces it with something less poetic but
more likely to be discoverable in a dictionary by
someone whose English is weak. It also adds a
missing colon.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2020-11-13 17:56:05 +10:00
Zac Dover
85a251f029 doc/dev: improve make check text 
This commit fixes the references to the
"make check" section in the "notes on
pr make check test" section and improves
the wording of that section so that it
reads a bit more clearly.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2020-11-13 13:36:07 +10:00
Zac Dover
efb9e82b94 doc/dev: update essentials.rst 
This commit improves the grammar and structure
of essentials.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2020-11-13 09:41:41 +10:00
Abutalib Aghayev
482e274556 doc: Update contact email address and documentation for zoned-storage.rst. 
Signed-off-by: Abutalib Aghayev <agayev@psu.edu>
 2020-11-04 13:56:22 -05:00
Paul Cuzner
16c449280d doc/dev/dashboard: typo fix 
Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
 2020-11-02 17:50:42 +13:00
Paul Cuzner
88346c790c doc/dev/dashboard: link designs to dev guide 
Add a feature design section to the dashboard dev
guide, linking to the individual docs under dov/dev/dashboard

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
 2020-11-02 17:36:44 +13:00
Paul Cuzner
c0a49c8fd9 doc/dev/dashboard: Document key UI design principles 
Document which defines the high level design principles
for the Ceph Dashboard UI

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
 2020-11-02 17:36:43 +13:00
Ishan Rai
590ce3c4f6 doc: style guide to give a the UI an overall look and feel 
fixes: https://tracker.ceph.com/issues/27218

Signed-off-by: Ishan Rai <ishanrai05@gmail.com>
 2020-10-27 13:50:15 +00:00
Paul Cuzner
df1afd6b12 doc/dev/cephadm: Updates following PR feedback 
Minor update adding an idea for future development as
per suggestion from @anthonyeleven

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
 2020-10-23 18:31:50 +13:00
Paul Cuzner
10f382c359 doc/dev/cephadm: add link for feature designs 
Add a link from the main cephadm page to the index
within /dev/dev/cephadm

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
 2020-10-23 15:35:06 +13:00
Alfonso Martínez
79321d4461 mgr/dashboard: set 'vendor/variables' SASS module as the single source of truth 
Fixes: https://tracker.ceph.com/issues/46869
Signed-off-by: Alfonso Martínez <almartin@redhat.com>
 2020-10-14 13:29:35 +02:00
Yuval Lifshitz
426e6f526c
Merge pull request #37599 from yuvalif/remove_doxyfile 
cmake: remove Doxyfile as doxygen run via make
 2020-10-13 08:03:39 +03:00
Paul Cuzner
8f3ed063a7 doc/dev/cephadm: Doc defining the design for host maintenance 
Initial PR to define/agree the scope and goals of providing
a host maintenance feature.

Signed-off-by: Paul Cuzner <pcuzner@redhat.com>
 2020-10-13 09:17:38 +13:00
zdover23
0f3bce753a
Merge pull request #37541 from anthonyeleven/osd-internals-tweaks 
doc/dev: doc/dev/osd_internals capitalization, formatting, clarity

Reviewed-by: Zac Dover <zac.dover@gmail.com>
 2020-10-13 06:01:05 +10:00
Yuval Lifshitz
fe0bddb7ab build/doc: remove Doxyfile as doxygen run via make 
also update document doxygen behavior
this is to complete: https://github.com/ceph/ceph/pull/35027

Signed-off-by: Yuval Lifshitz <ylifshit@redhat.com>
 2020-10-08 17:00:59 +03:00
Venky Shankar
b0d540e82f doc: cephfs mirroring design document 
Signed-off-by: Venky Shankar <vshankar@redhat.com>
 2020-10-08 05:31:35 -04:00
Kefu Chai
c7da693961 doc/crimson/poseidonstore: reformat 
to render it as expected

Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-10-07 12:54:42 +08:00
Kefu Chai
2263511c93 doc: move dev/crimson.rst into dev/crimson/ 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-10-07 12:54:42 +08:00
Samuel Just
699c2740fe
Merge pull request #36343 from myoungwon/wip-doc-poseidon-store 
doc: introduce PoseidonStore

Reviewed-by: Samuel Just <sjust@redhat.com>
 2020-10-06 17:28:43 -07:00
Anthony D'Atri
33931a8330 doc/dev: doc/dev/osd_internals caps, formatting, clarity 
Signed-off-by: Anthony D'Atri <anthony.datri@gmail.com>
 2020-10-06 14:06:46 -07:00
Kefu Chai
a9ed9b15c2 doc/dev/crimson: add links to seastar documents 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-10-06 17:59:11 +08:00
Kefu Chai
3c3c2f6ea0 doc/dev/crimson: add instruction on running install-deps.sh for building crimson 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-10-06 17:06:35 +08:00
myoungwon oh
9261c747f0 doc: introduce Poseidon store 
Signed-off-by: Myoungwon Oh <myoungwon.oh@samsung.com>
Signed-off-by: Jiwoong Park <jw12.park@samsung.com>
Signed-off-by: Kyuho Son <kyuho.son@samsung.com>
Signed-off-by: Sungkyu Park <sk921.park@samsung.com>
 2020-10-06 16:22:53 +09:00
Courtney Caldwell
ca2261781e
mgr/dashboard/api: generate offline API docs 
Generate Sphinx documentation from OpenAPI YAML spec:
- Fixed Docs controller doc generation
- Now dashboard Python doesn't fails if dashboard/frontend/dist doesn't exist
- OpenAPI added to @ceph/api CODEOWNERS
- Renamed Ceph-Dashboard API to Ceph REST or RESTful API.
- OpenAPI Docs: fixed decorators and docstrings.
- Sphinx Docs: updated dashboard and dev ones.

Co-authored-by: Ernesto Puerta <epuertat@redhat.com>
Fixes: https://tracker.ceph.com/issues/45863
Signed-off-by: Courtney Caldwell <ccaldwel@redhat.com>
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
 2020-09-28 12:03:03 +02:00
Kefu Chai
5bb5f5a79e
Merge pull request #37384 from tchaikov/wip-crimson-doc 
doc/dev/crimson: add instructions on how to build crimson

Reviewed-by: Radoslaw Zarzynski <rzarzyns@redhat.com>
 2020-09-24 22:30:12 +08:00
Kefu Chai
17d35b367d doc/dev/crimson: add instructions on how to build crimson 
and add a link to Scylla's document on debugging with GDB

Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-24 15:32:09 +08:00
Zac Dover
5985eb9413 doc/dev: added the other four tests 
This PR adds a list of tests that are performed
when a PR hits Github.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2020-09-24 09:49:36 +10:00
Zac Dover
f0d1ba50ce doc/dev: updated date from 2016 
This updates a date from 2016 to 2020,
so that readers can be confident that the
procedure that they're reading has been recently
tested.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
 2020-09-22 19:10:15 +10:00
Kefu Chai
47e7cd0f65
Merge pull request #37207 from tchaikov/wip-doc-dev-osx 
doc/dev/macos.rst: disable features not supported on osx

Reviewed-by: Kamoltat Sirivadhna <ksirivad@redhat.com>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
 2020-09-19 12:08:35 +08:00
Kefu Chai
266aa66aa9
Merge pull request #37252 from pponnuvel/spellcheck-docs 
doc: Fixed a number of typos in documentation

Reviewed-by: Kefu Chai <kchai@redhat.com>
 2020-09-19 11:07:52 +08:00
Neha Ojha
8ba0a61a51
Merge pull request #35906 from gregsfortytwo/wip-stretch-mode 
Add a new stretch mode for 2-site Ceph clusters

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
 2020-09-18 14:31:45 -07:00
Ponnuvel Palaniyappan
d99d520493 doc: Fixed a number of typos in documentation 
Signed-off-by: Ponnuvel Palaniyappan <pponnuvel@gmail.com>
 2020-09-18 18:17:15 +01:00
Kefu Chai
4278e6b59e doc/dev/macos.rst: disable features not supported on osx 
Signed-off-by: Kefu Chai <kchai@redhat.com>
 2020-09-17 12:19:47 +08:00
Kamoltat Sirivadhna
825df66bb8 doc/dev/macos: remove nonexistence flag --with-toolchain 
` --with-toolchain` is an old option from llvm 6

Signed-off-by: Kamoltat Sirivadhna <ksirivad@redhat.com>
 2020-09-16 22:39:57 +07:00
Greg Farnum
9506d09e3b Merge remote-tracking branch 'origin/master' into wip-stretch-mode 
Conflicts:
	src/include/ceph_features.h

Signed-off-by: Greg Farnum <gfarnum@redhat.com>
 2020-09-15 02:25:07 +00:00
Greg Farnum
d02625331c Merge remote-tracking branch 'origin/master' into wip-stretch-mode 2020-09-14 02:32:19 +00:00
zdover23
b22cf6da57
Merge pull request #37070 from zdover23/wip-doc-3-hacking-into-docs 
doc/dev: add HACKING.rst to Dev Guide

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
 2020-09-11 08:04:24 +10:00
Neha Ojha
9e81f39733
Merge pull request #36747 from varshar16/wip-doc-update-about-priority-check 
doc/developer_guide: Update about '--force-priority' flag

Reviewed-by: Sebastian Wagner <swagner@suse.com>
Reviewed-by: Neha Ojha <nojha@redhat.com>
Reviewed-by: Kyr Shatskyy <kyrylo.shatskyy@suse.de>
Reviewed-by: Josh Durgin <jdurgin@redhat.com>
 2020-09-10 10:29:29 -07:00