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

[DOC-9615] Update docs for certificate auth #18987

Merged
merged 9 commits into from
Oct 15, 2024
Merged

[DOC-9615] Update docs for certificate auth #18987

merged 9 commits into from
Oct 15, 2024

Conversation

mdlinville
Copy link
Contributor

@mdlinville mdlinville commented Oct 3, 2024

[DOC-9615] Update docs for certificate auth

  • Remove duplicate certificate line
  • Improve "Supported authentication methods" heading
  • HBA configuration syntax section
    • Fix heading level of section
    • Define what HBA stands for
    • Improve the explanations of the example rules to be a bit less informal
  • Update the table source
    • Use variables for headings
    • Use reference-style links for in-table links to reduce the column widths
    • Remove redundant "support" from column headings
    • Improve the ordering of the rows

Backported through v23.1

Tests:

  • Local build
  • Local linkcheck

Previews:
src/current/v23.1/security-reference/authentication.md
src/current/v23.2/security-reference/authentication.md
src/current/v24.1/security-reference/authentication.md
src/current/v24.2/security-reference/authentication.md
src/current/v24.3/security-reference/authentication.md

Copy link

netlify bot commented Oct 3, 2024

Deploy Preview for cockroachdb-interactivetutorials-docs canceled.

Name Link
🔨 Latest commit 09afaee
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-interactivetutorials-docs/deploys/670ef32050381100081b821d

Copy link

netlify bot commented Oct 3, 2024

Deploy Preview for cockroachdb-api-docs canceled.

Name Link
🔨 Latest commit 09afaee
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-api-docs/deploys/670ef320f041720008120342

Copy link

netlify bot commented Oct 3, 2024

Netlify Preview

Name Link
🔨 Latest commit 09afaee
🔍 Latest deploy log https://app.netlify.com/sites/cockroachdb-docs/deploys/670ef32050381100081b8219
😎 Deploy Preview https://deploy-preview-18987--cockroachdb-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.

@mdlinville
Copy link
Contributor Author

I'll go ahead and merge this low-risk high-reward change. For v24.3 GA we will need to add LDAP as a supported auth method, but that is tracked via a product change issue.

Copy link
Contributor

@mikeCRL mikeCRL left a comment

Choose a reason for hiding this comment

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

Approving, but one tiny fix needed across all versions

src/current/v23.1/security-reference/authentication.md Outdated Show resolved Hide resolved
src/current/v23.2/security-reference/authentication.md Outdated Show resolved Hide resolved
src/current/v24.1/security-reference/authentication.md Outdated Show resolved Hide resolved
src/current/v24.2/security-reference/authentication.md Outdated Show resolved Hide resolved
src/current/v24.3/security-reference/authentication.md Outdated Show resolved Hide resolved
@mdlinville mdlinville merged commit 4ca7191 into main Oct 15, 2024
6 checks passed
@mdlinville mdlinville deleted the DOC-9615 branch October 15, 2024 23:03
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