Skip to content

New 'before you begin' PR with Parris' updates, plus edits #111

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

Merged
merged 11 commits into from
Jul 10, 2023

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Jul 4, 2023

Internal Notes for Reviewers

This PR replaces #108 which has some issues with deleting files we still need. This PR basically consists of only the following files, checked out from the before_you_begin branch:

  • site/notebooks/before_you_begin.ipynb
  • site/notebooks/Quickstart_Customer Churn_full_suite copy.ipynb

I added Co-authored-by: Parris Mook-Sang-Forbes <parris@validmind.ai> to make sure Parris gets credit for the original work.

Outstanding to-dos:

  • move before-you-begin template into templates/ folder to avoid externalizing it
  • make sure product names are proper nouns
  • add some info about why creating a documentation project matters
  • don't send people to Support
  • reduce the number of callouts
  • hardcode help links in the notebook to make sure they work from anywhere
  • update the authoritative source of the Quickstart notebook once we have approval from Andres

We also need to update all the other notebooks we plan to use this with in some follow-on pull requests.

Current output

image

External Release Notes

We added some template examples that we can apply to our Jupyter notebooks to make the prerequisites easier to understand. The template adds a "Before you begin" section that describes the prerequisites.

@nrichers nrichers added documentation Improvements or additions to documentation internal Not to be externalized in the release notes labels Jul 4, 2023
Co-authored-by: Parris Mook-Sang-Forbes <parris@validmind.ai>
@nrichers nrichers force-pushed the before_you_begin_fix branch from fab8765 to 25b2ac7 Compare July 4, 2023 21:42
@nrichers nrichers requested a review from cachafla July 5, 2023 02:44
@nrichers nrichers changed the title Check out files to keep from PR #108 New 'before you begin' PR with Parris' updates, plus edits Jul 5, 2023
@nrichers
Copy link
Collaborator Author

nrichers commented Jul 6, 2023

@sydneysugar are you able to address Andres' last comment and then roll this out to the different notebooks we embed in our docs? I will provide a list of the canonical source for each notebook (two in gdrive, the rest in the validmind-python repo). Once the notebooks are updated, we can run make get-source, update the rendered docs site and and republish it.

This is the section to remove:

image

@nrichers
Copy link
Collaborator Author

nrichers commented Jul 6, 2023

@nrichers
Copy link
Collaborator Author

nrichers commented Jul 7, 2023

@cachafla if you are OK with us merging this template, can you approve? Sydney has removed the section "Initialize the Python environment" as requested.

Copy link
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.

🙌

@sydneysugar sydneysugar merged commit 5dc7428 into main Jul 10, 2023
@sydneysugar sydneysugar deleted the before_you_begin_fix branch July 10, 2023 15:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation internal Not to be externalized in the release notes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants