SSWConsulting / SSWConsulting/SSW.Rules
📝 Document adding new frontmatter field
Open
Nobody has claimed this yet.
Type: Documentation
zzOld
- Dominant language
- TypeScript
- Stars
- 26
- Forks
- 17
- Avg merge
- 14h 39m
- Merged PRs (30d)
- 2
Description
There are a lot of steps to adding/removing a new frontmatter field to rules or categories, these should be documented.
- Gatsby - There are a few locations in the gatsby code where it needs to be added
- AzFuncs - The Azure Functions use some of the frontmatter when storing history
- (optional) Backfill all rules - See #1307
A script was used to do this. If needed the same script can be used with modifications.
### Tasks
- [ ] Document this process
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by tracing how frontmatter is handled in Gatsby and AzFuncs, then review issue #1307 and the previously used backfill script. Document the steps for adding or removing a field in both locations, including the optional backfill process and script considerations.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- azure, typescript
- Domain
- backend, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100