diff --git a/docs/code-style/go/README.md b/docs/code-style/go/README.md index 31c846b63..0b115b375 100644 --- a/docs/code-style/go/README.md +++ b/docs/code-style/go/README.md @@ -1,4 +1,4 @@ # Code Style -- [Enumeration Generation](enumeration-generation.md) -- [Style](style.md) +* [Enumeration Generation](enumeration-generation.md) +* [Style](style.md) diff --git a/docs/code-style/go/style.md b/docs/code-style/go/style.md index 9bc2b39d1..352e2b8d3 100644 --- a/docs/code-style/go/style.md +++ b/docs/code-style/go/style.md @@ -1,9 +1,9 @@ # Smithy Go Style Guide -- [Introduction](#introduction) -- [Guidelines](#guidelines) - - [Pointers to Interfaces](#pointers-to-interfaces) - - [Don't Panic](#dont-panic) +* [Introduction](#introduction) +* [Guidelines](#guidelines) + * [Pointers to Interfaces](#pointers-to-interfaces) + * [Don't Panic](#dont-panic) ## Introduction @@ -111,7 +111,7 @@ func main() { ### Don't Panic Code running in production must avoid panics. Panics are a major source of -[cascading failures](https://en.wikipedia.org/wiki/Cascading_failure). +[cascading failures](https://en.wikipedia.org/wiki/Cascading_failure). If an error occurs, the function must return an error and allow the caller to decide how to handle it. @@ -155,11 +155,11 @@ func main() { -Panic/recover is not an error handling strategy. +Panic/recover is not an error handling strategy. A program must panic only when -something irrecoverable happens such as a nil dereference. +something irrecoverable happens such as a nil dereference. An exception to this is -program initialization: bad things at program startup that +program initialization: bad things at program startup that should abort the program may cause panic. ```go @@ -204,5 +204,5 @@ is excellent to report such extreme issues and make sure that the team is notified to resolve the root cause. [It's useful to see the stacktrace at the moment -of a process panicking](https://yourbasic.org/golang/recover-from-panic/). +of a process panicking](https://yourbasic.org/golang/recover-from-panic/). Logs, Traces and Metrics should be enriched with the latter. diff --git a/docs/getting-started.md b/docs/getting-started.md index ce6903a55..982174be1 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -176,7 +176,8 @@ KiND cluster, that's not the case. Instead, the registry's host is deploy the pipelines and their image repositories will also have to be set to this value.* -*\*\*Make sure that you use the draconctl image that you pushed in the repository.* +*\*\*Make sure that you use the draconctl image that you pushed +in the repository.* #### Using a different base image for your images