-
Notifications
You must be signed in to change notification settings - Fork 4
Fixed broken external links out to restructured docs site #239
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
Fixed broken external links out to restructured docs site #239
Conversation
nrichers
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Re: this bit in the main README.md: "tests — This is where tests retrieved from the developer-framework repo live."
I missed this in my original review, but we don't actually retrieve the tests. I can't comment on the line as it's not being changed in this PR, but a more accurate description would be:
This is where test descriptions generated from the Python source in the [developer-framework repo](https://github.com/validmind/developer-framework) live.
(We generate the test descriptions ourselves from the Python source via https://github.com/validmind/documentation/blob/main/site/Makefile#L68.)
Main ValidMind README
Minor: It looks like the updated QuickStart link there doesn't go to the QuickStart on JupyerHub directly. I assume that's intentional but, if not, it might make sense to have all the QuickStart links go to the same place for consistency.
@nrichers FTR,
make get-sourceoverrode my edits to this notebook, so I had to retrieve them again (thankfully I sent up an atomic commit!).
Yup, if you run make get-source, the notebook from our documentation main branch gets checked out. I'm sorry you ran into this issue — every exception or special case tends to bite us sooner or later and this one is, er, no exception. After we start including executed notebooks by default (or we sort out OAuth issues with JupyterHub), we can get rid of the special case.
As mentioned in validmind/validmind-library#131 & validmind/validmind-library#132 @cachafla will have to help with uploading the modified notebooks to JupyterHub
Either Spencer or Cullen can do this now, but we need to coordinate with Michael to make sure there are no demos going on, as redeploying will restart JupyterHub for everyone.
Also, these are in the Colab folder but not actually in the notebooks zip anymore (probably got renamed?)
Good catch! At this point, only the QuickStart should still be on Colab. I have removed the other notebooks and retested the QuickStart link.
Changed, thank you!
Hm, it DOES go to the JupyterHub Quickstart — this was based on your link in another PR you suggested: https://docs.validmind.ai/get-started/developer/try-with-jupyterhub.html
Gotcha, I will make a follow-up story in Infra and tag everyone then 🫡 |
Are we looking at the same thing? I'm referring to the organization readme:
|
Ah, I was looking at the |
Done, via validmind/.github@f08fb60 |

Internal Notes for Reviewers
All the links on these files should be updated to link out to the new restructured docs!
intro_for_model_developers_EXECUTED.ipynb
@nrichers FTR,
make get-sourceoverrode my edits to this notebook, so I had to retrieve them again (thankfully I sent up an atomic commit!). I don't know if the Makefile is checking against themaindocs repo or thedeveloper-frameworkrepo (makes sense it would be the former?) so hopefully after this PR is merged that shouldn't happen again.JupyterHub & Colab
As mentioned in PR#131 & PR#132 @cachafla will have to help with uploading the modified notebooks to JupyterHub.
I have updated the following file for Colab however:
quickstart_customer_churn_full_suite.ipynbNotebooks not found:
Also, these are in the Colab folder but not actually in the
notebookszip anymore (probably got renamed?):credit_risk_scorecard_demo.ipynbIntroduction_Customer_Churn.ipynbnlp_sentiment_analysis_catboost_demo.ipynbprobability_of_default_validmind.ipynbtutorial_time_series_forecasting.ipynbFrontend
There's an open PR for this: https://github.com/validmind/frontend/pull/842