Skip to content

Updated variable naming conventions#263

Merged
validbeck merged 23 commits intomainfrom
beck/sc-5612/update-variable-naming-conventions
Aug 7, 2024
Merged

Updated variable naming conventions#263
validbeck merged 23 commits intomainfrom
beck/sc-5612/update-variable-naming-conventions

Conversation

@validbeck
Copy link
Copy Markdown
Collaborator

@validbeck validbeck commented Aug 1, 2024 •
edited
Loading

Internal Notes for Reviewers

For sc-5612, I decided to ask for forgiveness rather than permission 😆

New variable convention

While reading through more of their docs, I realised that Quarto actually has an option for grouping variables: 1 level nested arrays!

new-rendered-variables

See new file: https://github.com/validmind/documentation/blob/beck/sc-5612/update-variable-naming-conventions/site/_variables.yml

Updates to CONFIGURATION pages

Log into ValidMind

  • I changed this to Log in to ValidMind, as the convention around log in (the verb) and login (the noun) is always "log in," and not "log into."
  • I also added a variable back in for this to link to this corrected page on instructions.
  • I moved this OUT of "Managing your organization," as this is actually the first step to getting anywhere in the platform.
  • There is now also a "What's next" section, directing you to organization setup, user management, and profile viewing
Old New
old-log-in new-log-in

Managing your organization

  • Updated the"What's next" section to include the new Google VPC page
Old New
old-managing-org Screenshot 2024-08-01 at 2 20 54 PM

EDIT: Added the login page to the Guides landing:

Old New
Screenshot 2024-08-06 at 10 04 44 AM Screenshot 2024-08-06 at 10 04 07 AM

validbeck added 19 commits August 1, 2024 11:02
@validbeck
Draft of new variables
0ff7c0a
@validbeck
Rendered variable examples
e0bcfc5
@validbeck
Moved test variable files & adjusted ValidMind login page
ee4a51b
@validbeck
Changed instances of log into to log in to
368477b
@validbeck
Changed var validmind_platform to var validmind.platform
fabae52
@validbeck
Changed var validmind_developer to var validmind.developer
7206e27
@validbeck
Changed var risk_platform to var validmind.product
974e773
@validbeck
Changed var platform to var vm.platform
c341595
@validbeck
Changed var developer to var vm.developer
d0adffd
@validbeck
Changed var vm_contact to var link.contact
856f803
@validbeck
Changed var vm_url_us1 to var url.us1
9c84869
@validbeck
Changed var vm_url_ca1 to var url.ca1
e5f57be
@validbeck
Changed var vm_privatelink to var aws.privatelink
1607104
@validbeck
Changed var vm_private_service_connect_validmind to var psc.validmind
2c0480f
@validbeck
Changed var vm_private_service_connect_auth to var psc.authentication
e149c13
@validbeck
Changed var python_version to var version.python
a65f08f
@validbeck
Changed var api_host to var api.host
ba75971
@validbeck
Changed 1. Log into ... to {{< var link.login >}}
48f0f73
@validbeck
Quick tweak to managing org grid columns
329d5f5
@validbeck validbeck added the internal Not to be externalized in the release notes label Aug 1, 2024
@validbeck validbeck self-assigned this Aug 1, 2024
@validbeck validbeck requested review from noosheenv and nrichers August 1, 2024 21:22
nrichers
nrichers reviewed Aug 6, 2024
View reviewed changes
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.

Is it weird that I was reading through the Quarto docs over the holidays and ran across the same page for variable arrays? They remind me of the compound or stemmed variables I used when I worked on IBM z/OS mainframes many, many years ago.

This PR is a great thing, my only comment is around the variables for Google's Private Service Connect. Not sure if you want to discuss further?

@validbeck validbeck requested a review from nrichers August 6, 2024 23:55
nrichers
nrichers approved these changes Aug 6, 2024
View reviewed changes
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.

Latest changes look great. Ship it! 🚢

@validbeck validbeck merged commit 1bd4b6b into main Aug 7, 2024
@validbeck validbeck deleted the beck/sc-5612/update-variable-naming-conventions branch August 7, 2024 00:02
@nrichers
Copy link
Copy Markdown
Collaborator

nrichers commented Aug 8, 2024

I changed this to Log in to ValidMind, as the convention around log in (the verb) and login (the noun) is always "log in," and not "log into."

One postscript on this, though the upshot is that I don't actually mind either way: "Log in" is the the verb form, true, but both "log in to" and "log into" are valid if slightly different grammatical constructions. In a previous role, we had a huge discussion about the difference among the writers — I tend to err on the side of simplicity and typically have used "log into" but this comment is a good summary of why either works.

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

@noosheenv noosheenv Awaiting requested review from noosheenv

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