-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Co-authored-by: Kasper Møller <[email protected]>
- Loading branch information
1 parent
b5f262e
commit d1efa1e
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
This guide is meant hold all of the experience from Eficodeans working with Kubernetes, distilled into one easily readable guide. | ||
|
||
This means, that we welcome all contributions to 'what is the right tech stack'. | ||
|
||
There are fundamentally 2 ways to contribute to this guide: recommend a tool, and adjust wording or tool areas of the guide. | ||
|
||
## Recommend a tool | ||
|
||
If you want to recommend a tool, the place to start is to write an Architecture Decision Record (ADR). All tools recommended in the guide is reflected in an ADR. | ||
|
||
To add an ADR do the following: | ||
|
||
`hugo new --kind adr <DesiredFolder>/ADRs/<NameOfADRFile>.md --source .pages` | ||
|
||
Fill out the sections in the generated ADR | ||
|
||
Create a PR with the ADR and let the discussion begin. If the PR is approved, the status should be updated to 'accepted', and the ADR previously in place should be updated to superseded by ADR-0123. | ||
|
||
## Suggest more general edits to tool categories or text | ||
|
||
Create a PR with your suggestions, it will automatically be assigned to the maintainers of the repo. | ||
|
||
## Questions | ||
|
||
If in doubt you can always reach out to the maintainers of this guide, maintainers can be found in the codeowners file in the .github folder. |