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

User instructions for installing Model Registry #137

Merged
merged 5 commits into from
Oct 11, 2024

Conversation

rareddy
Copy link
Contributor

@rareddy rareddy commented Sep 20, 2024

This PR includes documentation for installing Model Registry using oc command on a terminal. This is especially designed for an end-user, not a developer.

How Has This Been Tested?

This has been verified on OpenShift Cluster manually

Merge criteria:

  • The developer has manually tested the changes and verified that the changes work

Copy link
Member

@tarilabs tarilabs left a comment

Choose a reason for hiding this comment

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

thank you @rareddy I believe these are very helpful!

Some small considerations below:

docs/install.md Outdated Show resolved Hide resolved
docs/install.md Outdated Show resolved Hide resolved
docs/install.md Outdated Show resolved Hide resolved
docs/install.md Show resolved Hide resolved
docs/install.md Show resolved Hide resolved
tarilabs
tarilabs previously approved these changes Sep 30, 2024
Copy link
Member

@tarilabs tarilabs left a comment

Choose a reason for hiding this comment

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

Thank you @rareddy for applying feedback from myself and @Al-Pragliola in

and
/lgtm
overall.

The docs/introduction.md looks similar in part to the https://www.kubeflow.org/docs/components/model-registry/overview/#what-is-model-registry

Do you think valuable to reflect the other part in upstream too?

@rareddy
Copy link
Contributor Author

rareddy commented Sep 30, 2024

Thank you for the feedback @tarilabs and @Al-Pragliola.

I have one more update to the usage of the model registry with UI which is still in progress, I will try to submit it soon.

The docs/introduction.md looks similar in part to the https://www.kubeflow.org/docs/components/model-registry/overview/#what-is-model-registry

Do you think valuable to reflect the other part in upstream too?

It is the same, as I copied from there. My intention is to make this guide equivalent to that of what is available Kubeflow upstream, but more aligned with midstream that can serve as upstream for downstream documentation, that we can feed to docs team. However, I am open to suggestions on how we can de-duplicate the information.

Copy link
Member

@tarilabs tarilabs left a comment

Choose a reason for hiding this comment

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

thank you for the UI variant, really appreciated.

/lgtm
with one comment about jargon below:

docs/how-to-use-ui.md Outdated Show resolved Hide resolved
@rareddy rareddy self-assigned this Oct 9, 2024
@rareddy
Copy link
Contributor Author

rareddy commented Oct 9, 2024

looks like somehow I screwed the merge of your changes @tarilabs, need to see how to revert and have a clean merge

…ons then also details on deployment

Signed-off-by: Ramesh Reddy <[email protected]>
… and as well usage patterns of Model Registry. Some portions from the Model Registry introduction is taken as is from Kubeflow Model registry documention. Some document contributions were also made by Matteo Mortari and Alessio Pragliola. Thank you.

Signed-off-by: Ramesh Reddy <[email protected]>
@rareddy rareddy force-pushed the user-install-document branch from 3b13bc7 to ddab3de Compare October 9, 2024 20:33
@rareddy rareddy requested a review from dhirajsb October 9, 2024 20:34
@tarilabs
Copy link
Member

looks like somehow I screwed the merge of your changes @tarilabs, need to see how to revert and have a clean merge

We could always add the co-authored-by in the squash commit during merge if we wanted (noted for who press the button), anyhow no worries.

Anyhow in my view the most pressing thing is having this merged, so we could iterate progressively, rather than on the same PR my2c

@rareddy
Copy link
Contributor Author

rareddy commented Oct 10, 2024

@tarilabs thank you. agreed, I have another topic on "secure database configuration" I need to follow this PR. Not sure about the build issues, if this PR is good I would like to merge this.

@tarilabs
Copy link
Member

Not sure about the build issues

in this PR, everything is inside /docs/** and the GHAs:

pull_request:
paths-ignore:
- 'LICENSE*'
- 'DOCKERFILE*'
- '**.gitignore'
- '**.md'
- '**.txt'
- '.github/ISSUE_TEMPLATE/**'
- '.github/dependabot.yml'
- 'docs/**'

pull_request:
paths-ignore:
- 'LICENSE*'
- '**.gitignore'
- '**.md'
- '**.txt'
- '.github/ISSUE_TEMPLATE/**'
- '.github/dependabot.yml'
- 'docs/**'

so I believe is just GH interface "confused".

@tarilabs tarilabs merged commit a0afa2a into opendatahub-io:main Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants