Commit Graph

218 Commits

Author SHA1 Message Date
Zac Dover
262b115b75 doc/dev: add full stop to sentence in basic-wo
Add a full stop to a sentence in basic-workflow.rst. I looked at this
document and noticed that it wasn't there, and it was just bugging me.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-03-07 02:15:27 +10:00
zdover23
0d343aafaf
Merge pull request #49908 from Matan-B/wip-matanb-upgrade-doc
doc/dev/developer_guide: Add Upgrade Testing Documentation

Reviewed-by: Zac Dover <zac.dover@proton.me>
2023-01-29 20:52:06 +10:00
Matan Breizman
c2642a97f3 doc/dev/developer_guide/testing_integration_tests: Add Upgrade Testing Documentation
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2023-01-29 10:25:30 +00:00
Zac Dover
c3288cf5be doc/dev: add Slack to Dev Guide essentials
Add Ceph's Slack to doc/developer_guide/essentials.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
2023-01-26 01:57:17 +10:00
Zac Dover
f1c0c3ec3d doc/dev: add git branch management commands
Add git branch deleting and search commands to the "Basic Workflow" page
of the Developer Guide.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-14 07:26:18 +10:00
Zac Dover
049e5aaade doc/dev: add push.autoSetupRemote instructions
Explain how to set up push.autoSetupRemote so that the origin branch is
properly set up when running "get push" without the need for the
"--set-upstream" option.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2023-01-12 06:24:55 +10:00
Zac Dover
488ca03690 doc/dev: improve Basic Workflow wording
Make several semantic and syntactic improvements to basic-workflow.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-28 09:27:13 +10:00
zdover23
0528e16f89
Merge pull request #48984 from Matan-B/wip-matanb-unit-debug-lvl
doc/dev/developer_guide/tests-unit-tests: Add unit test caveat

Reviewed-by: Zac Dover <zac.dover@gmail.com>
2022-11-23 00:11:45 +10:00
Matan Breizman
032f8cf601 doc/dev/developer_guide/tests-unit-tests: Add unit test caveat
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2022-11-21 14:56:24 +00:00
Nizamudeen A
31a0a4f93b mgr/dashboard: tslint to eslint migration
Fixes: https://tracker.ceph.com/issues/48258
Signed-off-by: Nizamudeen A <nia@redhat.com>
2022-11-14 22:56:21 +05:30
Zac Dover
b0df28b61a doc/dev: improve lone sentence
Improve a lone sentence to make it less ambiguous, and at the same
time permit the testing of a script.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-11-05 03:11:04 +10:00
Nizamudeen A
5f95db33e9 cmake: bump node version to 14
to update the angular to 13, we need a node version of either 12.20.x or
14.15.x or 16.10.x. But inorder to not break the angular 12 run for now
   we  need to choose the node which works for both 12 and 13. which is
14.15.x. So I went with that node version here.

Signed-off-by: Nizamudeen A <nia@redhat.com>
2022-10-19 13:34:58 +05:30
Zac Dover
e55c3b114b doc/dev: add submodule-update link to dev guide
This commit links to the procedure in install/clone-source.rst that
explains how to update submodules.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-10-13 03:30:42 +10:00
Ernesto Puerta
7f41f15745
Merge pull request #47131 from aaryanporwal/vrt-doc-update
doc/dev: mgr/dashboard: Replace broken link

Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
2022-09-26 13:22:11 +02:00
Zac Dover
b8472b98e2 doc/dev: improve presentation of note (git remote)
This commit corrects the formatting of a note that previously
did not make console output and commands as clear as this commit
makes them.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-09-25 13:41:35 +10:00
nsedrickm
567ee3ae85 doc/dashboard: update documentation with accessibility development practices
Update documentation to include  tools and practice used when developing dashboard features

Fixes: https://tracker.ceph.com/issues/56453
Signed-off-by: nsedrickm <nsedrick101@gmail.com>
2022-09-12 16:54:56 +01:00
Aaryan Porwal
1639885a9a
doc/dev: mgr/dashboard: Replace broken link
The link to Applitools Eyes's Cypress SDK documentation was pointing to a broken link, replaced that with the officially recognized documentation link

Signed-off-by: Aaryan Porwal <aaryanporwal2233@gmail.com>
2022-07-16 11:26:41 -04:00
Zac Dover
f7581e05b0 doc/dev: s/github/GitHub/ in essentials.rst
This addresses a typo that Anthony D'Atri pointed out in
PR#47032. It didn't get addressed there, so it's being
addressed here.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-07-12 02:58:18 +10:00
Zac Dover
2711e8de80 doc/dev: add Dependabot section to essentials.rst
This PR adds a section to the Developer Guide chapter
"Essentials" that explains what Dependabot is. This
section is adapted from an email from Ernesto Puerta
to the CLT that was sent on 08 Jul 2022.

