chore: docs refresher (#1683)

## Description Docs Refresher, as I was pointing out places in our docs doing the backwards compatability doc, I saw several places our docs needed to be updated. - remove reference to pepr-istio from docs as it is deprecated ## Related Issue Fixes #  Relates to # ## Type of change - [ ] Bug fix (non-breaking change which fixes an issue) - [ ] New feature (non-breaking change which adds functionality) - [x] Other (security config, docs update, etc) ## Checklist before merging - [x] Unit, [Journey](https://github.com/defenseunicorns/pepr/tree/main/journey), [E2E Tests](https://github.com/defenseunicorns/pepr-excellent-examples), [docs](https://github.com/defenseunicorns/pepr/tree/main/docs), [adr](https://github.com/defenseunicorns/pepr/tree/main/adr) added or updated as needed - [x] [Contributor Guide Steps](https://docs.pepr.dev/main/contribute/#submitting-a-pull-request) followed --------- Signed-off-by: Case Wylie <[email protected]> Co-authored-by: Sam Mayer <[email protected]>
defenseunicorns · Jan 23, 2025 · bdbd258 · bdbd258
1 parent 01c7660
commit bdbd258
Show file tree

Hide file tree

Showing 2 changed files with 1 addition and 3 deletions.
diff --git a/docs/030_user-guide/020_pepr-modules.md b/docs/030_user-guide/020_pepr-modules.md
@@ -2,4 +2,4 @@
 
 ## What is a Pepr Module?
 
-A Pepr Module is a collection of files that can be used to create a new Pepr Project. A Pepr Module can be used to create a new Pepr Project by using the `npx pepr init` command.
+A Pepr Module is a collection of [capabilities](https://docs.pepr.dev/main/user-guide/capabilities/), config and scaffolding in a Pepr Project. To create a module use the `npx pepr init` command.
diff --git a/docs/030_user-guide/040_capabilities.md b/docs/030_user-guide/040_capabilities.md
@@ -25,5 +25,3 @@ You also can publish your own Pepr capabilities to NPM and import them.  A coupl
 - Reuseable capability versions should use the format `0.x.x` or `0.12.x` as examples to determine compatibility with other reusable capabilities. Before `1.x.x`, we recommend binding to `0.x.x` if you can for maximum compatibility.
 
 - `pepr.ts` will still be used for local development, but you'll also need to publish an `index.ts` that exports your capabilities. When you build & publish the capability to NPM, you can use `npx pepr build -e index.ts` to generate the code needed for reuse by other Pepr modules.
-
-- See [Pepr Istio](https://github.com/defenseunicorns/pepr-istio) for an example of a reusable capability.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -2,4 +2,4 @@

		## What is a Pepr Module?

		A Pepr Module is a collection of files that can be used to create a new Pepr Project. A Pepr Module can be used to create a new Pepr Project by using the `npx pepr init` command.
		A Pepr Module is a collection of [capabilities](https://docs.pepr.dev/main/user-guide/capabilities/), config and scaffolding in a Pepr Project. To create a module use the `npx pepr init` command.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -25,5 +25,3 @@ You also can publish your own Pepr capabilities to NPM and import them. A coupl
		- Reuseable capability versions should use the format `0.x.x` or `0.12.x` as examples to determine compatibility with other reusable capabilities. Before `1.x.x`, we recommend binding to `0.x.x` if you can for maximum compatibility.

		- `pepr.ts` will still be used for local development, but you'll also need to publish an `index.ts` that exports your capabilities. When you build & publish the capability to NPM, you can use `npx pepr build -e index.ts` to generate the code needed for reuse by other Pepr modules.

		- See [Pepr Istio](https://github.com/defenseunicorns/pepr-istio) for an example of a reusable capability.