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

Update promotion.rst to explain mode promote #11122

Merged
merged 10 commits into from
Jan 30, 2025

Conversation

chris-armstrong
Copy link
Contributor

Explain the difference between diffing and promotion and the use of (mode promote)

@maiste maiste added the docs Documentation improvements label Nov 14, 2024
@chris-armstrong
Copy link
Contributor Author

I've tried to fix the broken link, but not sure if that'll take

Copy link
Collaborator

@Leonidas-from-XIV Leonidas-from-XIV left a comment

Choose a reason for hiding this comment

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

Thanks for the changes! I've added a few notes on how to improve the wording and accuracy a little bit.

I've also ran CI and you can see that the link does in fact work: https://dune--11122.org.readthedocs.build/en/11122/concepts/promotion.html

doc/concepts/promotion.rst Outdated Show resolved Hide resolved
doc/concepts/promotion.rst Outdated Show resolved Hide resolved
doc/concepts/promotion.rst Outdated Show resolved Hide resolved
doc/concepts/promotion.rst Outdated Show resolved Hide resolved
@chris-armstrong
Copy link
Contributor Author

chris-armstrong commented Nov 19, 2024

Thanks @Leonidas-from-XIV. Please see my changes above, hopefully these adequately address your comments.

Copy link
Collaborator

@Leonidas-from-XIV Leonidas-from-XIV left a comment

Choose a reason for hiding this comment

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

Thanks, I've added a few corrections but it's on the right way.

@christinerose can you please take a look at the text and check?

doc/concepts/promotion.rst Outdated Show resolved Hide resolved
doc/concepts/promotion.rst Outdated Show resolved Hide resolved
@christinerose
Copy link
Collaborator

Thanks, I've added a few corrections but it's on the right way.

@christinerose can you please take a look at the text and check?

I made a few minor grammatical changes and suggested a couple of sentence alteration for readability. See what you think!

@maiste
Copy link
Collaborator

maiste commented Jan 27, 2025

@chris-armstrong I have rebased the PR. Could you address the remaining comments? I think this PR is almost ready to be merged.

@chris-armstrong
Copy link
Contributor Author

Could you please take another look @maiste, hopefully this is ready to go

Copy link
Collaborator

@maiste maiste left a comment

Choose a reason for hiding this comment

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

Thanks for your reactivity! Two small suggestions, but otherwise it looks good to me 👍
@Leonidas-from-XIV could you take another look at it when you have time to?

doc/concepts/promotion.rst Outdated Show resolved Hide resolved
doc/concepts/promotion.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@Leonidas-from-XIV Leonidas-from-XIV left a comment

Choose a reason for hiding this comment

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

Looks good but is failing the DCO check. @chris-armstrong can you sign off your commits?

@chris-armstrong
Copy link
Contributor Author

I don't know how to do what you're asking.

Can we just close this PR - this was meant to be a small improvement to the documentation to make it clearer, but it's been back and forth several times over a few months that it seems hardly worth bothering with now.

@chris-armstrong
Copy link
Contributor Author

I'm happy to waive copyright on the changes in this PR if it makes it easier

@Leonidas-from-XIV
Copy link
Collaborator

When accepting contributions we require the contributors to sign off that they possess the right to contribute the code etc. See more about it here.

This is achieved via the

In your case the easiest way via the Signed-off-by: Your Name <[email protected]> line in the git commit message, like in my commit.

The easiest way to add a signature to existing commits is to

$ git rebase main --signoff
$ git push --force

(This is also what I do when I forget to sign off my commits)

chris-armstrong and others added 9 commits January 30, 2025 08:21
Remove duplication and standardise on "rule targets" and "rule output"

Signed-off-by: Chris Armstrong <[email protected]>
Signed-off-by: Christine Rose <[email protected]>
Signed-off-by: Chris Armstrong <[email protected]>
Signed-off-by: Christine Rose <[email protected]>
Signed-off-by: Chris Armstrong <[email protected]>
Signed-off-by: Christine Rose <[email protected]>
Signed-off-by: Chris Armstrong <[email protected]>
Co-authored-by: Etienne Marais <[email protected]>
Signed-off-by: Chris Armstrong <[email protected]>
Co-authored-by: Etienne Marais <[email protected]>
Signed-off-by: Chris Armstrong <[email protected]>
Signed-off-by: Marek Kubica <[email protected]>
Signed-off-by: Chris Armstrong <[email protected]>
@Leonidas-from-XIV Leonidas-from-XIV merged commit a2e4f4d into ocaml:main Jan 30, 2025
26 of 27 checks passed
@maiste
Copy link
Collaborator

maiste commented Jan 30, 2025

Thanks @chris-armstrong for the contribution! 🙏

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation improvements
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants