Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: mounting volumes, secrets and configmaps for devworkspaces #2296

Merged
merged 11 commits into from
May 3, 2022

Conversation

dkwon17
Copy link
Contributor

@dkwon17 dkwon17 commented Apr 19, 2022

Signed-off-by: David Kwon dakwon@redhat.com

What does this pull request change

  • Replaces the current mounting docs for devworkspace-specific mounting docs.
  • Adds Creating image pull Secrets section

Before this PR:
image

After this PR:
image

Sources used:

What issues does this pull request fix or reference

eclipse-che/che#21299

Specify the version of the product this pull request applies to

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.

  • Any procedure:
    • Successfully tested.
  • Any page or link rename:
  • Builds on Eclipse Che hosted by Red Hat.
  • the Validate language on files added or modified step reports no vale warnings.

@github-actions
Copy link

Click here to review and test in web IDE: Contribute

@che-bot che-bot added this to Triage in Reviews Apr 19, 2022
@themr0c themr0c added this to the 7.46 milestone Apr 20, 2022
@themr0c themr0c moved this from Triage to Drafts in Reviews Apr 20, 2022
@dkwon17 dkwon17 force-pushed the mounting-resources branch 4 times, most recently from 6df6bb4 to 9b7459c Compare April 21, 2022 16:29
Signed-off-by: David Kwon <dakwon@redhat.com>
@dkwon17 dkwon17 marked this pull request as ready for review April 21, 2022 20:44
@che-bot che-bot moved this from Drafts to Triage in Reviews Apr 21, 2022
@max-cx
Copy link
Contributor

max-cx commented Apr 22, 2022

I will review this PR.

@dkwon17
Copy link
Contributor Author

dkwon17 commented Apr 22, 2022

Thank you @max-cx, I've edited the PR description to provide some context

Copy link
Contributor

@l0rd l0rd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of having one main section "mounting volumes, secrets and configmaps" I would split like this:

  1. Injecting configurations and credentials (that's about CM, Secrets)
    a. Configuring git
    b. Configuring container registries
  2. Persisting and sharing files (that's about pre created PVs)

modules/end-user-guide/pages/mounting-volumes.adoc Outdated Show resolved Hide resolved
modules/end-user-guide/pages/mounting-volumes.adoc Outdated Show resolved Hide resolved
modules/end-user-guide/pages/mounting-volumes.adoc Outdated Show resolved Hide resolved
modules/end-user-guide/pages/mounting-volumes.adoc Outdated Show resolved Hide resolved
modules/end-user-guide/pages/image-pull-secrets.adoc Outdated Show resolved Hide resolved
@dkwon17 dkwon17 force-pushed the mounting-resources branch 2 times, most recently from 0b44b86 to d2284db Compare April 26, 2022 22:01
@dkwon17
Copy link
Contributor Author

dkwon17 commented Apr 26, 2022

Thanks a lot for the reviews @max-cx , @l0rd. I've applied and made new changes.

@dkwon17 dkwon17 force-pushed the mounting-resources branch 3 times, most recently from 6eb7c3d to 85a848a Compare April 26, 2022 22:09
@dkwon17
Copy link
Contributor Author

dkwon17 commented Apr 26, 2022

Preview of the main section:
image

Signed-off-by: dakwon <dakwon@redhat.com>
@max-cx
Copy link
Contributor

max-cx commented Apr 28, 2022

@dkwon17, my next PR is ready dkwon17#11

max-cx and others added 2 commits April 28, 2022 15:24
Signed-off-by: David Kwon <dakwon@redhat.com>
@dkwon17
Copy link
Contributor Author

dkwon17 commented Apr 28, 2022

I don't think the current build failure is caused by this PR. I get the same failure in the master branch:

========================================================================
docs/next/administration-guide/checluster-custom-resource-fields-reference/index.html
  Non-OK status: 404 --- docs/next/administration-guide/checluster-custom-resource-fields-reference/index.html --> https://developers.redhat.com/products/openshift-dev-spaces/overview
docs/next/administration-guide/supported-platforms/index.html
  Get "https://developers.redhat.com/products/codeready-containers/overview": stopped after 10 redirects --- docs/next/administration-guide/supported-platforms/index.html --> https://developers.redhat.com/products/codeready-containers/overview
========================================================================
✘✘✘ failed in 1.377997186s
2 errors in 357 documents

@max-cx max-cx mentioned this pull request Apr 29, 2022
6 tasks
@dkwon17 dkwon17 force-pushed the mounting-resources branch 3 times, most recently from adb4ea8 to 1f39963 Compare April 29, 2022 20:47
Signed-off-by: David Kwon <dakwon@redhat.com>
@themr0c themr0c requested a review from a team as a code owner May 3, 2022 07:51
@themr0c themr0c requested review from amisevsk and removed request for a team May 3, 2022 07:51
@max-cx
Copy link
Contributor

max-cx commented May 3, 2022

@dkwon17, pls see more edits from me in the form of dkwon17#13.

Copy link
Contributor

@max-cx max-cx left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Signed-off-by: David Kwon <dakwon@redhat.com>
@dkwon17 dkwon17 merged commit e5223c3 into eclipse-che:master May 3, 2022
Reviews automation moved this from Triage to Done May 3, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Reviews
  
Done
6 participants