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

Registry new api landing page updates #929

Merged
merged 15 commits into from
Dec 4, 2024

Conversation

ngrayluna
Copy link
Contributor

@ngrayluna ngrayluna commented Nov 19, 2024

Description

Updates Registry landing page to account for API changes that shipped w/ W&B Python SDK 18.6 .

Will add link to notebook once that is approved and merged: wandb/examples#582

Doc preview: https://registry-new-api-landing-pag.docodile.pages.dev/guides/registry

Ticket

https://wandb.atlassian.net/browse/DOCS-1059

Checklist

Check if your PR fulfills the following requirements. Put an X in the boxes that apply.

  • Files I edited were previewed on my local development server with yarn start. My changes did not break the local preview.
  • Build (yarn docusaurus build) was run locally and successfully without errors or warnings.
  • I merged the latest changes from main into my feature branch before submitting this PR.

@ngrayluna ngrayluna requested a review from a team as a code owner November 19, 2024 22:48
docs/guides/registry/intro.md Outdated Show resolved Hide resolved
docs/guides/registry/intro.md Outdated Show resolved Hide resolved
Copy link

cloudflare-workers-and-pages bot commented Nov 20, 2024

Deploying docodile with  Cloudflare Pages  Cloudflare Pages

Latest commit: a28416b
Status: ✅  Deploy successful!
Preview URL: https://711ba736.docodile.pages.dev
Branch Preview URL: https://registry-new-api-landing-pag.docodile.pages.dev

View logs


## How it works
## Learn the basics
Each organization initially contains two registries that you can use to organize your model and dataset artifacts called "Models" and "Datasets", respectively. You can create [additional registries to organize other artifact types based on your organization's needs](./registry_types.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

🚫 [vale] reported by reviewdog 🐶
[Google.Quotes] Commas and periods go inside quotation marks.

## Migrating from the legacy Model Registry to W&B Registry


## Migrate from the legacy Model Registry to W&B Registry
Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ [vale] reported by reviewdog 🐶
[Google.Headings] 'Migrate from the legacy Model Registry to W&B Registry' should use sentence-style capitalization.

@noaleetz noaleetz self-requested a review November 21, 2024 01:56
Copy link
Contributor

@noaleetz noaleetz left a comment

Choose a reason for hiding this comment

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

left comments inline

@ngrayluna
Copy link
Contributor Author

@noaleetz Addressed feedback. Unsure about the image though (see comment)

@noaleetz
Copy link
Contributor

@noaleetz Addressed feedback. Unsure about the image though (see comment)

do you mind re-requesting a review since I'm not sure how to see the comments you left?

@ngrayluna ngrayluna requested a review from noaleetz November 25, 2024 16:48
Copy link
Contributor

Images automagically compressed by Calibre's image-actions

Compression reduced images by 19.9%, saving 7.64 KB.

Filename Before After Improvement Visual comparison
static/images/registry/homepage_registry.png 38.37 KB 30.73 KB -19.9% View diff

430 images did not require optimisation.

The URL that your terminal prints directs you to the project where W&B stores your artifact.
:::

Navigate to the Registry App to view artifact versions that you and other members of your organization publish. To do so, first navigate to W&B. Select **Registry** in the left sidebar below **Applications**. Select the "Model" registry. Within the registry, you should see the "first-collection" collection with your linked artifact version.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we include a gif as these are step by step instructions that are mostly visual

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Can't create .gif right now; W&B is giving me weird permission errors...Will debug and follow up with said .gif.

Copy link
Contributor

@noaleetz noaleetz left a comment

Choose a reason for hiding this comment

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

@estellazx do you want to make a final pass as well (mostly to review the APIs)?

@ngrayluna ngrayluna merged commit 1c48451 into main Dec 4, 2024
6 checks passed
@ngrayluna ngrayluna deleted the registry_new_api_landing_page_updates branch December 4, 2024 16:55
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.

4 participants