fix: Update security best practices doc #2848
Conversation
|
🎊 Navigate the preview: https://679c1727856509a2ae9a8491--eclipse-che-docs-pr.netlify.app 🎊 |
|
Click here to review and test in web IDE: |
-525C86?logo=eclipse-che&labelColor=red){kind=icon}
| where cluster administrators control provisioning for each user | ||
| and can explicitly configure various settings including resource limits and quotas. | ||
| Learn more about project provisioning in the link:https://eclipse.dev/che/docs/stable/administration-guide/mounting-a-secret-as-a-file-or-an-environment-variable-into-a-container/#mounting-a-secret-or-a-configmap-as-an-environment-variable-into-a-container[product documentation]. | ||
| Learn more about project provisioning in the xref:administration-guide:provisioning-namespaces-in-advance.adoc[product documentation]. |
There was a problem hiding this comment.
I noticed that the current link was incorrect. I've updated it to the correct link, and also, I've used xref: instead of link:
There was a problem hiding this comment.
| Learn more about project provisioning in the xref:administration-guide:provisioning-namespaces-in-advance.adoc[product documentation]. | |
| Learn more about project provisioning in the xref:provisioning-namespaces-in-advance.adoc[]. |
There was a problem hiding this comment.
If I apply this change right now, the link does not work, probably because the security best practices doc is not in the administration guide:
Can/should we move the security best practices doc to the administration guide?
There was a problem hiding this comment.
I see what's happening with the xref (was too focused on the formatting). I don't mind the current set up with the security best practices doc being a standalone but moving it to admin guide would solve the issue I'm currently having with getting it to display properly in downstream docs.
There was a problem hiding this comment.
@ibuziuk is it ok if I move the security best practices doc to the admin guide?
|
hi David, I moved the security practices doc and all of its parts into the admin guide #2860 so please update the xrefs. let me know if you need help with them. the |
Signed-off-by: dkwon17 <dakwon@redhat.com>
Signed-off-by: dkwon17 <dakwon@redhat.com>
dkwon17
force-pushed
the
security-best-practices
branch
from
9e1336b to
8b8a55c
Compare
|
@deerskindoll thank you, I've rebased against main and updated this PR so that the |
* fix: Update security best practices doc Signed-off-by: dkwon17 <dakwon@redhat.com> * Update xref Signed-off-by: dkwon17 <dakwon@redhat.com> --------- Signed-off-by: dkwon17 <dakwon@redhat.com>
2 participants
What does this pull request change?
I've updated some content on the security best practices section: https://eclipse.dev/che/docs/stable/overview/security-best-practices/
What issues does this pull request fix or reference?
Part of verification: https://issues.redhat.com/browse/CRW-7851
Specify the version of the product this pull request applies to
DS 3.18 / Che 7.95
Pull Request checklist
The author and the reviewers validate the content of this pull request with the following checklist, in addition to the automated tests.
Validate language on files added or modifiedstep reports no vale warnings.