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

feat(proposal): Dogfooding of trestle in the oscal-compass community #58

Merged
merged 8 commits into from
Aug 7, 2024
43 changes: 43 additions & 0 deletions proposals/dogfooding-trestle-for-proposals.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
title: Dogfooding trestle for OSCAL-compass community proposals

---

## Summary
The OSCAL Compass community proposals are a structured process where there is a desire for a template to guide the process.
This proposal proposes using `trestle author docs` to manage the proposal documents.



## Background
OSCAL Compass is bootstrapping into a wider community effort with multiple stakeholders.
For this a [proposal process](./README.md) has been defined to govern community wide technical changes.

`trestle author docs` and `trestle author folders` were created to allow uses to manage the lifecycle of 'compliance adjacent' documents such as ADRs using the same tooling as `trestle`.


## Solution
Use trestle author docs, combined with a github action pipeline, to enforce the structure of the template.
This provides a perfect case to use `trestle` within the community generating more day-to-day user feedback.


## Alternatives Considered

### Use a template but do not use trestle

Simpler for users to get started, however, is a missed opportunity

### Do not even create a template

Harder to provide a consistent experience for the community when creating a proposal.
Having a template forces the community progressively refine what a proposal must answer before it can be accepted.

## Definition of Done

- [ ] Use this *inception* proposal to define a simple template
- [ ] Enforce the use of this template by using `trestle` and a GitHub Actions pipeline
- [ ] Extend the documentation in the [proposals README.md](./README.md) to cover the use of trestle for proposals

## Technical details

None