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.

Sign up for GitHub

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

Jump to bottom

Small updates to Central Dashboard docs #3946

Merged
merged 12 commits into from
Feb 20, 2025
Merged

Small updates to Central Dashboard docs #3946

merged 12 commits into from
Feb 20, 2025
+5 −5

Conversation

varodrig
Copy link
Contributor

  • Minor updates to Central Dashboard documentation

@google-oss-prow Google OSS Prow
Copy link

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@varodrig varodrig marked this pull request as ready for review December 17, 2024 19:05
Arhell
Arhell reviewed Dec 28, 2024
View reviewed changes
Copy link
Member

@Arhell Arhell left a comment

Choose a reason for hiding this comment

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

lgtm

@varodrig
Copy link
Contributor Author

/assign @thesuperzapper

@varodrig
Copy link
Contributor Author

varodrig commented Jan 19, 2025 •
edited
Loading

@thesuperzapper @ederign any news on this PR?

thesuperzapper
thesuperzapper requested changes Jan 30, 2025
View reviewed changes
Copy link
Member

@thesuperzapper thesuperzapper left a comment

Choose a reason for hiding this comment

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

A few comments.

varodrig and others added 2 commits January 31, 2025 18:11
@varodrig @thesuperzapper
Update content/en/docs/components/central-dash/profiles.md
e8a891f 
Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
Signed-off-by: Valentina Rodriguez Sosa <64439402+varodrig@users.noreply.github.com>
@varodrig @thesuperzapper
Update content/en/docs/components/central-dash/customize.md
be9b8fb 
Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
Signed-off-by: Valentina Rodriguez Sosa <64439402+varodrig@users.noreply.github.com>
terrytangyuan
terrytangyuan reviewed Feb 2, 2025
View reviewed changes
Copy link
Member

@terrytangyuan terrytangyuan left a comment

Choose a reason for hiding this comment

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

I am not sure about these changes. I feel like most of these linked concepts (namespace, configmap, CRD, etc.) should be prerequisites before reading or learning about Kubeflow

@varodrig
Copy link
Contributor Author

varodrig commented Feb 7, 2025

I am not sure about these changes. I feel like most of these linked concepts (namespace, configmap, CRD, etc.) should be prerequisites before reading or learning about Kubeflow

Do you think adding a link to the technical documentation will not help the reader? I agree that people should probably know already about it, but what if you do not remember a specific concept at that time.
Do you think we should assume that all our audience are knowledge about CRDs and other kubernetes concepts?

varodrig and others added 2 commits February 7, 2025 12:54
@varodrig @thesuperzapper
Update content/en/docs/components/central-dash/profiles.md
af11a4a 
Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
Signed-off-by: Valentina Rodriguez Sosa <64439402+varodrig@users.noreply.github.com>
@varodrig @thesuperzapper
Update content/en/docs/components/central-dash/profiles.md
bfb661e 
Co-authored-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
Signed-off-by: Valentina Rodriguez Sosa <64439402+varodrig@users.noreply.github.com>
@terrytangyuan
Copy link
Member

No preference here

@varodrig
Copy link
Contributor Author

@thesuperzapper any news on this? Are they are changes needed?

Thanks.

@andreyvelich
Copy link
Member

/assign @terrytangyuan @kubeflow/wg-manifests-leads @thesuperzapper Please review when you have time.

thesuperzapper
thesuperzapper requested changes Feb 14, 2025
View reviewed changes
content/en/docs/components/central-dash/profiles.md Outdated
@@ -6,13 +6,17 @@ weight = 20

## What is a Kubeflow Profile?

A Profile is a Kubernetes CRD introduced by Kubeflow that wraps a Kubernetes Namespace.
A Kubeflow Profile is a [Kubernetes CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) introduced by Kubeflow that wraps a Kubernetes [Namespace](https://kubernetes.io/docs/tasks/administer-cluster/namespaces-walkthrough/).

Copy link
Member

Choose a reason for hiding this comment

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

Can we keep this as a single paragraph, It's a bit short otherwise.

That is, can we remove these new lines.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

resolved

@thesuperzapper
Copy link
Member

/retitle Small updates to Central Dashboard docs

@google-oss-prow google-oss-prow bot changed the title Minor updates to website documentation Small updates to Central Dashboard docs Feb 14, 2025
@varodrig
remove lines
e8f4d42 
Signed-off-by: varodrig <varodrig@redhat.com>
@varodrig
Copy link
Contributor Author

/assign @terrytangyuan @kubeflow/wg-manifests-leads @thesuperzapper Please review when you have time.
PR ready

juliusvonkohout
juliusvonkohout reviewed Feb 18, 2025
View reviewed changes
content/en/docs/components/central-dash/profiles.md Outdated
Profile are owned by a single user, and can have multiple contributors with view or modify access.
The owner of a profile can add and remove contributors (this can also be done by the cluster administrator).

A Kubeflow Profile is a [Kubernetes CRD](https://kubernetes.io/docs/concepts/extend-kubernetes/api-extension/custom-resources/#customresourcedefinitions) introduced by Kubeflow that wraps a Kubernetes [Namespace](https://kubernetes.io/docs/tasks/administer-cluster/namespaces-walkthrough/). Profile are owned by a single user, and can have multiple contributors with view or modify access. The owner of a profile can add and remove contributors (this can also be done by the cluster administrator).
Copy link
Member

Choose a reason for hiding this comment

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

ProfileS are owned by a single user,

Copy link
Member

@thesuperzapper thesuperzapper Feb 20, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I pushed a fix to the branch for this

@juliusvonkohout
Copy link
Member

/lgtm

are there any strong objections? Because otherwise I would approve it as well.

@google-oss-prow google-oss-prow bot added the lgtm label Feb 18, 2025
@thesuperzapper
fix typos
fb674a2 
Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
@thesuperzapper
fix typos 2
9a85ec1 
Signed-off-by: Mathew Wicks <5735406+thesuperzapper@users.noreply.github.com>
@google-oss-prow google-oss-prow bot added size/S and removed size/XS labels Feb 20, 2025
@thesuperzapper
Copy link
Member

I pushed a commit to the branch to fix the typo of "Profile" when it should have been "profiles" (not from your PR, but was already there in the website).

It's fine to mere now.

/lgtm
/approve

@google-oss-prow google-oss-prow bot added the lgtm label Feb 20, 2025
@google-oss-prow Google OSS Prow
Copy link

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: thesuperzapper

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 /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@google-oss-prow google-oss-prow bot merged commit 0a9eeff into kubeflow:master Feb 20, 2025
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@terrytangyuan terrytangyuan terrytangyuan left review comments

@thesuperzapper thesuperzapper thesuperzapper requested changes

@Arhell Arhell Arhell left review comments

@juliusvonkohout juliusvonkohout juliusvonkohout left review comments

@kimwnasptd kimwnasptd Awaiting requested review from kimwnasptd

Assignees

@thesuperzapper thesuperzapper

@juliusvonkohout juliusvonkohout

Labels
approved lgtm size/S
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@varodrig @terrytangyuan @andreyvelich @thesuperzapper @juliusvonkohout @Arhell