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

Improve the Quick Start page #891

Open
flyrain opened this issue Jan 27, 2025 · 6 comments
Open

Improve the Quick Start page #891

flyrain opened this issue Jan 27, 2025 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Milestone

Comments

@flyrain
Copy link
Contributor

flyrain commented Jan 27, 2025

Describe the solution you'd like

After #859, It makes more sense to deprecate the existing Quick Start page, by replacing it with the docs in directory ./getting-started.

cc @adutra @HonahX

@flyrain flyrain added the enhancement New feature or request label Jan 27, 2025
@flyrain flyrain added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 27, 2025
@flyrain flyrain added this to the 1.0.0 milestone Jan 27, 2025
@adutra
Copy link
Contributor

adutra commented Jan 28, 2025

Question: the Quick Start page is published under https://polaris.apache.org/in-dev/unreleased/quickstart/ – but the docs in directory getting-started aren't. How are users browsing https://polaris.apache.org going to find the getting-started examples if we delete the Quick Start page?

@flyrain
Copy link
Contributor Author

flyrain commented Jan 28, 2025

I think we could use symlink like what we did for chat-bylaws.md under the directory content.

@frHimanshu
Copy link

Hello, I'm new to open source community, can I take this issue?

@flyrain
Copy link
Contributor Author

flyrain commented Jan 31, 2025

Sure. Thanks @frHimanshu !

@raushanprabhakar1
Copy link

Hi @flyrain , I was doing poc for using polaris catalog for creating iceberg table in azure data lake service, as I was doing that, i didn't find the enough documentation related to adls, it was mostly for s3, so it took me lot of time, in order to use the polaris catalog, should I create a documentation, so others can refer that?

@flyrain
Copy link
Contributor Author

flyrain commented Feb 21, 2025

Hi @raushanprabhakar1, definitely! Feel free to file an issue or PR for that! This is our current doc site, https://polaris.apache.org/in-dev/unreleased/. I'm OK with put this in one of existing pages, or creating a new page for storage related things.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

4 participants