AWS prescriptive-guidance documentation change
Summary
Updated documentation formatting: changed section headers to markdown H2 syntax, modified image path, removed backticks from branch names, added GitHub flow reference, and fixed breadcrumb navigation.
Security assessment
Changes are purely structural/formatting updates with no security implications. The protected branch references remain unchanged without new security context. No vulnerabilities or security features are mentioned.
Diff
diff --git a/prescriptive-guidance/latest/architectural-decision-records/appendix.md b/prescriptive-guidance/latest/architectural-decision-records/appendix.md index b2cd4d79b..5fda8787c 100644 --- a//prescriptive-guidance/latest/architectural-decision-records/appendix.md +++ b//prescriptive-guidance/latest/architectural-decision-records/appendix.md @@ -5 +5,3 @@ -[Documentation](/index.html)[AWS Prescriptive Guidance](https://aws.amazon.com/prescriptive-guidance/)[Using architectural decision records to streamline technical decision-making for a software development project](welcome.html) +[Documentation](/index.html)[AWS Prescriptive Guidance](https://aws.amazon.com/prescriptive-guidance/)[Using architectural decision records to streamline decision-making during development](introduction.html) + +TitleStatusDateContextDecisionConsequencesComplianceNotes @@ -9 +11 @@ -**Title** +## Title @@ -13 +15 @@ This decision defines the software development lifecycle approach for ABC applic -**Status** +## Status @@ -17 +19 @@ Accepted -**Date** +## Date @@ -21 +23 @@ Accepted -**Context** +## Context @@ -25 +27 @@ ABC application is a packaged solution, which will be deployed to the customer's -**Decision** +## Decision @@ -29 +31 @@ We use an adapted version of the [GitFlow workflow](https://www.atlassian.com/gi - + @@ -31 +33 @@ We use an adapted version of the [GitFlow workflow](https://www.atlassian.com/gi -For simplicity, we will not be using the `hotfix/*` and `release/*` branches, because ABC application will be packaged instead of being deployed to a specific environment. For this reason, there is no need for additional complexity that might prevent us from reacting quickly to fix bugs in production releases, or testing releases in a separate environment. +For simplicity, we will not be using the hotfix/* and release/* branches, because ABC application will be packaged instead of being deployed to a specific environment. For this reason, there is no need for additional complexity that might prevent us from reacting quickly to fix bugs in production releases, or testing releases in a separate environment. @@ -35 +37 @@ The following is the agreed branching strategy: - * Each repository must have a protected `main` branch that will be used to tag releases. + * Each repository must have a protected main branch that will be used to tag releases. @@ -37 +39 @@ The following is the agreed branching strategy: - * Each repository must have a protected `develop` branch for all ongoing development work. + * Each repository must have a protected develop branch for all ongoing development work. @@ -42 +44 @@ The following is the agreed branching strategy: -**Consequences** +## Consequences @@ -53 +55 @@ Negative: - * GitFlow is more complicated than trunk-based development or GitHub flow and has more overhead. + * GitFlow is more complicated than trunk-based development or [GitHub flow](https://guides.github.com/introduction/flow/) and has more overhead. @@ -58 +60 @@ Negative: -**Compliance** +## Compliance @@ -60 +62 @@ Negative: - * The `main` and `develop` branches in each repository must be marked as `Protected`. + * The main and develop branches in each repository must be marked as Protected. @@ -62 +64 @@ Negative: - * Changes to the `main` and `develop` branches must be propagated by using merge requests. + * Changes to the main and develop branches must be propagated by using merge requests. @@ -69 +71 @@ Negative: -**Notes** +## Notes