Skip to content

Commit

Permalink
Some fine-tuning of krew.sigs.k8s.io (#634)
Browse files Browse the repository at this point in the history
In particular, consistently have bold heading in quote blocks.
  • Loading branch information
corneliusweig committed Aug 16, 2020
1 parent 63664a3 commit bf4ad3a
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 11 deletions.
20 changes: 11 additions & 9 deletions site/content/docs/developer-guide/plugin-manifest.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,14 +146,15 @@ files out of archive.
The `files:` list specifies the copy operations (like `mv <from> <to>`) to
the files `from` the archive `to` the installation destination.

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

> If the `files:` list is unspecified, it defaults to:
> ```yaml
> files:
> - from: *
> to: .
> ```
```yaml
files:
- from: *
to: .
```

> **Note:** If applicable, it is best practice to skip the `files:` list altogether.
* **Example:** Copy specific files:

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

> **Note on underscore conversion:** If your plugin name contains dashes, krew
> will automatically convert them to underscores for kubectl to be able to find
> your plugin.
> will automatically convert them to underscores for
> [kubectl](https://kubernetes.io/docs/tasks/extend-kubectl/kubectl-plugins/#names-with-dashes-and-underscores)
> to be able to find your plugin.
>
> For example, if your plugin name is `view-logs` and your plugin binary is named
> `run.sh`, krew will create a symbolic named `kubectl-view_logs` automatically.
2 changes: 1 addition & 1 deletion site/content/docs/developer-guide/plugin-stats.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This data is obtained by scraping the downloads count of your plugin assets on
- does not distinguish between installs, reinstalls and upgrades
- is purely a tracking of download counts of your release assets over time.

> Note: Krew plugin stats dashboard is provided as a best effort by Krew
> **Note:** Krew plugin stats dashboard is provided as a best effort by Krew
> maintainers to measure success of Krew and its plugins. We cannot guarantee
> its availability and accuracy.
>
Expand Down
2 changes: 1 addition & 1 deletion site/content/docs/user-guide/setup/uninstall.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,5 +12,5 @@ To remove Krew and plugins installed altogether, run this on your Linux/macOS ma

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

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

0 comments on commit bf4ad3a

Please sign in to comment.