Skip to content

Fixed broken docs links in .ipynb#131

Merged
validbeck merged 6 commits intomainfrom
beck/sc-5132/fix-broken-external-links-out-to-restructured
Jul 4, 2024
Merged

Fixed broken docs links in .ipynb#131
validbeck merged 6 commits intomainfrom
beck/sc-5132/fix-broken-external-links-out-to-restructured

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

Internal Notes for Reviewers

For sc-5132, I fixed the following links in the Jupyter Notebook files based on this search:

Old URL New Page
https://docs.validmind.ai/guide/samples-jupyter-notebooks.html https://docs.validmind.ai/developer/samples-jupyter-notebooks.html
https://docs.validmind.ai/guide/get-started-developer-framework.html https://docs.validmind.ai/developer/get-started-developer-framework.html
https://docs.validmind.ai/guide/join-community.html https://docs.validmind.ai/about/contributing/join-community.html
https://docs.validmind.ai/guide/register-models-in-model-inventory.html https://docs.validmind.ai/guide/model-inventory/register-models-in-inventory.html
https://docs.validmind.ai/guide/testing-overview.html https://docs.validmind.ai/developer/model-testing/testing-overview.html
https://docs.validmind.ai/guide/get-started.html https://docs.validmind.ai/get-started/get-started.html
https://docs.validmind.ai/guide/swap-documentation-templates.html https://docs.validmind.ai/guide/model-documentation/swap-documentation-templates.html

Process

  1. I searched for the old URL
  2. I swapped to the text editor to replace the URLs one-by-one
  3. I swapped back to the Jupyter preview to check that the new link worked
  4. ???
  5. Profit

Placeholder links

You'll notice that the OLD links also have placeholders so links are not really broken, but I would ideally like to remove them once migration is complete. To do that, I'll need an assist from @cachafla to update our JupyterHub instances with these latest .ipynb files.

I'm able to upload the version of the notebooks to Colab myself (as long as they are the ones in this drive here), but I don't believe I have proper access to our JupyterHub to replace the files. I'd be happy to sit in on a JupyterHub shadowing session if someone wants to show me how to do that though. :)

@validbeck validbeck added the internal Not to be externalized in the release notes label Jul 4, 2024
@validbeck validbeck self-assigned this Jul 4, 2024
@validbeck validbeck requested review from cachafla and nrichers July 4, 2024 17:25
Copy link
Copy Markdown
Contributor

@cachafla cachafla left a comment

Choose a reason for hiding this comment

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

👌

@validbeck validbeck merged commit 3ba7e57 into main Jul 4, 2024
@validbeck validbeck deleted the beck/sc-5132/fix-broken-external-links-out-to-restructured branch July 4, 2024 17:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants