Skip to content

Cleaned up more docs site variables#203

Merged
validbeck merged 7 commits intomainfrom
beck/sc-4447/cleanup-retool-of-docs-site-variables
May 27, 2024
Merged

Cleaned up more docs site variables#203
validbeck merged 7 commits intomainfrom
beck/sc-4447/cleanup-retool-of-docs-site-variables

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

Internal Notes for Reviewers

For sc-4447, I changed references to the following with appropriate variables:

  • Developer Framework
  • ValidMind model risk management platforms
  • ValidMind Platform
  • MRM Platform
  • ValidMind UI
  • framework

Edge cases

Anything remaining in the site .qmd files that come up in searches for these are because:

  • They are within an alt text or Mermaid chart, as those cannot accommodate variables*
  • They were a direct quotation of something that used to display in the UI in a highlight/release file*
  • They are part of a code comment, and should be human readable within the file
  • For framework: They are referencing a different kind of framework, such as "governance framework" in regulatory guidance discussions

*For these, I've left a comment above the instance somewhere along the lines of <!-- Using the variable in alt text messes up the image display -->

@validbeck validbeck added the internal Not to be externalized in the release notes label May 24, 2024
@validbeck validbeck self-assigned this May 24, 2024
@validbeck validbeck requested a review from nrichers May 24, 2024 22:30
Copy link
Copy Markdown
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! One comment about what the preferred practice should be for compound URLs (URLs that are part variable, part URL path). :shipit:

Also, I missed this in my review of your first PR, but we broke all the ze buttons, as variables inside of HTML do not work. For example, I fixed this yesterday:

image

(Fixed in my https://github.com/validmind/documentation/tree/nrichers/sc-4580/bny-create-training-collateral branch and already fixed on the prod branch as a temporary measure.)

@validbeck
Copy link
Copy Markdown
Collaborator Author

but we broke all the ze buttons, as variables inside of HTML do not work.

Oh durr, thanks for catching that.

Not within the scope of this PR but it feels like these compound URLs with variable + URL path don't buy us anything and they are likely more prone to breakage.

Great point, I'll keep an eye out.

@validbeck validbeck merged commit 911c795 into main May 27, 2024
@validbeck validbeck deleted the beck/sc-4447/cleanup-retool-of-docs-site-variables branch May 27, 2024 16: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