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

Move command reference to a separate doc #1880

Merged
merged 1 commit into from
Jan 19, 2023

Conversation

djdongjin
Copy link
Member

@djdongjin djdongjin commented Jan 19, 2023

Fix #1865

Move command reference to a separate doc and refer it in README.

Also fix README lint warnings. (no format change).

If this is accepted, we probably can add a link in the About section referring the command reference :)

Feel free to preview the change in my branch :) https://github.com/djdongjin/nerdctl/tree/replace-command-doc

Signed-off-by: Jin Dong jindon@amazon.com

@djdongjin djdongjin changed the title Replace command doc Move command reference to a separate doc Jan 19, 2023
@djdongjin djdongjin marked this pull request as ready for review January 19, 2023 03:51
@@ -232,1497 +259,22 @@ Lots of commands and flags are currently missing. Pull requests are highly welco

Please certify your [Developer Certificate of Origin (DCO)](https://developercertificate.org/), by signing off your commit with `git commit -s` and with your real name.

- - -

# Command reference
Copy link
Member

Choose a reason for hiding this comment

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

Please retain this section

- - -
 
# Command reference

Moved to [`./docs/command-reference.md`](./docs/command-reference.md).

Copy link
Member Author

Choose a reason for hiding this comment

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

Done

Fix README lint warnings

Signed-off-by: Jin Dong <jindon@amazon.com>
Copy link
Member

@AkihiroSuda AkihiroSuda left a comment

Choose a reason for hiding this comment

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

Thanks

@AkihiroSuda AkihiroSuda added this to the v1.2.0 milestone Jan 19, 2023
@AkihiroSuda AkihiroSuda added the documentation Improvements or additions to documentation label Jan 19, 2023
@AkihiroSuda AkihiroSuda merged commit 8c9b252 into containerd:main Jan 19, 2023
@djdongjin djdongjin deleted the replace-command-doc branch January 19, 2023 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Should we move the Command Reference to a separate doc
2 participants