dvc.org icon indicating copy to clipboard operation
dvc.org copied to clipboard

Model registry docs consolidation

Open dberenbaum opened this issue 1 year ago • 3 comments

This is an attempt to rework the docs in response to feedback that it's confusing and makes it hard to get started with our tools. I started with model registry because it's more limited than trying to redo experiments or data management.

The goal is to address a few different issues:

The PR drops the two model registry overview pages in the Studio docs:

  • https://dvc.org/doc/studio/model-registry
  • https://dvc.org/doc/studio/user-guide/model-registry

The content was integrated into other pages (often it was already in other pages). The idea is to have high-level docs in one place and product-specific docs only for detailed guides/reference.

dberenbaum avatar Feb 16 '24 19:02 dberenbaum

Link Check Report

There were no links to check!

github-actions[bot] avatar Feb 16 '24 20:02 github-actions[bot]

@yathomasi Heroku is throwing an error:

 !     Compiled slug size: 1.4G is too large (max is 500M).
 !     See: http://devcenter.heroku.com/articles/slug-size
 !     Push failed

Any ideas how to fix it? Can adding static files to the static repo (see https://github.com/iterative/dvc.org/issues/4837) help?

dberenbaum avatar Feb 20 '24 20:02 dberenbaum

Any ideas how to fix it?

I see it didn't run the gatsby build command at all so ended with huge size of node modules and cache.

I have retriggered the build manually and hope it will be fixed. ICYMI: there is a Manual deploy section in Deploy tab

Screenshot 2024-02-21 at 11 54 09

UPD: Deployed successfully.

yathomasi avatar Feb 21 '24 06:02 yathomasi

I'd added these 2 redirects, but they seem to be not working when I run this locally:

  "^/doc/start/model-management/model-registry$                                           /doc/start/model-registry/manage-models",
  "^/doc/start/model-management(/.*)?$                                                    /doc/start/model-registry$1",

Not sure what is wrong. @yathomasi any suggestions?

Other than this, LGTM.

tapadipti avatar Feb 23 '24 03:02 tapadipti

It seems to be working with preview deployment so we should be fine to merge. BTW, the second rule would cover the first one as well.

https://dvc-org-start-add-model-crakny.herokuapp.com/doc/start/model-management/model-registry -> https://dvc-org-start-add-model-crakny.herokuapp.com/doc/start/model-registry/manage-models

https://dvc-org-start-add-model-crakny.herokuapp.com/doc/start/model-management/test -> https://dvc-org-start-add-model-crakny.herokuapp.com/doc/start/model-registry/test

I would suggest running build mode with yarn build and then run yarn start to test the redirects.

We did have it integrated for development mode with yarn develop, but it might be broken and we are okay with that as redirect logic is little separate from the gatsby project itself.

yathomasi avatar Feb 23 '24 07:02 yathomasi

Thanks @yathomasi

BTW, the second rule would cover the first one as well.

Probably not, coz in the first one, the sub-page is also different: model-management/model-registry redirects to model-registry/manage-models

tapadipti avatar Feb 23 '24 11:02 tapadipti