Skip to content

Enhance our Pepr Debugging docs #1776

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.

Sign up for GitHub

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

Jump to bottom
Closed
cmwylie19 opened this issue Feb 7, 2025 · 1 comment · Fixed by #1802
Closed

Enhance our Pepr Debugging docs #1776

cmwylie19 opened this issue Feb 7, 2025 · 1 comment · Fixed by #1802
Assignees
@samayer12
Labels
tech-debt
Milestone
v0.45.1

Comments

@cmwylie19
Copy link
Contributor

cmwylie19 commented Feb 7, 2025 •
edited
Loading

Describe what should be investigated or refactored

https://docs.pepr.dev/main/best-practices/#debugging Needs to include how to tell if a watch event was caught, and if a resource was mutated.
@cmwylie19
Copy link
Contributor Author

@samayer12 This ticket came out of retro, do you think there needs to be more docs on top of the ones that exist now? https://docs.pepr.dev/main/best-practices/#debugging Is there anything specific that you would want to see?

@cmwylie19 cmwylie19 moved this from 🆕 New to 👀 In review in Pepr Project Board Feb 9, 2025
@cmwylie19 cmwylie19 added this to the v0.45.1 milestone Feb 9, 2025
This was referenced Feb 10, 2025
Merged
Merged
github-merge-queue bot pushed a commit that referenced this issue Feb 10, 2025
@samayer12
chore: tidy up docs (#1802)
de10031 
## Description

This PR makes minor changes to debugging docs and applies some
IDE-suggested `.md` fixes.

End to End Test:  <!-- if applicable -->  
(See [Pepr Excellent
Examples](https://github.com/defenseunicorns/pepr-excellent-examples))

## Related Issue

Fixes #1776

## 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
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in Pepr Project Board Feb 10, 2025
github-merge-queue bot pushed a commit that referenced this issue May 29, 2025
@samayer12 @cmwylie19
chore: check .md files with markdownlint-cli (#1803)
c7f74b4 
## Description

While working on #1776, I noticed that we do not use a markdown linter.
We should lint our markdown code since it's used to create user-facing
documentation. This PR adds `markdownlint-cli` as a project dependency
and configures `.md` linting upon commit.

## Related Issue

Fixes #2120 

Relates to #1776 

## 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: Case Wylie <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@samayer12 samayer12

Labels
tech-debt
Projects
Pepr Project Board
Archived in project
Milestone
v0.45.1
Development

Successfully merging a pull request may close this issue.

chore: tidy up docs defenseunicorns/pepr
2 participants
@cmwylie19 @samayer12