Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Appearance settings

Instructions for upgrading ValidMind#490

Merged
validbeck merged 8 commits intomainvalidmind/documentation:mainfrom
beck/sc-6810/add-troubleshooting-info-for-stale-validmindvalidmind/documentation:beck/sc-6810/add-troubleshooting-info-for-stale-validmindCopy head branch name to clipboard
Oct 23, 2024
Merged

Instructions for upgrading ValidMind#490
validbeck merged 8 commits intomainvalidmind/documentation:mainfrom
beck/sc-6810/add-troubleshooting-info-for-stale-validmindvalidmind/documentation:beck/sc-6810/add-troubleshooting-info-for-stale-validmindCopy head branch name to clipboard

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented Oct 23, 2024

Internal Notes for Reviewers

sc-6810

LIVE PREVIEW

How to upgrade

Updated the single-source instructions:

Screenshot 2024-10-23 at 10 51 34 AM

Install and initialize the client library

Retooled this page into two sections:

  1. Install ValidMind
  2. Upgrade ValidMind:
Screenshot 2024-10-23 at 10 52 24 AM

Support & Troubleshooting

Screenshot 2024-10-23 at 10 52 41 AM
  • Cleaned up the Support pages
  • Added Cannot access expected features and How to upgrade to Troubleshooting:
Cannot access expected features How to upgrade
Screenshot 2024-10-23 at 10 53 02 AM Screenshot 2024-10-23 at 10 53 28 AM

@validbeck validbeck added the internal Not to be externalized in the release notes label Oct 23, 2024
@validbeck validbeck self-assigned this Oct 23, 2024
@validbeck validbeck requested a review from nrichers October 23, 2024 18:09
@github-actions
Copy link
Contributor

PR Summary

This pull request introduces several enhancements to the documentation related to the installation and upgrade of the ValidMind client library. The changes include:

  1. Installation and Initialization Documentation:

    • Added a new section on upgrading ValidMind to ensure users can access the latest features and enhancements.
    • Improved the structure by introducing subheadings for better readability, such as "Install ValidMind", "Initialize the client library", and "Upgrade ValidMind".
    • Provided detailed instructions on checking the current version of ValidMind and upgrading it if necessary.
  2. Support and Troubleshooting Enhancements:

    • Added a grid listing in the support section to provide quick access to troubleshooting resources and contact information.
    • Introduced a new troubleshooting section for common issues like accessing expected features and installation problems.
    • Included footnotes for easy navigation to related sections and external resources.
  3. Release Notes Update:

    • Updated the release notes to include detailed steps for upgrading the ValidMind developer framework in different environments, such as JupyterHub and personal developer environments.

These changes aim to improve the user experience by providing clear, structured, and comprehensive guidance on managing the ValidMind client library.

Test Suggestions

  • Verify that the installation instructions for ValidMind are clear and lead to a successful installation.
  • Test the upgrade process by following the new documentation to ensure it correctly updates the ValidMind library.
  • Check the troubleshooting steps for common issues to ensure they resolve the problems as described.
  • Ensure that all links and references in the documentation are correct and lead to the intended resources.
  • Validate the new grid layout in the support section for proper rendering and functionality.

Copy link
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

LGTM, just some minor suggested edits you can commit. 🚀

site/releases/_how-to-upgrade.qmd Outdated Show resolved Hide resolved
validbeck and others added 3 commits October 23, 2024 16:33
Co-authored-by: Nik Richers <nik@validmind.ai>
…nt-library.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>
…nt-library.qmd

Co-authored-by: Nik Richers <nik@validmind.ai>
@validbeck validbeck merged commit 693b857 into main Oct 23, 2024
@validbeck validbeck deleted the beck/sc-6810/add-troubleshooting-info-for-stale-validmind branch October 23, 2024 23:33
@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

2 similar comments
@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

@github-actions
Copy link
Contributor

A PR preview is available: Preview URL

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

Morty Proxy This is a proxified and sanitized view of the page, visit original site.