Skip to content

Add Private Service Connect & rework login info #251

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

Merged

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Jul 16, 2024

Internal Notes for Reviewers

Highlights of this PR:

Private Service Connect

  • Added topic for configuring Google Cloud Private Service Connect:

    image

_variables.yml

To reflect that there are now multiple production login URLs:

Step 1 in task topics

To enable a log in step at the beginning of task topics that works for multiple production URLs:

  • Re-added login topic, now updated with info about public and private URL info about accessing the ValidMind Platform UI

    image

  • Replaced step 1 in task topics with login link to point to login topic instead of platform UI URL

    Before After
    image image

CTAs, training, and other links

  • Updated signup CTAs to use new vm_url_us1 variable (it's the same URL we've always sent people to)
  • Updated training overview to use vm_url_us1 (training modules are unchanged and use HTML links that point to the same URL)
  • Updated release notes links to use vm_url_us1 as the default

Stale content

In an effort not to maintain content that is defunct:

  • Deleted the old guide/get-started-sandbox.qmd file as it's been superseded by our ValidMind Academy content
  • Deleted the defunct site-unused/qmd/get-started-closed-beta.qmd file as we're done with the beta now

Open items

  • As an experiment, is there a step 1 option that feels more elegant? >>> TO BE MOVED INTO A SEPARATE PR

    With Nutshell, via a single-sourced step-1.qmd:

    2024-07-17_07-03-58 (1)

    Notes

    • This single-sourced step cannot start with _ or the extension does not work, meaning there will be a separate step-1.html output topic
    • The Nutshell popups are SLOW
    • The Nutshell info icon text in the top right feels too playful for an enterprise product, might need to hide
    • Some additional styling would be needed for this to look right

    Overall, I'm not sure it's an improvement over linking to the login topic.

    With citationshover: true we could do something like this:

    image

    Notes

    • Very fast, clean look
    • Enabled by default, no extension needed
    • Needs the citation text to appear somewhere in a QMD div, which is a problem? We could single-source the text but then would need to embed it
  • For links that default to using vm_url_us1, will users be able to log in? Need to verify with Spencer.

External Release Notes

Release Notes

We've introduced support for Google Cloud Private Service Connect for enhanced network security and privacy, in addition to the already existing support for AWS PrivateLink. This service allows private connections between ValidMind and your company network, ensuring secure communication over the Google network without exposing traffic to the public internet. By using private endpoints within your VPC, you can reduce your network's attack surface and maintain traffic privacy. Read more ...

@nrichers nrichers added the internal Not to be externalized in the release notes label Jul 16, 2024
@nrichers nrichers marked this pull request as draft July 16, 2024 15:10
@nrichers nrichers changed the title IN PROGRESS — DO NOT REVIEW Add Private Service Connect & rework login info Jul 17, 2024
@nibalizer
Copy link
Contributor

Nik and I reviewed this in a meeting and it looks good. Thanks Nik!

@nrichers nrichers marked this pull request as ready for review July 18, 2024 01:21
@nrichers nrichers added enhancement New feature or request and removed internal Not to be externalized in the release notes labels Jul 18, 2024
@nrichers nrichers requested a review from noosheenv July 18, 2024 02:03
@nrichers
Copy link
Collaborator Author

@noosheenv could you review this PR from the angle of 'do the reworked step 1 instructions work and did Nik break anything (again)', please? Spencer already reviewed for technical accuracy.

@nrichers
Copy link
Collaborator Author

Sanity tested these PR changes further:

  • Step 1 links work as expected, resolve to the login topic
  • CTAs for signup work as expected, resolve to the US1 prod URL
  • Training login steps work as expected, resolve to the US1 prod URL

This looks to be OK, merging.

@nrichers nrichers merged commit 75612a9 into main Jul 18, 2024
3 checks passed
@nrichers nrichers deleted the nrichers/sc-4434/documentation-complete-bny-account-setup branch July 18, 2024 23:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants