Skip to content

Mirroring ps docs to container ls - #2764

Open
sudo-bmitch wants to merge 1 commit into
docker:masterfrom
sudo-bmitch:pr-container-ls
Open

Mirroring ps docs to container ls#2764
sudo-bmitch wants to merge 1 commit into
docker:masterfrom
sudo-bmitch:pr-container-ls

Conversation

@sudo-bmitch

Copy link
Copy Markdown
Contributor

Signed-off-by: Brandon Mitchell git@bmitch.net

- What I did

Added docs for docker container ls. This makes https://docs.docker.com/engine/reference/commandline/container_ls/ look like https://docs.docker.com/engine/reference/commandline/ps/ (including the various filter and format options).

- How I did it

Copied from docker ps docs, find and replace, and rewrapped some long lines. Ideally one command would redirect to the other.

- How to verify it

- Description for the changelog

- A picture of a cute animal (not mandatory but encouraged)

Signed-off-by: Brandon Mitchell <git@bmitch.net>
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

Merging #2764 into master will not change coverage.
The diff coverage is n/a.

@@ Coverage Diff @@## master #2764 +/- ##
=======================================
Coverage 57.15% 57.15% =======================================
Files 297 297 Lines 18656 18656 =======================================
Hits 10662 10662 Misses 7132 7132 Partials 862 862 

@thaJeztah

Copy link
Copy Markdown
Member

Thanks! Yes, this is somewhat of a known issue (because there's the "old/existing" top-level commands, and their equivalent <object> <verb> variants).

I actually have two PR's to address this issue by moving the content to a "canonical" page, and redirect the other pages; that way we wouldn't duplicate the content, and make sure that they don't get out of sync. At the same time, both variants can be found in the docs (in the navigation).

PR in this repository #2389, and the associated PR in the documentation repository; docker/docs#10471

I just rebased those PR's, and you can view a preview here; https://5f751c43e0e04b000704afe5--docsdocker.netlify.app

e.g.; https://5f751c43e0e04b000704afe5--docsdocker.netlify.app/engine/reference/commandline/ps/ redirects to https://5f751c43e0e04b000704afe5--docsdocker.netlify.app/engine/reference/commandline/container_ps/

@sudo-bmitch

Copy link
Copy Markdown
ContributorAuthor

Getting this to a single file is definitely ideal. Should I go ahead and close this out, or since the reorg is still a WIP did you want to temporarily add to the clutter with this? I'll drop a comment on issues I'm seeing in the other PR.

Sign up for freeto 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

@sudo-bmitch@codecov-commenter@thaJeztah@hc0503