Co-authored-by: Ernesto Puerta <epuertat@redhat.com>>
Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-07-12 01:29:00 +10:00
Anthony D'Atri
cf1415a2b2
Merge pull request #46919 from jsoref/spelling-docs
doc: Fix many spelling errors
2022-07-03 19:54:55 -07:00
Josh Soref
8abce157f1 doc: Fix many spelling errors
* administrators
* allocated
* allowed
* approximate
* authenticate
* availability
* average
* behavior
* binaries
* bootstrap
* bootstrapping
* capacity
* cephadm
* clients
* combining
* command
* committed
* comparison
* compiled
* consequences
* continues
* convenience
* cookie
* crypto
* dashboard
* deduplication
* defaults
* delivered
* deployment
* describe
* directory
* documentation
* dynamic
* elimination
* entries
* expectancy
* explicit
* explicitly
* exporter
* github
* hard
* healthcheck
* heartbeat
* heavily
* http
* indices
* infrastructure
* inherit
* layout
* lexically
* likelihood
* logarithmic
* manually
* metadata
* minimization
* minimize
* object
* of
* operation
* opportunities
* overwrite
* prioritized
* recipe
* records
* requirements
* restructured
* running
* scalability
* second
* select
* significant
* specify
* subscription
* supported
* synonym
* throttle
* unpinning
* upgraded
* value
* version
* which
* with

Plus some line wrapping and additional edits...

Signed-off-by: Josh Soref <jsoref@users.noreply.github.com>
2022-07-02 23:38:18 -04:00
Zac Dover
893e68a8f5 doc/dev: add IRC registration instructions
This PR adds to the Developer Guide a link to the OFTC's IRC nick
registration instructions.
2022-07-03 01:50:44 +10:00
Zac Dover
326034807d doc/dev: s/the the/the/ in basic-workflow.rst
This PR does exactly what it says: it changes a "the the"
to a "the".

I'd like to thank Josh Soref for bringing this
to my attention.
2022-06-30 21:08:51 +10:00
Zac Dover
c624a2a8ef doc/index.rst: add link to Dev Guide basic workfl.
This PR adds a link to the "Basic Workflow" section of the
Developer Guide on the landing page of docs.ceph.com.

This PR is meant to improve the documentation for developers
new to Ceph and to guide them to instructions that will allow
them to become full-fledged contributors to the Ceph project
as quickly as possible.

The "Basic Workflow" page of the Developer Guide contains
information that answers almost all of the questions that I had
about contributing to the Ceph project when I was new to it,
and I am finally acting on my long-held conviction that the
"Basic Workflow" page of the Developer Guide should have a more
prominent position in the documentation suite than it has had.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-29 22:57:13 +10:00
zdover23
51bfb222f1
Merge pull request #46857 from zdover23/wip-doc-2022-06-27-pdonnelly-to-venky
doc/dev_guide: change CephFS lead to vshankar

Reviewed-by: Josh Durgin <jdurgin@redhat.com>
Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-06-28 23:58:39 +10:00
Zac Dover
ff3f8e06ae doc/dev_guide: change CephFS lead to vshankar
This makes an overdue change. Venky Shankar is the
CephFS lead, and has been for a while.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-28 22:24:34 +10:00
Zac Dover
83b77909e5 doc: remove mention of Sage as current leader
This commit removes mention of Sage as the leader of the
Ceph project in the following files:

dev/developer_guide/essentials.rst
dev/developer_guide/merging.rst
foundation.rst
governance.rst

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-24 17:07:09 +10:00
zdover23
945954681b
Merge pull request #46769 from zdover23/wip-doc-2022-06-21-dev-guide-config-local-env-add-context-note
doc/dev: add context note to dev guide config

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-06-23 00:03:14 +10:00
Laura Flores
462bc054cb doc/dev/developer_guide: fix small typo
Introduced in 682b806efa.

