Skip to content
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.

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

Replace hello-pepr.ts with pepr-excellent-examples repo + docs #288

Open
bdw617 opened this issue Oct 3, 2023 · 4 comments
Open

Replace hello-pepr.ts with pepr-excellent-examples repo + docs #288

bdw617 opened this issue Oct 3, 2023 · 4 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@bdw617
Copy link
Contributor

bdw617 commented Oct 3, 2023

Is your feature request related to a problem? Please describe.

hello-pepr is great, but it's better as a test framework and a stream of examples.

Describe the solution you'd like

we should discuss in deeper what this should be, but it needs a lot of work.

Should include Prometheus example for scraping metrics with Grafana dashboard with PolicyReport

@bdw617 bdw617 added the enhancement New feature or request label Oct 3, 2023
@cmwylie19 cmwylie19 added documentation Improvements or additions to documentation wontfix This will not be worked on and removed documentation Improvements or additions to documentation enhancement New feature or request labels Oct 4, 2023
@cmwylie19
Copy link
Collaborator

cmwylie19 commented Oct 5, 2023

Thanks for the idea. External documentation like a GitHub repo is an excellent thought. We are planning an entire epic where we plan on addressing the underlying concerns to improve the project's documentation and examples.

Here is a link of the issues that we are planning on prioritizing after a few initial high priority items which includes a website where the idea is that it will be similar to Zarf's (in time).

However, hello-pepr.ts doesn't need to be removed in order to provide excellent documentation and examples. It is a fundamental part of the current documentation/training process of Pepr and gets the user developing immediately after initializing a Pepr module. External docs/examples and hello-pepr can all coexist together.

I'll tag this issue in a similar issue and we can track progress there.

@cmwylie19
Copy link
Collaborator

cmwylie19 commented Nov 2, 2023

I chatted with Jeff and the team around this and you are right, apologies for closing.

This issue is more like an epic that is never really done. This repo will start a capability demonstrating OnSchedule

WIP

TODO: brainstorm a way to hook this into CI.

@cmwylie19 cmwylie19 added documentation Improvements or additions to documentation and removed wontfix This will not be worked on labels Nov 2, 2023
@cmwylie19 cmwylie19 self-assigned this Nov 2, 2023
@cmwylie19 cmwylie19 removed their assignment Nov 13, 2023
@cmwylie19
Copy link
Collaborator

cmwylie19 commented Nov 13, 2023

This repository will undergo a change where it will consist of folders of actual Pepr modules with e2e tests. It will be a continual WIP

btlghrants added a commit that referenced this issue Nov 16, 2023
## Description

`OnSchedule` implementation. This PR includes documentation and will
include examples as eluded to in #288 .


Creates a shadow store if and only if there is a schedule created to
conserve resources.

## Related Issue

Fixes #308 

<!-- or -->
Relates to #288 

## Type of change

- [ ] Bug fix (non-breaking change which fixes an issue)
- [x] New feature (non-breaking change which adds functionality)
- [x] Other (security config, docs update, etc)

## Checklist before merging

- [x] Test, docs, adr added or updated as needed
- [x] [Contributor Guide
Steps](https://github.com/defenseunicorns/pepr/blob/main/CONTRIBUTING.md#submitting-a-pull-request)
followed


### Expectations


- Schedule store lastTimestamp while store increments count.
- When the `OnSchedule` is not used, there should be no schedulestore

---------

Signed-off-by: Case Wylie <cmwylie19@defenseunicorns.com>
Co-authored-by: Barrett <81570928+btlghrants@users.noreply.github.com>
@cmwylie19 cmwylie19 added the good first issue Good for newcomers label Nov 30, 2023
@btlghrants btlghrants self-assigned this Jan 9, 2024
@btlghrants btlghrants changed the title replace hello-pepr.ts with a github of excellent examples and documentation. Replace hello-pepr.ts with pepr-excellent-examples repo + docs Jan 9, 2024
cmwylie19 added a commit that referenced this issue Mar 11, 2024
## Description

A couple minor, rando fixes containing things I noticed while writing
tests in #288.

## Type of change

- [x] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Other (security config, docs update, etc)

## Checklist before merging

- [ ] Test, docs, adr added or updated as needed
- [ ] [Contributor Guide
Steps](https://github.com/defenseunicorns/pepr/blob/main/CONTRIBUTING.md#submitting-a-pull-request)
followed

---------

Co-authored-by: Case Wylie <cmwylie19@defenseunicorns.com>
@cmwylie19 cmwylie19 removed the good first issue Good for newcomers label Mar 18, 2024
@cmwylie19
Copy link
Collaborator

  • mutate
  • filters

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Status: ✅ Done
Development

No branches or pull requests

3 participants