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

Replace references to product names in documentation#190

Merged
validbeck merged 12 commits intomainvalidmind/documentation:mainfrom
beck/sc-4216/replace-references-to-product-names-in-documentationvalidmind/documentation:beck/sc-4216/replace-references-to-product-names-in-documentationCopy head branch name to clipboard
May 13, 2024
Merged

Replace references to product names in documentation#190
validbeck merged 12 commits intomainvalidmind/documentation:mainfrom
beck/sc-4216/replace-references-to-product-names-in-documentationvalidmind/documentation:beck/sc-4216/replace-references-to-product-names-in-documentationCopy head branch name to clipboard

Conversation

@validbeck
Copy link
Collaborator

@validbeck validbeck commented May 10, 2024

Internal Notes for Reviewers

Changes are live on the demo site: https://docs-demo.vm.validmind.ai/

Quick fixes

  • FIxed bõrked variables in the style guide
  • Fixed some typos in the glossary

Variable replacement

Old variables New variables
Screenshot 2024-05-10 at 12 34 55 PM Screenshot 2024-05-10 at 12 34 38 PM

Added a ValidMind AI risk platform variable

  • You can now reference this phrase using {{< var vm_risk >}}
  • I've also updated the style guide to reflect this new variable

Replaced all variables in .qmd files

  • I replaced any instances and variations of ValidMind Developer Framework, developer framework, ValidMind Platform UI, platform UI, and ValidMind AI risk platform I could find, mostly manually and doing several checks
  • Some exceptions are references to these terms in alt text, Mermaid charts and things like internal comments

Replaced the link text in _quarto.yml

Screenshot 2024-05-10 at 12 37 44 PM

  • In the navigation, I replaced any instances of the above variables in link text (but not any header text that needs to be all-caps for example)

Some "loose" pages...?

I noticed while previewing things the following pages reachable on the live site but aren't attached to any sidebar navigation:

*These ones aren't linked or referenced anywhere in another guide.

@validbeck validbeck self-assigned this May 10, 2024
@validbeck validbeck requested a review from nrichers May 10, 2024 19:45
@github-actions
Copy link
Contributor

github-actions bot commented May 10, 2024

Pull requests must include at least one of the required labels: internal, highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@validbeck validbeck added the internal Not to be externalized in the release notes label May 10, 2024
@nrichers
Copy link
Collaborator

nrichers commented May 11, 2024

I noticed while previewing things the following pages reachable on the live site but aren't attached to any sidebar navigation:

I actually detached that as it serves no purpose on its own. We could re-attach or remove.

This is incomplete (might be useful for the workflow story we have open?) and needs search: false added to the top if it's not in there already.

This can be removed.

This can be removed.

@validbeck
Copy link
Collaborator Author

validbeck commented May 13, 2024

@nrichers Cool, thank you for the context for those pages.

Any chance you could approve these current edits and I'll make a separate PR/Story to adjust for those pages?

@nrichers
Copy link
Collaborator

nrichers commented May 13, 2024

Any chance you could approve these current edits and I'll make a separate PR/Story to adjust for those pages?

Yup, just give me a chance to finish reviewing. I got through a good part of your PR on Friday but then ran out of time.

nrichers
nrichers requested changes May 13, 2024
View reviewed changes
Copy link
Collaborator

@nrichers nrichers left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Great PR, @validbeck! 🚀🚀🚀

I requested some changes to variablify (that's a word, right?) a few more variations of text that includes product names, e.g. "Developer Framework" and "ValidMind Platform". That'll remove some incorrect proper noun spellings as well.

To start organizing the variables file, I pushed 70a4f33 to group variables into product names, product URLs, and environment.

Let me know when the changes are made and I'll approve!

site/guide/working-with-model-documentation.qmd Show resolved Hide resolved
site/guide/generate-model-documentation.qmd Show resolved Hide resolved
site/about/overview-model-risk-management.qmd Show resolved Hide resolved
@validbeck
Update _variables.yml
c9538e0 
Adjusted the URL variable in preparation for sc-4310
@validbeck validbeck requested a review from nrichers May 13, 2024 20:15
nrichers
nrichers approved these changes May 13, 2024
View reviewed changes
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 — still two comments to address, e.g. around current uses of "Developer Framework and "ValidMind Platform" that need to become variables, but the issue around vm_ui is resolved nicely. If you prefer not to address this now, I would suggest parking this in a Shortcut story so we can get it sorted at some point.

@validbeck
Copy link
Collaborator Author

validbeck commented May 13, 2024

@nrichers I will create a Story to address those additional changes as mentioned on the huddle, sorry that was unclear! Thank you for your patience while I muddled through this and made a mess of things. I will tag you on the Story once it's created.

@validbeck validbeck merged commit 9d69583 into main May 13, 2024
@validbeck validbeck deleted the beck/sc-4216/replace-references-to-product-names-in-documentation branch May 13, 2024 20:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@nrichers nrichers nrichers approved these changes

Assignees

@validbeck validbeck

Labels

internal Not to be externalized in the release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

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