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: rename reference docs to "object_action" #4755

Merged
merged 4 commits into from
Jan 16, 2024

Conversation

dvdksn
Copy link
Contributor

@dvdksn dvdksn commented Jan 5, 2024

- 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)

@codecov-commenter
Copy link

codecov-commenter commented Jan 5, 2024

Codecov Report

Merging #4755 (b35361e) into master (077d07c) will increase coverage by 59.20%.
Report is 4 commits behind head on master.
The diff coverage is n/a.

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     

@dvdksn dvdksn force-pushed the cli-reference-canonical branch 2 times, most recently from 93ffc3c to d712a56 Compare January 5, 2024 16:42
@dvdksn dvdksn force-pushed the cli-reference-canonical branch from d712a56 to 72fb949 Compare January 11, 2024 11:04
@dvdksn dvdksn marked this pull request as ready for review January 12, 2024 10:41
@dvdksn dvdksn requested a review from thaJeztah as a code owner January 12, 2024 10:41
@dvdksn dvdksn changed the title [WIP] rename reference docs to "object_action" docs: rename reference docs to "object_action" Jan 12, 2024
Copy link
Member

@thaJeztah thaJeztah left a 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)

@dvdksn dvdksn force-pushed the cli-reference-canonical branch from 72fb949 to a6774de Compare January 15, 2024 11:12
@dvdksn
Copy link
Contributor Author

dvdksn commented Jan 15, 2024

hi @thaJeztah I changed the approach here and it should preserve history better now:

  1. In the first commit I deleted the stub files which didn't have any content.
  2. In the second commit I git mv the "golden" files and renamed them to use the canonical name.

If you check the diff for the 2nd commit it looks OK a6774de

@thaJeztah
Copy link
Member

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)

@dvdksn
Copy link
Contributor Author

dvdksn commented Jan 15, 2024

Hmm, yeah we don't need them at all in the docs, but regenerating mddocs would recreate those stubs, so let me commit the "empty" generated stubs just so they're there and we don't cause any trouble for someone the next time they want to regenerate markdown.

@dvdksn dvdksn requested a review from thaJeztah January 15, 2024 12:51
Copy link
Member

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

@dvdksn
Copy link
Contributor Author

dvdksn commented Jan 15, 2024

snuck in an extra commit fixing a link to an anchor that doesn't exist and isn't needed 🙈

Copy link
Contributor

@sam-thibault sam-thibault left a comment

Choose a reason for hiding this comment

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

lgtm

@thaJeztah
Copy link
Member

Thanks! Let's bring this one in 👍

@thaJeztah thaJeztah merged commit a18dad3 into docker:master Jan 16, 2024
77 checks passed
@thaJeztah
Copy link
Member

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

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.

4 participants