Skip to content
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

adds query strings to IdP guides #1302

Merged
merged 7 commits into from
Mar 18, 2024
Merged

adds query strings to IdP guides #1302

merged 7 commits into from
Mar 18, 2024

Conversation

ZPain8464
Copy link
Contributor

This PR adds query strings to Tabs. Now, when you send a link that includes an anchor link within a Tab, the page will scroll to the correct location.

Note: I did add queryString to the Config and Envar Tabs, too. If you click one of these tabs, and then click another Tab in a separate block, with a query string, it will conjoin them. For example:

<Tabs queryString="foo-a">
<TabItem value="bar-a"></TabItem>
<TabItem value="baz-a"></TabItem>
</Tabs>
<Tabs queryString="foo-b">
<TabItem value="bar-b"></TabItem>
<TabItem value="baz-b"></TabItem>
</Tabs>

Selecting baz-a and then bar-b would result in a string like:

?foo-a=baz-a&foo-b=bar-b. A real life example:

/docs/identity-providers/github?configuration-settings=environment-variables&get-groups=directory-sync

It's entirely possible that user would unwittingly select both Tabs, which would break the functionality. I want the team's input, but maybe we should only add query strings to one tab block in a page going forward? Happy to document this internally.

Resolves #1288

@ZPain8464 ZPain8464 requested a review from a team as a code owner March 8, 2024 21:57
@ZPain8464 ZPain8464 requested review from cmo-pomerium and removed request for a team March 8, 2024 21:57
Copy link

netlify bot commented Mar 8, 2024

Deploy Preview for pomerium-docs ready!

Name Link
🔨 Latest commit df91ce6
🔍 Latest deploy log https://app.netlify.com/sites/pomerium-docs/deploys/65f8858f69657700086be410
😎 Deploy Preview https://deploy-preview-1302--pomerium-docs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@ZPain8464
Copy link
Contributor Author

@kenjenkins I've updated this to remove queryString from the Google guide. I'd like to test the other guides with the strings added just to see if it's helpful at all.


Unfortunately, Google does not yet support getting groups data using a custom claim. Groups must be loaded by using a plugin to fetch directory information (see Enterprise's Directory Sync).
Unfortunately, Google doesn't support getting groups data with a custom claim. To get and use groups data from your Google directory, you must conduct a directory sync in the Enterprise Console.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think I've mentioned this before, but "conduct a directory sync" makes this sound like a one-time event. I'd suggest we phrase this more like "enable directory sync" to help reflect that directory sync is a recurring process.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think this stems from a misunderstanding on my part of how directory sync works. I thought it was a one-time sync, I'll update. Thanks for catching that.

@ZPain8464 ZPain8464 merged commit 7531d67 into main Mar 18, 2024
2 checks passed
@ZPain8464 ZPain8464 deleted the zpain/add-query-strings branch March 18, 2024 18:19
backport-actions-token bot pushed a commit that referenced this pull request Mar 18, 2024
* updates auth0 and azure  guides

* adds querystring to idp guides

* removes tabs from Google idp guide

* runs prettier

* runs prettier

* fixes formatting issue

* updates text
ZPain8464 added a commit that referenced this pull request Mar 18, 2024
adds query strings to IdP guides (#1302)

* updates auth0 and azure  guides

* adds querystring to idp guides

* removes tabs from Google idp guide

* runs prettier

* runs prettier

* fixes formatting issue

* updates text

Co-authored-by: zachary painter <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: links to section won't open the section if it is inside a tab that is not selected by default
2 participants