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

docs: Update README.md #1535

Merged
merged 1 commit into from
May 29, 2024
Merged

docs: Update README.md #1535

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@

Apache HoraeDB (incubating) is a high-performance, distributed, cloud native time-series database.

> [!IMPORTANT]
> Apache HoraeDB (incubating) is an effort undergoing incubation at the Apache
> Software Foundation (ASF), sponsored by the Apache Incubator PMC.
>
> Please read the [DISCLAIMER](DISCLAIMER) and a full explanation of ["incubating"](https://incubator.apache.org/policy/incubation.html).
Copy link
Member Author

Choose a reason for hiding this comment

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

I can instead use the exact content of the DISCLAIMER. But since we're seeking for a shorter description, here is a proposal that I suppose is clear and concise.

cc @justinmclean @sebbASF

Copy link

Choose a reason for hiding this comment

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

I prefer the linked version, but either would do.

Copy link
Member Author

Choose a reason for hiding this comment

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

the linked version

I don't know what this is. Would you send a suggestion or patch to show it?

but either would do

So the version proposed here is OK to you?

Copy link

Choose a reason for hiding this comment

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

I meant the proposal to add a link to README.md instead of inlining the disclaimer text.

Copy link
Member Author

@tisonkun tisonkun May 24, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

@sebbASF Thanks for sharing your opinion. Could you provide a sentence that I can use here?

I'd prefer to try the "link to README.md" way but I may not make a precise sentence :P


## Documentation

- [User Guide](https://horaedb.apache.org)
Expand Down
Loading