-
Notifications
You must be signed in to change notification settings - Fork 949
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: auto generate pouch cli/api/contributors docs via code #2887
Merged
ZYecho
merged 1 commit into
AliyunContainerService:master
from
pouchrobot:auto-doc-2019-06-02
Jun 4, 2019
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
## pouch search | ||
|
||
Search the images from specific registry | ||
|
||
### Synopsis | ||
|
||
|
||
Search the images from specific registry. | ||
|
||
``` | ||
pouch search [OPTIONS] TERM | ||
``` | ||
|
||
### Examples | ||
|
||
``` | ||
$ pouch search nginx | ||
NAME DESCRIPTION STARS OFFICIAL AUTOMATED | ||
nginx Official build of Nginx. 11403 [OK] | ||
jwilder/nginx-proxy Automated Nginx reverse proxy for docker con… 1600 [OK] | ||
richarvey/nginx-php-fpm Container running Nginx + PHP-FPM capable of… 712 [OK] | ||
jrcs/letsencrypt-nginx-proxy-companion LetsEncrypt container to use with nginx as p… 509 [OK] | ||
webdevops/php-nginx Nginx with PHP-FPM 127 [OK] | ||
zabbix/zabbix-web-nginx-mysql Zabbix frontend based on Nginx web-server wi… 101 [OK] | ||
bitnami/nginx Bitnami nginx Docker Image 66 [OK] | ||
linuxserver/nginx An Nginx container, brought to you by LinuxS… 61 | ||
1and1internet/ubuntu-16-nginx-php-phpmyadmin-mysql-5 ubuntu-16-nginx-php-phpmyadmin-mysql-5 50 [OK] | ||
zabbix/zabbix-web-nginx-pgsql Zabbix frontend based on Nginx with PostgreS… 33 [OK] | ||
tobi312/rpi-nginx NGINX on Raspberry Pi / ARM 26 [OK] | ||
nginx/nginx-ingress NGINX Ingress Controller for Kubernetes 20 | ||
schmunk42/nginx-redirect A very simple container to redirect HTTP tra… 15 [OK] | ||
nginxdemos/hello NGINX webserver that serves a simple page co… 14 [OK] | ||
blacklabelops/nginx Dockerized Nginx Reverse Proxy Server. 12 [OK] | ||
wodby/drupal-nginx Nginx for Drupal container image 12 [OK] | ||
centos/nginx-18-centos7 Platform for running nginx 1.8 or building n… 10 | ||
centos/nginx-112-centos7 Platform for running nginx 1.12 or building … 9 | ||
nginxinc/nginx-unprivileged Unprivileged NGINX Dockerfiles 4 | ||
1science/nginx Nginx Docker images that include Consul Temp… 4 [OK] | ||
nginx/nginx-prometheus-exporter NGINX Prometheus Exporter 4 | ||
mailu/nginx Mailu nginx frontend 3 [OK] | ||
toccoag/openshift-nginx Nginx reverse proxy for Nice running on same… 1 [OK] | ||
ansibleplaybookbundle/nginx-apb An APB to deploy NGINX 0 [OK] | ||
wodby/nginx Generic nginx 0 [OK] | ||
|
||
``` | ||
|
||
### Options | ||
|
||
``` | ||
-h, --help help for search | ||
-r, --registry string set registry name | ||
``` | ||
|
||
### Options inherited from parent commands | ||
|
||
``` | ||
-D, --debug Switch client log level to DEBUG mode | ||
-H, --host string Specify connecting address of Pouch CLI (default "unix:///var/run/pouchd.sock") | ||
--tlscacert string Specify CA file of TLS | ||
--tlscert string Specify cert file of TLS | ||
--tlskey string Specify key file of TLS | ||
--tlsverify Use TLS and verify remote | ||
``` | ||
|
||
### SEE ALSO | ||
|
||
* [pouch](pouch.md) - An efficient container engine | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
why indent not right here?
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 have no idea. I think we can ignore this. WDYT? @ZYecho