馃摉 Add getting started doc #3596
Conversation
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
size/XL
camilamacedo86
requested review from
Sajiyah-Salat
and removed request for
everettraven and
varshaprasad96
|
/test pull-kubebuilder-e2e-k8s-1-26-0 |
| - Not allow more instances than the size defined in the CR which will be applied | ||
| - Update the Memcached CR status | ||
|
|
||
| Following the steps. |
There was a problem hiding this comment.
| Following the steps. | |
| ###Following the steps. |
in preview following the steps feels like out of place it should br near to create a project.
There was a problem hiding this comment.
The text following the steps should not be a subsection. It is just a description to let the audience be aware that the steps will be provided bellow.
There was a problem hiding this comment.
To me this doesnt looks good. I mean the format. I think we should either add something after following the steps or remove it or make it near create the project. What say?
|
Hello @camilamacedo86 I have done review for the first time. maybe there are suggestions that are not important. Kindly ignore that. I am learning. |
camilamacedo86
force-pushed
the
add-getting-started-doc
branch
2 times, most recently
from
dc4d29c
to
8d04edb
Compare
|
HI @Sajiyah-Salat, Thank you for your review. The suggestions were addressed could you please check it out and LGTM if you are OK with it? |
|
/test pull-kubebuilder-e2e-k8s-1-27-1 |
|
I will check that shortly |
|
Everything looks good. Just check this comment |
docs/book/src/getting-started.md
Outdated
| // Look for Database CR/CRD | ||
| // Check the Database Deployment's replicas size | ||
| // If deployment.replicas size doesn't match cr.size, then update it | ||
| // Then, restart from the beginning of the reconcile |
There was a problem hiding this comment.
Can we add the comment that in this case we Requeue the reconcile request even when there is no error.
| } | ||
| ``` | ||
|
|
||
| #### Return Options |
There was a problem hiding this comment.
Do we need the previous section. Aren't the previous and current one kind of repetitive?
There was a problem hiding this comment.
It seems for me that we have not doc in any place all options.
So, I think that would be great keep this one. WDYT? Can we keep it?
camilamacedo86
force-pushed
the
add-getting-started-doc
branch
from
91397fa
to
9c8adda
Compare
camilamacedo86
force-pushed
the
add-getting-started-doc
branch
from
aafe361
to
ca855fc
Compare
k8s-ci-robot
added
do-not-merge/invalid-commit-message
Co-authored-by: Varsha <varshaprasad96@gmail.com>
camilamacedo86
force-pushed
the
add-getting-started-doc
branch
from
ca855fc
to
a1c6eb5
Compare
k8s-ci-robot
added
size/XL
|
Thank you for your review. |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: camilamacedo86, grzesuav, varshaprasad96 The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
Description
This PR introduces an overview or summary to assist users in getting started more smoothly. We've designed this document to address the most frequently asked initial questions.
While the tutorials offer in-depth information, this document aims to provide a broad understanding in a more concise manner.
See the preview: https://deploy-preview-3596--kubebuilder.netlify.app/getting-started
Closes: #3203