Replies: 1 comment
-
There's also a changelog at the top of the page. Is that sufficient or do we need the Changelog section to see which version we have approved? |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Overview
Introduction and context.
Current Setup and Challenges
The problem statement and the current state. Current architecture.
Proposed Solution
Detailed solution design. Changes over the current implementation, or a specification of a new solution.
For API changes, structure the proposed solution as an API specification.
Feel free to add diagrams where it makes easier to get concepts across.
Security considerations
What are the security considerations for this change?
Observability considerations
Is there any observability that should be established or changed as part of this change?
Deployment and rollout considerations
What are the deployment considerations for this change? Is this a breaking change?
Appendix
References if any.
Changelog
Approvals
Beta Was this translation helpful? Give feedback.
All reactions