Skip to content

doc/rbd: refine rbd-snapshot.rst#49394

Merged
zdover23 merged 1 commit intoceph:mainfrom
zdover23:wip-doc-2022-12-10-rbd-rbd-snapshot-edit
Dec 16, 2022
Merged

doc/rbd: refine rbd-snapshot.rst#49394
zdover23 merged 1 commit intoceph:mainfrom
zdover23:wip-doc-2022-12-10-rbd-rbd-snapshot-edit

Conversation

@zdover23
Copy link
Contributor

@zdover23 zdover23 commented Dec 13, 2022

Refine the text in rbd-snapshot.rst

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover zac.dover@gmail.com

Contribution Guidelines

Checklist

  • Tracker (select at least one)
    • References tracker ticket
    • Very recent bug; references commit where it was introduced
    • New feature (ticket optional)
    • Doc update (no ticket needed)
    • Code cleanup (no ticket needed)
  • Component impact
    • Affects Dashboard, opened tracker ticket
    • Affects Orchestrator, opened tracker ticket
    • No impact that needs to be tracked
  • Documentation (select at least one)
    • Updates relevant documentation
    • No doc update is appropriate
  • Tests (select at least one)
Show available Jenkins commands
  • jenkins retest this please
  • jenkins test classic perf
  • jenkins test crimson perf
  • jenkins test signed
  • jenkins test make check
  • jenkins test make check arm64
  • jenkins test submodules
  • jenkins test dashboard
  • jenkins test dashboard cephadm
  • jenkins test api
  • jenkins test docs
  • jenkins render docs
  • jenkins test ceph-volume all
  • jenkins test ceph-volume tox
  • jenkins test windows

@zdover23 zdover23 requested a review from idryomov December 13, 2022 03:19
@zdover23 zdover23 requested a review from a team as a code owner December 13, 2022 03:19
@zdover23 zdover23 requested a review from idryomov December 13, 2022 17:49
@zdover23 zdover23 force-pushed the wip-doc-2022-12-10-rbd-rbd-snapshot-edit branch from bf6e15f to 3446e4b Compare December 13, 2022 18:56
@zdover23
Copy link
Contributor Author

@idryomov It's ready for your review, Ilya. Thanks for all your time and expertise today.

@zdover23
Copy link
Contributor Author

jenkins test api

@zdover23 zdover23 requested a review from idryomov December 14, 2022 15:25
@zdover23 zdover23 force-pushed the wip-doc-2022-12-10-rbd-rbd-snapshot-edit branch from 3446e4b to 4e43edd Compare December 14, 2022 15:27
@zdover23
Copy link
Contributor Author

zdover23 commented Dec 14, 2022

@idryomov: I've made all of your suggested changes, and they're squashed into this commit now. I resolved all of the issues that were unambiguous and required no further consultation with you, but I've left a single issue open because I wasn't entirely sure that I had captured what you mean to say. Let me know what you think.

@zdover23 zdover23 force-pushed the wip-doc-2022-12-10-rbd-rbd-snapshot-edit branch from 4e43edd to be5f167 Compare December 14, 2022 21:16
@idryomov
Copy link
Contributor

It looks like the last push ended up undoing (some of?) previous changes: --keyring still has =, etc in the current version.

@zdover23 zdover23 force-pushed the wip-doc-2022-12-10-rbd-rbd-snapshot-edit branch from be5f167 to 63852da Compare December 15, 2022 04:13
@zdover23
Copy link
Contributor Author

zdover23 commented Dec 15, 2022

@idryomov

It looks like the last push ended up undoing (some of?) previous changes: --keyring still has =, etc in the current version.

That's weird. Either I somehow missed this or a local working copy on one machine overwrote the changes I had pushed from the local working copy on the machine I use to attend CLT meetings. Anyway, it's fixed now. Good looking out, Ilya.

@idryomov
Copy link
Contributor

That's weird. Either I somehow missed this or a local working copy on one machine overwrote the changes I had pushed from the local working copy on the machine I use to attend CLT meetings. Anyway, it's fixed now. Good looking out, Ilya.

Everything but the = thing is still outstanding. I went ahead an unresolved the conversations that had been marked as resolved earlier (at least those that I could find), please go through them again, one by one.

A suggestion: I noticed that when you push an update, you always rebase as well, picking up unrelated changes. This makes it harder to review, both for you (am I force-pushing the right thing?) and for the reviewer (straight diff between between the old version and the new version doesn't cut it). I didn't mention this before to avoid overwhelming you with git-foo, but now that you got bitten: since force-pushing destroys history, default to keeping the base the same. Change the base only when it's actually needed, e.g. to pick up a dependency or resolve a conflict, and document that reason in the comment. Figuring out what went wrong and, more importantly, preventing such mishaps from happening in the first place becomes much easier then.

zdover23 pushed a commit to zdover23/ceph that referenced this pull request Dec 15, 2022
Incorporate Ilya's suggestions from
ceph#49394 (comment) and
follow his suggestions regarding avoiding squashing fixups.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
@zdover23
Copy link
Contributor Author

zdover23 commented Dec 15, 2022

@idryomov:

That's weird. Either I somehow missed this or a local working copy on one machine overwrote the changes I had pushed from the local working copy on the machine I use to attend CLT meetings. Anyway, it's fixed now. Good looking out, Ilya.

Everything but the = thing is still outstanding. I went ahead an unresolved the conversations that had been marked as resolved earlier (at least those that I could find), please go through them again, one by one.

I have now whack-a-moled them and now I ping-pong this PR back to you.

A suggestion: I noticed that when you push an update, you always rebase as well, picking up unrelated changes. This makes it harder to review, both for you (am I force-pushing the right thing?) and for the reviewer (straight diff between between the old version and the new version doesn't cut it). I didn't mention this before to avoid overwhelming you with git-foo, but now that you got bitten: since force-pushing destroys history, default to keeping the base the same. Change the base only when it's actually needed, e.g. to pick up a dependency or resolve a conflict, and document that reason in the comment. Figuring out what went wrong and, more importantly, preventing such mishaps from happening in the first place becomes much easier then.

The docs workflow that we had settled on up to the time that we started refining the RBD-related English was developed to deal with those single-section revisions that ended up spamming everyone's inboxes. And when we were working with such small sections, a fixup-and-squash protocol for dealing with changes of the kind that we're dealing with in this PR never got confusing, because the texts we worked with were so brief that the lineage of the changes we made to them was orthogonal to our concerns. This is a long-winded and prolix way of saying: I see your point, and I think I've done something more accommodating now. I've just pushed a new commit without squashing it into the old commit. If this review passes muster, I'll squash these commits (after we get the approval of the RBD team) into a single commit and make a note to myself that this will be the new procedure for making these whole-rst-file-long documentation revisions.

I appreciate your patience in what must be a trying process.

@zdover23
Copy link
Contributor Author

@idryomov: Back at you.

Refine the text in rbd-snapshot.rst

https://tracker.ceph.com/issues/57001

Signed-off-by: Zac Dover <zac.dover@gmail.com>
@zdover23 zdover23 force-pushed the wip-doc-2022-12-10-rbd-rbd-snapshot-edit branch from 4c0dfff to 292c826 Compare December 16, 2022 14:28
@zdover23 zdover23 merged commit e2d33dd into ceph:main Dec 16, 2022
@zdover23
Copy link
Contributor Author

#49484 - Quincy backport
#49485 - Pacific backport

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants