-
Notifications
You must be signed in to change notification settings - Fork 4
docs: Standardise support email & URL #1112
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
docs: Standardise support email & URL #1112
Conversation
nrichers
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good change, my only request is that we keep the existing long form and short form sections clean. Please move the new variables into their own section for support.
PR SummaryThis PR introduces dynamic support URL configurations into the project's documentation. A new section for support URLs has been added to the _variables.yml file, allowing the support center and email values to be configured as variables. Additionally, markdown files for AWS, Azure, and Google configuration have been updated to reference these new support variables instead of hard-coded email addresses and URLs. This change ensures consistency across the documentation and simplifies future updates by centralizing support URL management. Test Suggestions
|
Lighthouse check resultsShow Lighthouse scoresFolder depth level checked: 0 Commit SHA: 5e789cc Modify the workflow to check a different depth:
|
Validate docs site✓ INFO: A live preview of the docs site is available — Open the preview |
|
@nrichers Good call, was wondering what I should do with those variables but your suggestion makes sense. I've updated them, please refer to the edited PR description for more details: #1112 (comment) |
nrichers
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! 🚀
Pull Request Description
What and why?
We have a mix of references to our support email and support URL in the docs site, sometimes using .ai and sometimes .com. Standardised the usage with two new variables that reference:
support.center: support.validmind.comsupport.email: support@validmind.comHow to test
You can pull down the PR and add the variables anywhere and preview and it will show up as expected, with the exception(s) labelled under "What needs special review?"
What needs special review?
Exceptions
Variable exception
Any URLs in listing paths CANNOT be a variable, as this breaks the link. For example:
documentation/site/support/support.qmd
Line 25 in 0433800
Mailto exception
Apparently, variables also don't work with
<email@domain.com>, so those have been changed to markdown mailto links.General note
Note
We have other instances of
validmind.aihanging out, but I choose to go.comwith the support as our main website resolves from.aito.com. For some reason,docs.validmind.aiis the exception.Dependencies, breaking changes, and deployment notes
I noticed the support centre needs you to be logged in now — not sure if that was a change that was made deliberately (probably) but it feels like that changes how the messaging around it is phrased.
Release notes
n/a
Checklist