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.

Sign up for GitHub

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

Jump to bottom

Improve the Quick Start page #891

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

Improve the Quick Start page #891

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

Comments

@flyrain
Copy link
Contributor

flyrain commented Jan 27, 2025 •
edited
Loading

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 !

@flyrain flyrain mentioned this issue Feb 8, 2025
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@frHimanshu frHimanshu

Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
1.0.0
Development

No branches or pull requests
3 participants
@adutra @flyrain @frHimanshu