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

docs: Update README.md #1535

Merged
merged 1 commit into from
May 29, 2024
Merged

docs: Update README.md #1535

merged 1 commit into from
May 29, 2024

Conversation

tisonkun
Copy link
Member

@tisonkun tisonkun commented May 24, 2024

@github-actions github-actions bot added the docs Improvements or additions to documentation label May 24, 2024
> 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

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

@sebbASF
Copy link

sebbASF commented May 24, 2024

The proposed wording seems good, but I think the final wording should be agreed by the Incubator PMC.

@justinmclean
Copy link
Member

I'd rather we were not too prescriptive on the exact wording as was mentioned in the discussion on the Incubator general list.

@tisonkun
Copy link
Member Author

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.

@tisonkun tisonkun marked this pull request as ready for review May 25, 2024 01:08
@tisonkun tisonkun requested a review from sebbASF May 25, 2024 01:08
Copy link

@sebbASF sebbASF left a 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

@dave2wave
Copy link
Member

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,
Dave

Copy link
Contributor

@jiacai2050 jiacai2050 left a 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.

@jiacai2050 jiacai2050 merged commit 0970b03 into main May 29, 2024
5 checks passed
@tisonkun tisonkun deleted the tisonkun-patch-1 branch May 29, 2024 02:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants