Skip to content

Commit bf4ad3a

Browse files
Some fine-tuning of krew.sigs.k8s.io (#634)
In particular, consistently have bold heading in quote blocks.
1 parent 63664a3 commit bf4ad3a

File tree

3 files changed

+13
-11
lines changed

3 files changed

+13
-11
lines changed

site/content/docs/developer-guide/plugin-manifest.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -146,14 +146,15 @@ files out of archive.
146146
The `files:` list specifies the copy operations (like `mv <from> <to>`) to
147147
the files `from` the archive `to` the installation destination.
148148

149-
* **Example:** Extract all files (default behavior, you can omit `files:` altogether)
149+
* **Example:** Extract all files: If the `files:` list is unspecified, it defaults to:
150150

151-
> If the `files:` list is unspecified, it defaults to:
152-
> ```yaml
153-
> files:
154-
> - from: *
155-
> to: .
156-
> ```
151+
```yaml
152+
files:
153+
- from: *
154+
to: .
155+
```
156+
157+
> **Note:** If applicable, it is best practice to skip the `files:` list altogether.
157158

158159
* **Example:** Copy specific files:
159160

@@ -195,8 +196,9 @@ after installation is complete. The name of the symbolic link comes from the
195196
plugin name (i.e. the `metadata.name` field).
196197

197198
> **Note on underscore conversion:** If your plugin name contains dashes, krew
198-
> will automatically convert them to underscores for kubectl to be able to find
199-
> your plugin.
199+
> will automatically convert them to underscores for
200+
> [kubectl](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/#names-with-dashes-and-underscores)
201+
> to be able to find your plugin.
200202
>
201203
> For example, if your plugin name is `view-logs` and your plugin binary is named
202204
> `run.sh`, krew will create a symbolic named `kubectl-view_logs` automatically.

site/content/docs/developer-guide/plugin-stats.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ This data is obtained by scraping the downloads count of your plugin assets on
2323
- does not distinguish between installs, reinstalls and upgrades
2424
- is purely a tracking of download counts of your release assets over time.
2525

26-
> Note: Krew plugin stats dashboard is provided as a best effort by Krew
26+
> **Note:** Krew plugin stats dashboard is provided as a best effort by Krew
2727
> maintainers to measure success of Krew and its plugins. We cannot guarantee
2828
> its availability and accuracy.
2929
>

site/content/docs/user-guide/setup/uninstall.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ To remove Krew and plugins installed altogether, run this on your Linux/macOS ma
1212

1313
On Windows, remove directory: `%USERPROFILE%\.krew`.
1414

15-
> Note: If you installed Krew with another package manager (e.g. Homebrew),
15+
> **Note:** If you installed Krew with another package manager (e.g. Homebrew),
1616
> follow their installations in addition to instructions above.

0 commit comments

Comments
 (0)