Skip to content

Add community page to docs site #113

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
merged 5 commits into from
Aug 2, 2023
Merged

Add community page to docs site #113

merged 5 commits into from
Aug 2, 2023

Conversation

nrichers
Copy link
Collaborator

@nrichers nrichers commented Jul 11, 2023

Internal Notes for Reviewers

With our new main site still under development, I was looking for a suitable place to add the community sign-up form we can point people to. For now, this pull request adds a new "Community" page that embeds the form I demoed during the team weekly:

image

Behind the scenes, this is a single-line embedding of the form inside of an HTML codeblock so that Quarto passes it through. Tested and it works as expected.

External Release Notes

ValidMind is working to create a community designed to foster knowledge sharing, collaboration, and professional growth in the Model Risk Management (MRM) field. To this end, we added a new community page to our docs site where you can sign up for our MRM Community Slack space.

We invite you to join our Slack community channels, where you can discuss topics related to model risk management with others and get community support for our ValidMind products. Learn more ...

@nrichers nrichers added documentation Improvements or additions to documentation highlight Feature to be curated in the release notes labels Jul 11, 2023
@nrichers nrichers requested a review from mehdi0501 July 11, 2023 05:18
@nrichers
Copy link
Collaborator Author

nrichers commented Jul 12, 2023

@mehdi0501 this is the PR we discussed earlier today. If you could take a look, I would be much obliged. (Since our chat this morning, I moved the new "Community" section up a bit in the left sidebar, as shown in the updated screenshot.)

Copy link
Contributor

@mehdi0501 mehdi0501 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good. one small suggestion might be to call the page "Community Sign Up" or "Join our Community" (instead of "Community").

@nrichers
Copy link
Collaborator Author

Looks good. one small suggestion might be to call the page "Community Sign Up" or "Join our Community" (instead of "Community").

Yes, I will update the title along the lines suggested. In my mind, I was already thinking about expanding this section in the future for other community-specific activities (say, related to participating in GitHub discussions), but that's probably a bit premature. For now, let's just keep the title accurately scoped.

@nrichers nrichers removed documentation Improvements or additions to documentation highlight Feature to be curated in the release notes labels Jul 31, 2023
@github-actions
Copy link
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation.

1 similar comment
@github-actions
Copy link
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation.

@sydneysugar sydneysugar added enhancement New feature or request and removed enhancement New feature or request labels Jul 31, 2023
@github-actions
Copy link
Contributor

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation.

@github-actions
Copy link
Contributor

Pull requests must include at least one of the required labels: internal, highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@nrichers nrichers added internal Not to be externalized in the release notes documentation Improvements or additions to documentation and removed internal Not to be externalized in the release notes labels Jul 31, 2023
@github-actions
Copy link
Contributor

Pull requests must include a description in the release notes section.

1 similar comment
@github-actions
Copy link
Contributor

Pull requests must include a description in the release notes section.

@nrichers
Copy link
Collaborator Author

nrichers commented Aug 1, 2023

@p-m-s-f I think there is a way to hide this bit about signing in:

image image

The thing is, this is a CSS hack, as the CORS for the <iframe> we use to embed the form technically doesn't allow this. But you could enclose the form embed with something that essentially modifies this class. I looked into this and found some info: https://stackoverflow.com/questions/217776/how-to-apply-css-to-iframe.

Is this something we can do?

EDIT: The two classes to hide are likely these. One hides the extra horizontal line and the other hides the sign-in text.

image

@nrichers
Copy link
Collaborator Author

nrichers commented Aug 1, 2023

One other comment for you, @p-m-s-f : as mentioned during our standup, CORS will prevent cross-domain CSS injection, so whatever option we try out will need to modify the CSS on the fly as the form is being rendered. The challenge will be to come up with something that works across the major browsers.

@nrichers
Copy link
Collaborator Author

nrichers commented Aug 1, 2023

@p-m-s-f OK, one more comment and then I will stop meddling with your hacking. 😄 I was able to modify the form itself so that in an incognito window it doesn't show the sign-in. However, in a normal window it now says "Saving disabled" so we're still left with the need to modify the CSS on the fly to hide the associated class.

Incognito window:

image

Regular window:

image

@p-m-s-f
Copy link
Contributor

p-m-s-f commented Aug 1, 2023

@nrichers i don't see the Saving disabled text when previewing the page on my browser. i tried previewing it on an incognito window, and switching to microsoft edge, but in both cases i still didn't see it. have you tried re-rendering the page in quarto and seeing if the text persists?

image

@nrichers
Copy link
Collaborator Author

nrichers commented Aug 1, 2023

I see this message in FireFox, Safari, and Chrome when I am logged into my Google account, so it would affect anyone who is actively logged into Google. Here are the three browsers side by side:

image

have you tried re-rendering the page in quarto and seeing if the text persists?

This should have no effect on the rendering of the form, as we basically just embed the form via iframes into HTML. If the section is visible in the form, it will be visible in the rendered HTML output from the side, but the form is not rendered as part of building the site.

@p-m-s-f
Copy link
Contributor

p-m-s-f commented Aug 1, 2023

I see this message in FireFox, Safari, and Chrome when I am logged into my Google account, so it would affect anyone who is actively logged into Google.

it didn't show up when i was signed into my google account on firefox (or when i was signed out in incognito mode). i tried signing into google on microsoft edge but i'm still not seeing any change.

image
image

@nrichers
Copy link
Collaborator Author

nrichers commented Aug 2, 2023

I added a commit that lives the page available but hides it from the navigation. This way, we can enable OW sign-ups but without advertising that we have this option widely.

@nrichers nrichers merged commit 38bb9b2 into main Aug 2, 2023
@nrichers nrichers deleted the community-signup branch August 2, 2023 16:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants