Documented user registration process (#410)

validbeck · nrichers · web-flow · commit 253592e8b0b6 · 2024-09-20T09:30:49.000-07:00
* Draft new pages

* New files

* Draft for independent signup

* Last save for the day

* Simplifying some stuff

* Accept invitation draft

* Layout tweaks

* Accept invite wip

* Register done for now

* New registration variable

* Applied new variable across site

* Final tweaks

* Quick tweak

* Cropped images

* Update site/guide/configuration/register-with-validmind.qmd

Co-authored-by: Nik Richers &lt;nik@validmind.ai&gt;

* Update site/guide/configuration/register-with-validmind.qmd

Co-authored-by: Nik Richers &lt;nik@validmind.ai&gt;

* Update site/guide/configuration/register-with-validmind.qmd

Co-authored-by: Nik Richers &lt;nik@validmind.ai&gt;

* Update site/guide/configuration/register-with-validmind.qmd

Co-authored-by: Nik Richers &lt;nik@validmind.ai&gt;

* Tweaks

---------

Co-authored-by: Nik Richers &lt;nik@validmind.ai&gt;
diff --git a/internal/templates/about-validmind.md b/internal/templates/about-validmind.md
@@ -16,7 +16,7 @@ If you haven't already seen our [Get started with the ValidMind Developer Framew
 
 For access to all features available in this notebook, create a free ValidMind account.
 
-Signing up is FREE — [**Sign up now**](https://app.prod.validmind.ai)
+Signing up is FREE — {{< var link.register >}} 
 
 :::
 
diff --git a/site/_quarto.yml b/site/_quarto.yml
@@ -165,7 +165,10 @@ website:
         - guide/guides.qmd
         - text: "---"
         - text: "CONFIGURATION"
-        - guide/configuration/log-in-to-validmind.qmd
+        - file: guide/configuration/accessing-validmind.qmd
+          contents:
+            - guide/configuration/register-with-validmind.qmd
+            - guide/configuration/log-in-to-validmind.qmd
         - file: guide/configuration/managing-your-organization.qmd
           contents:
             - guide/configuration/set-up-your-organization.qmd
diff --git a/site/_variables.yml b/site/_variables.yml
@@ -35,6 +35,7 @@ vm:
 link:
   contact: "[**Contact Us**](https://validmind.com/contact/)"
   login: "[You are logged in to ValidMind.](/guide/configuration/log-in-to-validmind.qmd)"
+  register: "[**Register with ValidMind {{< fa hand-point-right >}} **](/guide/configuration/register-with-validmind.qmd)"
 
 # Short form — URL only
 # Rendered format: `{{< var url.us1 >}}`
diff --git a/site/get-started/developer/try-in-your-own-environment.qmd b/site/get-started/developer/try-in-your-own-environment.qmd
@@ -12,7 +12,7 @@ Learn how to document a model with ValidMind locally in your own developer envir
 To try out ValidMind, you need to be a registered user on the {{< var validmind.platform >}}.
 
 ::: {.callout title="Need an account for ValidMind?"}
-Signing up is FREE — **[Create your account]({{< var url.us1 >}})**.
+Signing up is FREE — {{< var link.register >}} 
 :::
 
 You should be familiar with using standard software development tools, including the command line, and have a developer environment set up locally, such as Visual Studio Code. 
diff --git a/site/get-started/developer/try-with-colab.qmd b/site/get-started/developer/try-with-colab.qmd
@@ -13,7 +13,7 @@ Learn how to document a model with ValidMind on Google Colaboratory.
 - [x] You must have access to [Google Colaboratory (Colab)](https://colab.research.google.com/). 
 
 ::: {.callout title="Need an account for ValidMind?"} 
-Signing up is FREE — **[Create your account]({{< var url.us1 >}})**.
+Signing up is FREE — {{< var link.register >}} 
 :::
 
 Google Colaboratory (Colab) is a free Jupyter Notebook environment that runs in the cloud. You can work with, run, and download our sample Jupyter Notebooks from there.
diff --git a/site/get-started/developer/try-with-jupyterhub.qmd b/site/get-started/developer/try-with-jupyterhub.qmd
@@ -18,7 +18,7 @@ Learn how to document a model with ValidMind on JupyterHub.
 To try out ValidMind, you need to be a registered user on the {{< var validmind.platform >}}.
 
 ::: {.callout title="Need an account for ValidMind?"}
-Signing up is FREE — **[Create your account]({{< var url.us1 >}})**.
+Signing up is FREE — {{< var link.register >}} 
 :::
 
 :::
diff --git a/site/get-started/get-started.qmd b/site/get-started/get-started.qmd
@@ -86,7 +86,7 @@ The fastest way to explore what ValidMind can offer is with our [QuickStart](qui
 If you have already tried the QuickStart, more how-to instructions and links to our FAQs can be found under [Next steps](platform/next-steps.qmd).
 
 ::: {.callout title="Need an account for ValidMind?"}
-Signing up is FREE — **[Create your account]({{< var url.us1 >}})**.
+Signing up is FREE — {{< var link.register >}} 
 :::
 
 
diff --git a/site/get-started/platform/explore-sample-model-documentation.qmd b/site/get-started/platform/explore-sample-model-documentation.qmd
@@ -23,7 +23,7 @@ The {{< var validmind.platform >}} is the central place to:
 - [x] Next, make sure you're [logged in to ValidMind {{< fa hand-point-right >}}](/guide/configuration/log-in-to-validmind.qmd).
 
 ::: {.callout title="Need an account for ValidMind?"}
-Signing up is FREE — **[Create your account]({{< var url.us1 >}})**.
+Signing up is FREE — {{< var link.register >}} 
 :::
 
 :::
diff --git a/site/get-started/platform/generate-documentation-for-your-model.qmd b/site/get-started/platform/generate-documentation-for-your-model.qmd
@@ -13,7 +13,7 @@ You are now ready to modify the QuickStart notebook you used earlier and run it
 - [x] Next, make sure you're [logged in to ValidMind {{< fa hand-point-right >}}](/guide/configuration/log-in-to-validmind.qmd).
 
 ::: {.callout title="Need an account for ValidMind?"}
-Signing up is FREE — **[Create your account]({{< var url.us1 >}})**.
+Signing up is FREE — {{< var link.register >}} 
 :::
 
 :::
diff --git a/site/get-started/platform/register-your-first-model.qmd b/site/get-started/platform/register-your-first-model.qmd
@@ -13,7 +13,7 @@ To be able to document models with the {{< var validmind.platform >}}, you need
 - [x] Next, make sure you're [logged in to ValidMind {{< fa hand-point-right >}}](/guide/configuration/log-in-to-validmind.qmd).
 
 ::: {.callout title="Need an account for ValidMind?"}
-Signing up is FREE — **[Create your account]({{< var url.us1 >}})**.
+Signing up is FREE — {{< var link.register >}} 
 :::
 
 :::
diff --git a/site/get-started/quickstart.qmd b/site/get-started/quickstart.qmd
@@ -12,7 +12,7 @@ The easiest way to get started with ValidMind is to try out our {{< var vm.devel
 To try out ValidMind, you need to be a registered user on the {{< var validmind.platform >}}.
 
 ::: {.callout title="Need an account for ValidMind?"}
-Signing up is FREE — **[Create your account]({{< var url.us1 >}})**.
+Signing up is FREE — {{< var link.register >}} 
 :::
 
 :::
diff --git a/site/guide/configuration/_validmind-public-internet.qmd b/site/guide/configuration/_validmind-public-internet.qmd
@@ -0,0 +1,8 @@
+1. In a web browser, open one of the the URLs for the {{< var validmind.platform >}}:
+
+    | Name | Provider | Region | URL |
+    |--|--|--|----------|
+    | US1 | AWS | `us-east-1` | [{{< var url.us1 >}}]({{< var url.us1 >}}) |
+    | CA1 | AWS | `ca-west-1` | [{{< var url.ca1 >}}]({{< var url.ca1 >}}) |
+    
+    If unsure which URL to use, we recommend US1 or consult your organization for data stewardship requirements.^[**For example:** If your data must stay in Canada, use CA1.]
diff --git a/site/guide/configuration/accessing-validmind.qmd b/site/guide/configuration/accessing-validmind.qmd
@@ -0,0 +1,16 @@
+---
+title: "Accessing Validmind"
+date: last-modified
+listing:
+  - id: guides-access
+    type: grid
+    max-description-length: 250
+    grid-columns: 3
+    sort: false
+    fields: [title, description]
+    contents:
+    - register-with-validmind.qmd
+    - log-in-to-validmind.qmd
+---
+
+To use ValidMind to track your models and oversee your model management process, you'll need to first sign up and then log in to the {{< var vm.platform >}}.
diff --git a/site/guide/configuration/email-verified.png b/site/guide/configuration/email-verified.png
diff --git a/site/guide/configuration/log-in-to-validmind.qmd b/site/guide/configuration/log-in-to-validmind.qmd
@@ -30,25 +30,18 @@ ValidMind supports the following methods for logging in:
 <!-- For most users, someone with the Customer Admin role will invite you to your organization.  -->
 
 ::: {.callout title="Need an account for ValidMind?"}
-Signing up is FREE — **[Create your account]({{< var url.us1 >}})**.
+Signing up is FREE — {{< var link.register >}} 
 :::
 
 :::
 
 ## Public internet
 
-1. In a web browser, open one of the the URLs for the {{< var validmind.platform >}}:
-   
-   | Name | Provider | Region | URL |
-   |--|--|--|----------|
-   | US1 | AWS | `us-east-1` | [{{< var url.us1 >}}]({{< var url.us1 >}}) |
-   | CA1 | AWS | `ca-west-1` | [{{< var url.ca1 >}}]({{< var url.ca1 >}}) |
-   
-   If unsure which URL to use, we recommend US1 or consult your organization for data stewardship requirements.[^1]
+{{< include _validmind-public-internet.qmd >}}
 
-2. Click **Sign in to ValidMind**. 
+1. Click **Sign in to ValidMind**. 
 
-3. Choose one of the login options:
+1. Choose one of the login options:
 
    - Enter your email address and password, and click **Continue**.
    - Select one of the single sign-on (SSO) login options, such as Google, GitHub, or Microsoft, and complete the login steps. 
@@ -68,6 +61,4 @@ To configure and log in through a private endpoint for your company VPC using a
 - [Managing users](managing-users.qmd)
 - [Personalize ValidMind](personalize-validmind.qmd)
 
-<!-- FOOTNOTES -->
 
-[^1]: **For example:** If your data must stay in Canada, use CA1.
diff --git a/site/guide/configuration/main-dashboard.png b/site/guide/configuration/main-dashboard.png
diff --git a/site/guide/configuration/organization-accept-invitation.png b/site/guide/configuration/organization-accept-invitation.png
diff --git a/site/guide/configuration/organization-invitation-email.png b/site/guide/configuration/organization-invitation-email.png
diff --git a/site/guide/configuration/register-with-validmind.qmd b/site/guide/configuration/register-with-validmind.qmd
@@ -0,0 +1,222 @@
+---
+title: "Register with ValidMind"
+date: last-modified
+filters:
+  - tachyons
+---
+
+Register with our cloud-hosted {{< var validmind.platform >}}, so you can begin working with model documentation or configure ValidMind for your organization.
+
+With an email address or a Google,[^1] GitHub,[^2] or Microsoft[^3] account, you can gain access to ValidMind in two ways:
+
+1. [Sign up independently](#sign-up-independently)
+2. [Accept an invite](#accept-an-invite)
+
+::: {.prereq}
+
+## Prerequisites
+
+- [x] Access to ValidMind via the public internet.
+- [x] Alternatively, you have been invited by someone else in your organization to join ValidMind.
+- [x] Additionally, an email address that is able to receive messages from ValidMind.[^4]
+
+::: {.callout}
+For most users, someone with the Customer Admin role[^5] will invite you to your organization.
+:::
+
+:::
+
+## Sign up independently 
+
+::: {.callout title="This method will allow you to create a brand new organization to which your account will be linked to as a Customer Admin user."}
+Choose this method if you intend to set up your organization for your institution. 
+:::
+
+{{< include _validmind-public-internet.qmd >}}
+
+2. On the welcome screen, click **Sign up**.
+
+3. Enter your email address and input a secure, unique password, or choose one of the single sign-on options to link to your account:
+
+    - **Continue with Google**
+    - **Continue with GitHub**
+    - **Continue with Microsoft Account**
+
+::: {.column-margin}
+![ValidMind signup welcome screen](signup-welcome-screen.png){width=90% fig-alt="Screenshot of the Validmind signup welcome screen"}
+:::
+
+4. Click **Continue**.
+
+5. Complete your user profile details:
+
+    - **[first name]{.smallcaps}** — Your given name.
+    - **[last name]{.smallcaps}** — Your surname.
+    - **[organization]{.smallcaps}**[^6] — The name of your organization you are setting up ValidMind on behalf of.
+    - **[job title]{.smallcaps}** — Your role at your organization.
+
+![ValidMind profile completion screen](signup-complete-profile.png){width=80% fig-alt="Screenshot of the ValidMind profile completion screen"}
+
+6. Review the terms and conditions, then select **Yes, I accept the <u>terms & conditions</u>**[^7] to indicate that you accept them.
+
+    Optionally, select the following if desired:
+
+    a. **Yes, sign me up for updates from ValidMind**[^8] — Sign up for news from ValidMind
+    b. **Yes, I want to join your online community**[^9] — Request to join our online community
+
+7. Check the email inbox for the address you used to sign up with ValidMind for the following email:
+
+    - From: `no-reply@validmind.ai`
+    - Subject: "Verify your email"
+
+![Verification email sent by ValidMind](verify-email.png){width=80% fig-alt="Screenshot of the verification email sent by ValidMind"}
+  
+::: {.column-margin}
+If you cannot locate this email, you may need to review your spam or junk mail folders and filters, or request that your IT allow-list our owned domains or retrieve any messages sent by:
+
+a. `validmind.ai`
+b. `validmind.com`
+:::
+
+::: {.column-margin}
+![Confirmation of email verification](email-verified.png){fig-alt="Screenshot of the confirmation of email verification"}
+:::
+
+8. Click **<u>Confirm my account</u>** to gain full access to ValidMind.
+
+9. Return to the main ValidMind dashboard[^10] by clicking on **Back to ValidMind**. 
+
+    Sample models[^11] are populated for you in this new organization to demonstrate the usage of ValidMind.
+
+:::: {.flex .flex-wrap .justify-around}
+::: {.w-40-ns}
+![ValidMind's main dashboard](main-dashboard.png){fig-alt="Screenshot of the main ValidMind dashboard"}
+:::
+::: {.w-40-ns}
+![Sample models populated by ValidMind](sample-models.png){fig-alt="Screenshot of the sample models populated by ValidMind"}
+:::
+::::
+
+## Accept an invite 
+
+::: {.callout title="This method will allow you to register as user linked to your institution's existing organization."}
+These steps require that you have been invited[^12] by a Customer Admin user to join your organization on ValidMind.
+:::
+
+1. Check the email inbox for the address you provided your organization to be associated with ValidMind for the following email:
+
+    - From: `no-reply@validmind.ai`
+    - Subject: "{User} invited you to join ValidDemo on ValidMind"
+
+    `{User}` is replaced with the name of the Customer Admin or other user who invited you to join. 
+
+::: {.column-margin}
+If you cannot locate this email, you may need to review your spam or junk mail folders and filters, or request that your IT allow-list our owned domains or retrieve any messages sent by:
+
+a. `validmind.ai`
+b. `validmind.com`
+:::
+
+2. Within the email, click **Accept Invitation**.
+
+![ValidMind organization invite email](organization-invitation-email.png){width=80% fig-alt="Screenshot of the Validmind organization invite email"}
+
+3. On the page that opens up in your web browser, click **Accept Invitation**.
+
+![ValidMind accept invitation to join an organization screen](organization-accept-invitation.png){width=80% fig-alt="Screenshot of the ValidMind accept invitation to join an organization screen"}
+
+::: {.column-margin}
+![ValidMind signup welcome screen](signup-welcome-screen.png){width=90% fig-alt="Screenshot of the Validmind signup welcome screen"}
+:::
+
+4. On the Welcome screen, enter your email address and input a secure, unique password, or choose one of the single sign-on options to link to your account:
+
+    - **Continue with Google**
+    - **Continue with GitHub**
+    - **Continue with Microsoft Account**
+
+::: {.callout-important}
+Make sure that the email or account you use to link to ValidMind is the one that was invited to join your organization.
+:::
+
+5. Check the email inbox for the address you used to sign up with ValidMind for the following email:
+
+    - From: `no-reply@validmind.ai`
+    - Subject: "Verify your email"
+
+![Verification email sent by ValidMind](verify-email.png){width=80% fig-alt="Screenshot of the verification email sent by ValidMind"}
+  
+::: {.column-margin}
+If you cannot locate this email, ou may need to review your spam or junk mail folders and filters, or request that your IT allow-list our owned domains or retrieve any messages sent by:
+
+a. `validmind.ai`
+b. `validmind.com`
+:::
+
+::: {.column-margin}
+![Confirmation of email verification](email-verified.png){fig-alt="Screenshot of the confirmation of email verification"}
+:::
+
+6. Click **<u>Confirm my account</u>** to gain full access to ValidMind.
+
+7. Return to the main ValidMind dashboard[^13] by clicking on **Back to ValidMind**. 
+    
+    Sample models[^14] are populated for you in this new organization to demonstrate the usage of ValidMind.
+
+:::: {.flex .flex-wrap .justify-around}
+::: {.w-40-ns}
+![ValidMind's main dashboard](main-dashboard.png){fig-alt="Screenshot of the main ValidMind dashboard"}
+:::
+::: {.w-40-ns}
+![Sample models populated by ValidMind](sample-models.png){fig-alt="Screenshot of the sample models populated by ValidMind"}
+:::
+::::
+
+## What's next
+
+- [Managing your organization](managing-your-organization.qmd)
+- [Managing users](managing-users.qmd)
+- [Personalize ValidMind](personalize-validmind.qmd)
+
+
+<!-- FOOTNOTES -->
+
+[^1]: **Google:** [Single sign-on](https://cloud.google.com/architecture/identity/single-sign-on)
+
+[^2]: **GitHub:** [SAML single sign-on](https://docs.github.com/en/enterprise-cloud@latest/authentication/authenticating-with-saml-single-sign-on/about-authentication-with-saml-single-sign-on)
+
+[^3]: **Microsoft:** [What is single sign-on?](https://learn.microsoft.com/en-us/entra/identity/enterprise-apps/what-is-single-sign-on)
+
+[^4]:
+
+    To receive invitation and verification emails from ValidMind, you may need to first request that your IT allow-list our owned domains or retrieve any messages sent by:
+
+    a. `validmind.ai`
+    b. `validmind.com`
+
+[^5]: [Manage roles](manage-roles.qmd)
+
+[^6]: [Managing your organization](managing-your-organization.qmd)
+
+[^7]: 
+
+    ::: {.callout}
+    ## ValidMind terms and conditions
+
+    [View in full {{< fa hand-point-right >}}](https://validmind.com/about/legal/)
+
+    :::
+
+[^8]: **ValidMind:** [Code, Contribution, and Community.](https://validmind.com/community/)
+
+[^9]: [ValidMind community](/about/contributing/validmind-community.qmd)
+
+[^10]: [Customize your dashboard](customize-your-dashboard.qmd)
+
+[^11]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)
+
+[^12]: [User invitations](/guide/configuration/manage-users.qmd#user-invitations)
+
+[^13]: [Customize your dashboard](customize-your-dashboard.qmd)
+
+[^14]: [Working with the model inventory](/guide/model-inventory/working-with-model-inventory.qmd)
diff --git a/site/guide/configuration/sample-models.png b/site/guide/configuration/sample-models.png
diff --git a/site/guide/configuration/signup-complete-profile.png b/site/guide/configuration/signup-complete-profile.png
diff --git a/site/guide/configuration/signup-welcome-screen.png b/site/guide/configuration/signup-welcome-screen.png
diff --git a/site/guide/configuration/verify-email.png b/site/guide/configuration/verify-email.png
diff --git a/site/guide/guides.qmd b/site/guide/guides.qmd
@@ -8,7 +8,7 @@ listing:
     sort: false
     fields: [title, description]
     contents:
-    - configuration/log-in-to-validmind.qmd
+    - configuration/accessing-validmind.qmd
   - id: guides-onboarding
     type: grid
     max-description-length: 250