Signed-off-by: Laura Flores <lflores@redhat.com>
2022-06-21 15:52:39 -05:00
Zac Dover
3e6bcd7f0b doc/dev: add context note to dev guide config
This PR adds a note directing first-time cloners of
their Ceph git forks to make sure to cd into the ceph/
directory before trying to run the "git config" commands.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-22 00:09:05 +10:00
Zac Dover
f5fd158bea doc/dev: s/master/main/ in title
This changes "master" to "main" in a title. If we lived in an
ideal world, this would have been a part of PR#46678.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-16 15:57:16 +10:00
zdover23
87e27c89f5
Merge pull request #46705 from zdover23/wip-doc-2022-06-15--master-to-main-dev-guide-merging
doc/dev_guide: s/master/main in merging.rst

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-06-16 11:50:31 +10:00
zdover23
5122cf02a2
Merge pull request #46678 from zdover23/wip-doc-2022-06-14-dev-guide-basic-workflow-master-to-main
doc/dev: s/master/main/ in basic workflow

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
2022-06-16 11:13:05 +10:00
Zac Dover
52da71f0ab doc/dev_guide: s/master/main in merging.rst
This changes the branch name "master" to the branch name
"main" in merging.rst.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-16 07:54:31 +10:00
Matan Breizman
682b806efa doc/dev: Debuggging with gdb
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
2022-06-15 17:46:37 +00:00
Zac Dover
f5cfc22445 doc/dev: s/master/main/ in basic workflow
This PR changes "master" to "main" in the
basic_workflow.rst file. I have even changed
"master" to "main" in some terminal output from
several years ago. This isn't historically ac-
curate, of course, but my hope is that this change
will prevent someone in the future from being con-
fused about why an antiquated branch name is ref-
erred to.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-15 08:15:33 +10:00
Zac Dover
728b8f2674 doc/dev: s/master/main/ essentials.rst dev guide
This PR changes all reference to the "master" branch
to references to the "main" branch (because we renamed
"master" to main", and the docs now need to reflect that).

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-06-14 07:48:46 +10:00
Patrick Donnelly
d0b69a3cdf
Merge PR #46421 into main
* refs/pull/46421/head:
	doc/dev: move option -R to a different section of doc

Reviewed-by: Patrick Donnelly <pdonnell@redhat.com>
Reviewed-by: Anthony D Atri <anthony.datri@gmail.com>
2022-06-09 20:12:49 -04:00
Rishabh Dave
bbe71266de doc/dev: move option -R to a different section of doc
It's incorrect to pass option "-R fail" to the teuthology-suite command
meant for triggering tests for first time. teuthology-suite command will
fail if "-R" is passed without "-r". Therefore, move this option and its
description from the section meant for triggering tests for first time
to the section dedicated to re-running of tests.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2022-06-09 00:55:51 +05:30
Patrick Donnelly
9e5ff96560
doc/dev/developer_guide/testing_integration_tests: document how to test custom kernels
Fixes: https://tracker.ceph.com/issues/55530
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2022-06-03 13:52:31 -04:00
Zack Cerza
6fee777d60
Merge pull request #44967 from batrick/nested-subset-doc
doc/dev: document nested subsets in teuthology
2022-05-24 10:23:48 -06:00
Zac Dover
63c6041068 doc/dev: refine basic-workflow.rst integ. test
This is one in a set of PRs meant to keep the Basic
Workflow in the Developer guide current. It refines
the English in the "Integration Tests AKA ceph-qa-suite"
section of "Basic Workflow".

Several other small updates like this are expected. I
intend to avoid refining half of the page in one commit,
as I did last month when I refined the first half of the
basic workflow.

Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-05-18 04:08:05 +10:00
Zac Dover
a227e4007a doc/dev: update basic-workflow.rst
This PR updates the basic-workflow.rst file
to serve the needs of people in 2022 who were not
present at jump street.

The text has been refined up to the section called
"Integration Tests" (non-inclusive).

Signed-off-by: Zac Dover <zac.dover@gmail.com>
2022-05-11 01:53:47 +10:00
Rishabh Dave
27eaacd98a qa/vstart_runner: accept multiple commands as str
Convert all command arguments to str from list, update checks and
adjustments performed on command arguments accordingly and update
documentation to include warnings about some critical parts of
vstart_runner.py and update tasks.cephfs.mount.MountCephFS.run_shell().

Fixes: https://tracker.ceph.com/issues/47849
Signed-off-by: Rishabh Dave <ridave@redhat.com>
2022-05-02 20:24:08 +05:30
Rishabh Dave
f5974d3993 doc/developer_guide: split a note point into two
Since both the sentences in the note point aren't strictly related to
each other, it's better to split that note point into two.

Signed-off-by: Rishabh Dave <ridave@redhat.com>
2022-04-17 22:53:09 +05:30
Patrick Donnelly
c4d3040b70
doc/dev: document nested subsets in teuthology
See also: https://github.com/ceph/teuthology/pull/1704

Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2022-03-25 09:12:56 -04:00
Ernesto Puerta
749f2f5746
doc: browser extension for merge message
Signed-off-by: Ernesto Puerta <epuertat@redhat.com>
2022-02-16 17:49:45 +01:00
Ernesto Puerta
63f5fa45fe
Merge pull request #44857 from rhcs-dashboard/test-doc-dash-cephadm
doc: update kcli test env documentation

Reviewed-by: Alfonso Martínez <almartin@redhat.com>
Reviewed-by: Ernesto Puerta <epuertat@redhat.com>
Reviewed-by: Pere Diaz Bou <pdiazbou@redhat.com>
2022-02-04 17:35:54 +01:00
Patrick Donnelly
547b21c0de
doc: document PI .qa symlinks
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2022-02-03 10:08:30 -05:00
Nizamudeen A
8feb2b8fe0 doc: update dashboard kcli test env documentation
Fixes: https://tracker.ceph.com/issues/54105
Signed-off-by: Nizamudeen A <nia@redhat.com>
2022-02-02 13:50:00 +05:30