-
Notifications
You must be signed in to change notification settings - Fork 2.1k
docs: rename reference docs to "object_action" #4755
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
Conversation
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #4755 +/- ##
===========================================
+ Coverage 0 59.20% +59.20%
===========================================
Files 0 286 +286
Lines 0 24778 +24778
===========================================
+ Hits 0 14669 +14669
- Misses 0 9221 +9221
- Partials 0 888 +888 |
93ffc3c to
d712a56
Compare
d712a56 to
72fb949
Compare
thaJeztah
left a comment
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'll give it a try if we can make the changes show up as "move" in stead of "delete -> new file", so that (with a bit of luck) we can better preserve history.
So don't merge yet (but thanks so much for working on this!! changes look good)
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
72fb949 to
a6774de
Compare
|
hi @thaJeztah I changed the approach here and it should preserve history better now:
If you check the diff for the 2nd commit it looks OK a6774de |
|
Ah, nice! Yes this looks good! Do we need a third commit to add stubs for the non-canonical commands? (which I think can be generated?) or can we do without? (from the "docs" side, I don't think we currently use those) |
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
|
Hmm, yeah we don't need them at all in the docs, but regenerating |
thaJeztah
left a comment
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.
LGTM
@crazy-max PTAL
Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com>
|
snuck in an extra commit fixing a link to an anchor that doesn't exist and isn't needed 🙈 |
sam-thibault
left a comment
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.
lgtm
|
Thanks! Let's bring this one in 👍 |
|
We may have to check if there's old docs PRs that now fail, and need a carry (or "close"). If you have some time (not urgent) to check, that'd be great, @dvdksn |
- What I did
Making sure there's only 1 canonical markdown file for each command. In the documentation repository, I'll add redirects for each command, and update titles to mention both variants.
e.g., redirect docker build to docker image build
- How I did it
- How to verify it
- Description for the changelog
- A picture of a cute animal (not mandatory but encouraged)