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

Backport 1726 to 0 28 0 #1735

Merged
merged 2 commits into from
Jan 20, 2025
Merged

Backport 1726 to 0 28 0 #1735

merged 2 commits into from
Jan 20, 2025

Conversation

desimone
Copy link
Collaborator

@desimone desimone commented Jan 20, 2025

Manual backport of #1726

#1726 (comment)

desimone and others added 2 commits January 20, 2025 14:09
This pull request consolidates a large set of changes to Pomerium’s documentation. It refines organization, updates integrations, removes outdated content, and simplifies navigation.

- **New Integration Guides**
  - Added guides for Apple, Auth0, Azure, Cognito, GitHub, GitLab, Google, OIDC, Okta, OneLogin, Ping, and Keycloak
  - Included images, examples, and troubleshooting steps

- **Documentation Structure Overhaul**
  - Consolidated categories (e.g., "Pomerium Zero," "Pomerium Core," "Community") into a streamlined sidebar
  - Removed outdated guidelines (Code of Conduct, Contributing) and deprecated sections
  - Merged cryptography details into the Security Policy page

- **Deployment and Kubernetes Updates**
  - Introduced new “Deploy” category, consolidating references for Kubernetes, enterprise, and device identity
  - Added quick start references, cluster management guides, and new examples
  - Updated Docker image references to `latest` tag for clarity and consistency

- **Enterprise Guides and Enhanced Features**
  - Created detailed docs for Pomerium Enterprise: installation, configuration, metrics, and clusters
  - Expanded device context, request context, and advanced policy documentation
  - Improved upgrading guides for both Pomerium Core and Enterprise

- **Security & Authentication Improvements**
  - Integrated cryptography docs into a single security-focused resource
  - Removed the standalone “Hosted Authenticate Service” section in favor of a unified authentication guide
  - Clarified JWT usage, identity verification, and zero trust concepts

- **Refinements and Cleanup**
  - Fixed or removed broken links, consolidated multiple references, and standardized paths
  - Upgraded Docusaurus and other dependencies (e.g., mermaid, redocusaurus, cspell, Prettier) for better performance
  - Improved sidebars, table formatting, and visual flow in key docs
  - Updated pre-commit workflows to ensure consistent formatting and spelling checks

These updates greatly improve the clarity, consistency, and user-friendliness of the Pomerium documentation.
@desimone desimone requested a review from a team as a code owner January 20, 2025 22:12
@desimone desimone requested review from nickytonline and removed request for a team January 20, 2025 22:12
Copy link

netlify bot commented Jan 20, 2025

Deploy Preview for pomerium-docs ready!

Name Link
🔨 Latest commit 30b6f02
🔍 Latest deploy log https://app.netlify.com/sites/pomerium-docs/deploys/678eca5e6410af00082d0224
😎 Deploy Preview https://deploy-preview-1735--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.

@desimone desimone enabled auto-merge (squash) January 20, 2025 22:13
Copy link
Member

@nickytonline nickytonline left a comment

Choose a reason for hiding this comment

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

I see the changes were approved in #1726, and this is just fixing the backport that failed. I skimmed through the deploy preview and things seem to look good.

@desimone desimone merged commit 3332a24 into 0-28-0 Jan 20, 2025
8 checks passed
@desimone desimone deleted the backport-1726-to-0-28-0 branch January 20, 2025 22:28
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