SSWConsulting / SSWConsulting/SSW.CleanArchitecture
Separate Repo for ADR Website
Nobody has claimed this yet.
- Dominant language
- C#
- Stars
- 199
- Forks
- 37
- PR merge metrics
- No merged PRs in 30d
Description
CC: @GordonBeeming @jernejk
Currently, publishing Log4Brains creates a next.js website which is published to the gh-pages branch. While this is a simple option, it does open up the possibility of this brain being merged to main in which would be catestrophic.
Acceptance Critieria
- Investigate if we should default to a branch or separate repo for the ADR website
- If we stick to the current approach, document in the readme how to configure a separate repo for the ADR website.
Contributor guide
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 reviewing how Log4Brains currently publishes the Next.js website to the gh-pages branch and the repository README. Determine whether a separate branch or repository should be the default, then document the separate-repository configuration if the current approach remains. Done means the publishing safety decision is recorded and the applicable README guidance is complete.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- next.js
- Domain
- documentation, release
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100