branch: externals/kubed
commit 716e60d708b1b90fc8d69e0a4d1d1bc209a893bb
Author: Eshel Yaron <m...@eshelyaron.com>
Commit: Eshel Yaron <m...@eshelyaron.com>
; Bundle image files for inclusion in the manual
* kubed.texi: adjust image references to cooperate with HTML
manual generation on the ELPA server (see Emacs bug#73425.)
---
.elpaignore | 4 +-
assets/kubed-deployment-prefix-map.png | Bin 0 -> 48596 bytes
assets/kubed-list-transient.png | Bin 0 -> 345457 bytes
assets/kubed-overview.png | Bin 0 -> 538400 bytes
assets/kubed-prefix-map.png | Bin 0 -> 98545 bytes
assets/kubed-replace-diff.png | Bin 0 -> 398867 bytes
assets/kubed-scale-deployments.png | Bin 0 -> 156187 bytes
assets/kubed-transient-exec.png | Bin 0 -> 64597 bytes
assets/kubed-transient.png | Bin 0 -> 45937 bytes
kubed.texi | 68 +++++++++++++++++++++++----------
10 files changed, 51 insertions(+), 21 deletions(-)
diff --git a/.elpaignore b/.elpaignore
index 206be02724..afa5a63edc 100644
--- a/.elpaignore
+++ b/.elpaignore
@@ -1,3 +1,5 @@
.dir-locals.el
README.md
-*.png
+kubed.png
+explain-and-patch.png
+pod-context-menu.png
diff --git a/assets/kubed-deployment-prefix-map.png
b/assets/kubed-deployment-prefix-map.png
new file mode 100644
index 0000000000..19551b123b
Binary files /dev/null and b/assets/kubed-deployment-prefix-map.png differ
diff --git a/assets/kubed-list-transient.png b/assets/kubed-list-transient.png
new file mode 100644
index 0000000000..c0fdb28191
Binary files /dev/null and b/assets/kubed-list-transient.png differ
diff --git a/assets/kubed-overview.png b/assets/kubed-overview.png
new file mode 100644
index 0000000000..b74db91258
Binary files /dev/null and b/assets/kubed-overview.png differ
diff --git a/assets/kubed-prefix-map.png b/assets/kubed-prefix-map.png
new file mode 100644
index 0000000000..0f0d6090f9
Binary files /dev/null and b/assets/kubed-prefix-map.png differ
diff --git a/assets/kubed-replace-diff.png b/assets/kubed-replace-diff.png
new file mode 100644
index 0000000000..6e6d07a1d3
Binary files /dev/null and b/assets/kubed-replace-diff.png differ
diff --git a/assets/kubed-scale-deployments.png
b/assets/kubed-scale-deployments.png
new file mode 100644
index 0000000000..3f51ecd3d3
Binary files /dev/null and b/assets/kubed-scale-deployments.png differ
diff --git a/assets/kubed-transient-exec.png b/assets/kubed-transient-exec.png
new file mode 100644
index 0000000000..5f412e8e80
Binary files /dev/null and b/assets/kubed-transient-exec.png differ
diff --git a/assets/kubed-transient.png b/assets/kubed-transient.png
new file mode 100644
index 0000000000..97fa375f4f
Binary files /dev/null and b/assets/kubed-transient.png differ
diff --git a/kubed.texi b/kubed.texi
index ae5ab9ada0..1526e1066e 100644
--- a/kubed.texi
+++ b/kubed.texi
@@ -63,12 +63,15 @@ with your Kubernetes clusters and deployments with the full
power of
@command{kubectl}, and with the comfort and confidence of an intuitive
interactive interface.
-@ifhtml
@float
-@image{/assets/kubed-overview,,,Image: Four different kinds of Kubed buffers
in Emacs,.png}
+@ifset split
+@image{../../assets/kubed-overview,,,Image: Four different kinds of Kubed
buffers in Emacs,.png}
+@end ifset
+@ifclear split
+@image{assets/kubed-overview,,,Image: Four different kinds of Kubed buffers in
Emacs,.png}
+@end ifclear
@caption{Pods, logs, shells, YAMLs, all in one integrated interface}
@end float
-@end ifhtml
You can use Kubed to:
@@ -158,16 +161,24 @@ with @kbd{C-c k +} and attach to a running pod with
@kbd{C-c k p a}.
The @kbd{C-c k} binding is just a suggestion of course, feel free to
pick any key sequence you like.
-@ifhtml
@float
-@image{/assets/kubed-prefix-map,,,Image: Emacs which-key popup for
kubed-prefix-map keymap,.png}
+@ifset split
+@image{../../assets/kubed-prefix-map,,,Image: Emacs which-key popup for
kubed-prefix-map keymap,.png}
+@end ifset
+@ifclear split
+@image{assets/kubed-prefix-map,,,Image: Emacs which-key popup for
kubed-prefix-map keymap,.png}
+@end ifclear
-@image{/assets/kubed-deployment-prefix-map,,,Image: Emacs which-key popup for
kubed-deployment-prefix-map,.png}
+@ifset split
+@image{../../assets/kubed-deployment-prefix-map,,,Image: Emacs which-key popup
for kubed-deployment-prefix-map,.png}
+@end ifset
+@ifclear split
+@image{assets/kubed-deployment-prefix-map,,,Image: Emacs which-key popup for
kubed-deployment-prefix-map,.png}
+@end ifclear
@caption{Use @code{kubed-prefix-map} for quick access to the main Kubed
commands}
@end float
-@end ifhtml
You can also access all of the commands in @code{kubed-prefix-map} via
the menu-bar @samp{Kubernetes} menu---to add this menu to your
@@ -312,12 +323,15 @@ resource with @kbd{C-x x g} (@code{revert-buffer-quick})
and
resource and want to restart from a clean slate.
@end itemize
-@ifhtml
@float
-@image{/assets/kubed-replace-diff,,,Image: Displaying and editing YAML of
Kubernetes pod with Kubed,.png}
+@ifset split
+@image{../../assets/kubed-replace-diff,,,Image: Displaying and editing YAML of
Kubernetes pod with Kubed,.png}
+@end ifset
+@ifclear split
+@image{assets/kubed-replace-diff,,,Image: Displaying and editing YAML of
Kubernetes pod with Kubed,.png}
+@end ifclear
@caption{Type @kbd{C-x C-q} in a resource YAML buffer to edit it, @kbd{C-c
C-c} to apply}
@end float
-@end ifhtml
@node Browse Resources
@section Browse Resources
@@ -352,12 +366,15 @@ from a shared parent mode. The pods list uses the
of Kubernetes deployments uses @code{kubed-deployments-mode}, and so
on.
-@ifhtml
@float
-@image{/assets/kubed-list-transient,,,Image: Kubed pods list buffer with the
help transient menu visible,.png}
+@ifset split
+@image{../../assets/kubed-list-transient,,,Image: Kubed pods list buffer with
the help transient menu visible,.png}
+@end ifset
+@ifclear split
+@image{assets/kubed-list-transient,,,Image: Kubed pods list buffer with the
help transient menu visible,.png}
+@end ifclear
@caption{Browse your pods, deployments, and other resources with Kubed list
buffers}
@end float
-@end ifhtml
The common parent major mode is @code{kubed-list-mode}:
@@ -630,16 +647,24 @@ running in Kubernetes, the ``Kubernetes Logs'' transient
menu which
you open with @code{kubed-transient-logs} lets you set a maximum
number of logs to retrieve, among other knobs and handles.
-@ifhtml
@float
-@image{/assets/kubed-transient,,,Image: The Kubed main transient menu,.png}
+@ifset split
+@image{../../assets/kubed-transient,,,Image: The Kubed main transient
menu,.png}
+@end ifset
+@ifclear split
+@image{assets/kubed-transient,,,Image: The Kubed main transient menu,.png}
+@end ifclear
-@image{/assets/kubed-transient-exec,,,Image: The Kubed Exec transient
menu,.png}
+@ifset split
+@image{../../assets/kubed-transient-exec,,,Image: The Kubed Exec transient
menu,.png}
+@end ifset
+@ifclear split
+@image{assets/kubed-transient-exec,,,Image: The Kubed Exec transient menu,.png}
+@end ifclear
@caption{Explore Kubed commands with transient menus}
@end float
-@end ifhtml
Command @code{kubed-transient} opens the Kubed ``root'' transient
menu, which is a dispatch that lets you access different transient
@@ -681,12 +706,15 @@ specify a different context too.
In the deployments list buffer, you can scale the deployment at point
by simply typing @kbd{$}. @xref{Browse Resources}.
-@ifhtml
@float
-@image{/assets/kubed-scale-deployments,,,Image: Help transient menu in Kubed
deployments list buffer,.png}
+@ifset split
+@image{../../assets/kubed-scale-deployments,,,Image: Help transient menu in
Kubed deployments list buffer,.png}
+@end ifset
+@ifclear split
+@image{assets/kubed-scale-deployments,,,Image: Help transient menu in Kubed
deployments list buffer,.png}
+@end ifclear
@caption{Scale deployments with @kbd{$} in the deployments list buffer}
@end float
-@end ifhtml
Lastly, you can scale deployments using the transient menu
@code{kubed-transient-scale-deployment}, which is available from the
