-
Notifications
You must be signed in to change notification settings - Fork 206
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
docs: Update README.md #1535
docs: Update README.md #1535
Conversation
> 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). |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
The proposed wording seems good, but I think the final wording should be agreed by the Incubator PMC. |
I'd rather we were not too prescriptive on the exact wording as was mentioned in the discussion on the Incubator general list. |
Thanks for sharing your ideas @sebbASF @justinmclean. Then I propose we move forward with this wording and apply to other HoraeDB repos, and finally finish INFRA-25790. You may take a look at other horaedb repos if they're suitable to follow this pattern. Perhaps some satellite repos can have different situation and have a better solution. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks OK to me
Looks reasonable and points to the important detail. I would only add that if the podling is releasing with DISCLAIMER-WIP that the linked DISCLAIMER should be the DISCLAIMER-WIP with that added information. Best, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks everyone involved, let's move forward.
Draft.
Rendered version: https://github.com/apache/incubator-horaedb/tree/tisonkun-patch-1