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

Docs: updates duplicate/missing references #1211

Merged
merged 1 commit into from
Jan 30, 2024
Merged

Conversation

ZPain8464
Copy link
Contributor

@ZPain8464 ZPain8464 commented Jan 30, 2024

This PR:

  • Adds fragments to all identity-provider-settings paths
  • Removes the client-certificate-authority entry
  • Updates polling-max-delay description to use maximum instead of minimum

Note: One discrepancy is the identity-provider-polling-min-max-delay ID in reference.json, which isn't consistent with the anchor link: The anchor link is #identity-provider-minmax-delay, so the path uses this fragment instead of the key/id found in the reference file.

Resolves https://github.com/pomerium/internal/issues/1701

@ZPain8464 ZPain8464 requested a review from a team as a code owner January 30, 2024 21:54
@ZPain8464 ZPain8464 requested review from cmo-pomerium and removed request for a team January 30, 2024 21:54
Copy link

netlify bot commented Jan 30, 2024

Deploy Preview for pomerium-docs ready!

Name Link
🔨 Latest commit 711d1c2
🔍 Latest deploy log https://app.netlify.com/sites/pomerium-docs/deploys/65b9701dcbcd37000890effe
😎 Deploy Preview https://deploy-preview-1211--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.

@@ -129,14 +129,6 @@
"short_description": "Certificate relative file location string",
"services": []
},
"client-certificate-authority": {
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 it would be better to remove this entry in a separate PR, if this PR will be backported to the v0.25 docs site. The corresponding change in Core (pomerium/pomerium#4918) won't be released until v0.26 at the earliest.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@kenjenkins thanks for letting me know. I don't see a purpose in backporting these changes unless we want the idp fragments to be available in v25 for some reason?

Copy link
Contributor

Choose a reason for hiding this comment

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

It's nice for the reference table entries to link directly to the corresponding setting documentation, but I agree it's not a major issue, so if you want to skip backporting this PR I think that would be fine as well.

@ZPain8464 ZPain8464 merged commit 7564dae into main Jan 30, 2024
5 checks passed
@ZPain8464 ZPain8464 deleted the zpain/fix-duplicate-paths branch January 30, 2024 22:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants