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

Move ADRs into documentation/wiki/ to sync with public wiki #1820

Closed
2 tasks
widal001 opened this issue Apr 24, 2024 · 0 comments · Fixed by #1826
Closed
2 tasks

Move ADRs into documentation/wiki/ to sync with public wiki #1820

widal001 opened this issue Apr 24, 2024 · 0 comments · Fixed by #1826
Assignees

Comments

@widal001
Copy link
Collaborator

widal001 commented Apr 24, 2024

Summary

In order to sync the ADRs between the GitHub repo and the wiki, we need to move them into the documentation/wiki/ sub-directory.

Acceptance criteria

  • ADRs are now stored in documentation/wiki/decisions/
  • New ADRs can be added either through a PR in GitHub or a change request in GitBook
@widal001 widal001 self-assigned this Apr 24, 2024
@widal001 widal001 changed the title Move ADRs into documents/wiki/ to sync with public wiki Move ADRs into documentation/wiki/ to sync with public wiki Apr 24, 2024
widal001 added a commit that referenced this issue May 2, 2024
- Moves `documentation/decisions/` to `documentation/wiki/decisions/`
- Adds a `adr/README.md` file so that wiki users can browse all of the
ADRs
- Renames `infra/index.md` to `infra/README.md` to do the same for Infra
ADRs
- Updates `SUMMARY.md` so that the newly synced files will appear in the
wiki UI
- Adds `ci-wiki-links.yml` to check that all files in
`documentation/wiki/` are in `SUMMARY.md`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging a pull request may close this issue.

1 participant