This commit adds:
1. workflow summary in the first section along with an image.
2. sub-section "Pushing to ceph-ci repository" to second section.
3. file doc/dev/developer_guide/testing_integration_tests/workflow.png
Signed-off-by: Vallari Agrawal <vallari.agrawal@ibm.com>
(cherry picked from commit dc539b3ea8)
Remove mention of "Stable Releases and Backports" from
doc/dev/developer_guide/essentials.rst.
Co-authored-by: Laura Flores <lflores@ibm.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 95916c9190)
We're adding a document that describes:
* the steps performed by the Windows CI job
* artifact structure
* frequently asked questions
The document is meant to assist the Ceph developers in investigating
CI failures. This is especially important as the Windows CI job runs
integration tests that would otherwise only be executed by
Teuthology, thus helping catch potential regressions quickly.
Note that the identified regressions are not necessarily Windows
specific, usually affecting Linux builds as well.
Signed-off-by: Lucian Petrut <lpetrut@cloudbasesolutions.com>
(cherry picked from commit bb7d5b62d9)
Make various improvements to doc/dev/developer_guide/basic-workflow.rst.
Co-authored-by: Anthony D'Atri <anthony.datri@gmail.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit b81d6af1b4)
Add some formatting to a few sections near the end of
doc/dev/developer_guide_basic-workflow.rst.
Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 4c4063a097)
Add an explanation of the "needs-upgrade-testing" label and explain when
to use it.
Laura is the true author of this text.
Co-authored-by: Laura Flores <lflores@ibm.com>
Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 02d5a6a337)
There are 2 more ways to install teuthology. Approach with boostrap
script is easier and more convenient while other approach is more
elaborate but manual, document both of them. Don't delete the currently
documented approach because it lets users install teuthology
conveniently in a custom virtual environment. So, keep all three.
Signed-off-by: Rishabh Dave <ridave@redhat.com>
(cherry picked from commit 899c481d40)
Update the list of component leads in
doc/dev/developer_guide/essentials.rst.
Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 57e9427eac)
Improve a couple of sentences in
doc/dev/developer_guide_testing_integration_tests/tests-integration-testing-teutology-workflow.rst.
Signed-off-by: Zac Dover <zac.dover@proton.me>
(cherry picked from commit 51796e80f3)
In tests-integration-testing-teuthology-workflow.rst,
briefly mention unit_test_summary.yaml and valgrind.yaml
as other files that exist in teuthology archive.
Signed-off-by: Vallari Agrawal <val.agl002@gmail.com>
the latest npm doesn't support setting python as a config like `npm
config set python3` instead it needs to be either set in the node-gyp
explicitly using the node-gyp command or through an environment
variable.
Since we are calling the node-gyp through npm, we need to set the
environment variable which is documented here: https://github.com/nodejs/node-gyp?tab=readme-ov-file#configuring-python-dependency
Accordingly the CMakeLists.txt for dashboard is adapted
Fixes: https://tracker.ceph.com/issues/62844
Signed-off-by: Nizamudeen A <nia@redhat.com>
With node 14, the angular 13 is going into some issues with node-gyp.
```
prebuild-install || node-gyp rebuild
prebuild-install WARN install No prebuilt binaries found (target=14.20.0 runtime=node arch=x64 libc= platform=linux)
make: Entering directory '/home/jenkins-build/build/workspace/ceph-dashboard-cephadm-e2e/src/pybind/mgr/dashboard/frontend/node_modules/tree-sitter/build'
CC(target) Release/obj.target/tree_sitter/vendor/tree-sitter/lib/src/lib.o
AR(target) Release/obj.target/tree_sitter.a
COPY Release/tree_sitter.a
CXX(target) Release/obj.target/tree_sitter_runtime_binding/src/binding.o
```
and in some other environments its like `cb() never called` and stops
the whole `npm ci` process.
After some research, looks like updating node is the way to stop this.
Also, ` npm 7 will block installations if an upstream dependency
conflict is present that cannot be automatically resolved.` https://github.blog/2021-02-02-npm-7-is-now-generally-available/#peer-dependencies
Fixes: https://tracker.ceph.com/issues/62107
Signed-off-by: Nizamudeen A <nia@redhat.com>
Fix a link to "Deploying a Development Cluster" that had been broken
since the transition from master to main.
This is the first part of an initiative to improve the vstart
documentation.
Signed-off-by: Zac Dover <zac.dover@proton.me>
cypress is deprecating preserveOnce and instead favoring using
cy.session(). session is already introduced as part of the upgrade to
cypress 10. So removing the preserveOnce here
Signed-off-by: Nizamudeen A <nia@redhat.com>
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>
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>
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>
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>
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>
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>
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>
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>
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>
