binarycat0 opened a new pull request, #2611: URL: https://github.com/apache/polaris/pull/2611
- add docs/getting-started/deploying-polaris section - move docs/quickstart.md -> docs/getting-started/deploying-polaris/local-deploy.md - move docs/getting-started/deploying-polaris -> docs/getting-started/deploying-polaris/on-cloud - add docs/getting-started/alternate-conf/keycloak-idp.md as _Keycloak IDP example_ - add ref to docs/getting-started/alternate-conf/keycloak-idp.md to docs/external-idp.md - fix AWS typo in quickstart-deploy-azure.md, quickstart-deploy-gcp.md ---- ## Motivation: The current structure of the getting-started section is somewhat inconvenient due to inconsistent menu ordering and section naming. For example, `Quickstart` doesn't reflect its actual content - it's essentially a Local Deployment guide. Additionally, right after the `Quickstart` section, we have examples of `Deploying Polaris On Cloud Providers`, followed immediately by a `Polaris + MinIO` usage example. Meanwhile, the important Using Polaris section is placed at the very end. ## Goal: In this PR, I propose a minor reorganization of the `Getting Started` section that will enable new users and contributors to learn the project documentation in a more natural and intuitive way. ## Old documentation view: <img width="1750" height="1041" alt="Screenshot 2025-09-18 at 17 28 31" src="https://github.com/user-attachments/assets/412dd6de-b2bc-497e-bc2d-4cbe44a968ac"; /> ## New documentation view: <img width="1750" height="1041" alt="Screenshot 2025-09-18 at 17 26 26" src="https://github.com/user-attachments/assets/bdb173c9-ba79-4af8-8155-e295d058c979"; /> <!-- Possible security vulnerabilities: STOP here and contact [email protected] instead! Please update the title of the PR with a meaningful message - do not leave it "empty" or "generated" Please update this summary field: The summary should cover these topics, if applicable: * the motivation for the change * a description of the status quo, for example the current behavior * the desired behavior * etc PR checklist: - Do a self-review of your code before opening a pull request - Make sure that there's good test coverage for the changes included in this PR - Run tests locally before pushing a PR (./gradlew check) - Code should have comments where applicable. Particularly hard-to-understand areas deserve good in-line documentation. - Include changes and enhancements to the documentation (in site/content/in-dev/unreleased) - For Work In Progress Pull Requests, please use the Draft PR feature. Make sure to add the information BELOW this comment. Everything in this comment will NOT be added to the PR description. --> -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
