docs: improve getting started and README documentation #2267
Conversation
There was a problem hiding this comment.
Hi @Subham-KRLX, thanks a lot for picking this up. Can we add the binary distribution instruction in this page, https://polaris.apache.org/in-dev/unreleased/getting-started/quickstart/? And we don't need the change in README.md in that case.
|
Give me some time; I will fix everything that is necessary. |
|
@flyrain, Could you please specify where exactly to add the binary distribution instructions in the Quickstart page? Should it be a separate section after “Running Polaris as a Standalone Process” including all steps like prerequisites ,download, configuration, start, verify, and stop? Also what title do you prefer for the section? I want to ensure the update aligns perfectly with your expectations before proceeding. |
|
Looking a bit more, I think it makes more sense to have it in this page, https://github.com/apache/polaris/blob/af69d9f9699d8a0cae1b70839e1b5c1bfc9ba511/site/content/in-dev/unreleased/getting-started/_index.md. So that every time, people click "Getting Started", the index page shows up and provide instructions for binary package usage, which probably the fastest way to set up a Polaris server. One more thing we could add into the index page is the link to this page, https://polaris.apache.org/in-dev/unreleased/getting-started/quickstart/, which shows how to start from the source code. And we can change the link in this line Line 43 in 04e65af |
…kstart link, update quickstart.md and remove redundant binary doc
removing blank spaces.
github-project-automation
bot
moved this from PRs In Progress
to Ready to merge
in Basic Kanban Board
updating the link.
removing the bash commands which are not in use.
|
I think it's good to go now. |
| --- | ||
|
|
||
| ## Step 2: Extract the Archive | ||
|
|
||
| Extract the downloaded tar.gz file to your desired directory: |
There was a problem hiding this comment.
We actually combine two steps as a single command handles both download and exacting. Let's remove this step. The cd part can go to next step.
There was a problem hiding this comment.
I think we still need to resolve this comment, as we have combined step1 and step 2.
|
The Quarkus tests in polaris-runtime-service are failing with Agroal dependency is present but no JDBC datasources have been defined. Could you clarify if this modules tests require an actual JDBC configuration or if Agroal shouldn’t be loaded at all in this context? Also should we configure an in-memory datasource for CI runs? |
|
@flyrain,My local build fails in the polaris-admin test phase with the message: “The Agroal dependency is present but no JDBC datasources have been defined.” Since my PR only updates documentation this seems unrelated to my changes. Is this a test environment issue or do I need to configure a test datasource? Please advise. |
github-project-automation
bot
moved this from Ready to merge
to Done
in Basic Kanban Board
github-project-automation
bot
moved this from Done
to PRs In Progress
in Basic Kanban Board
Reopen it to trigger the CI |
| @@ -23,3 +23,101 @@ weight: 101 | |||
| build: | |||
| render: never | |||
| --- | |||
|
|
|||
| # Getting Started with Apache Polaris Binary Distribution | |||
There was a problem hiding this comment.
Is _index.md the right place for adding content? There is apparently an existing pattern for adding .md files per sub-section under the getting-started directory.
Also, note the render: never setting above... Is that a concern?
There was a problem hiding this comment.
So should i change this or what All tests are green should I proceed with this change ?
|
If this PR is fixed please feel free to merge it. If not kindly provide the corrections I need to make so I can start working on the issue assigned to me and raise a PR regarding that issue. |
This PR improves the Apache Polaris documentation by enhancing the "Getting Started with Binary Distribution" guide and updating the related README file.
These updates include formatting fixes, compliance with Markdown linting standards, added code block language specifiers, and clearer, more concise instructions to improve readability and user experience.
Key changes:
Fixed markdownlint issues such as line length violations and missing code block languages.
Shortened and clarified descriptive text for better comprehension.
Removed duplicate and redundant sections.
Verified proper formatting and rendering via a local Hugo site build.
Closes #1590