Skip to content

Commit

Permalink
Use tabs in the example Go code
Browse files Browse the repository at this point in the history
Signed-off-by: Tom Wieczorek <[email protected]>
  • Loading branch information
twz123 committed Oct 10, 2024
1 parent bc3e7bd commit 620c736
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 21 deletions.
3 changes: 3 additions & 0 deletions .markdownlint.jsonc
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
"first-line-h1": false,
"single-trailing-newline": false,
"ol-prefix": "one_or_ordered",
"MD010": {
"code_blocks": false // Go uses tabs ¯\_(ツ)_/¯
},
"MD033": {
"allowed_elements": [
"br" // The br tag is more readable than two trailing spaces.
Expand Down
42 changes: 21 additions & 21 deletions docs/architecture/adr-001-autopilot-oci-basic-auth-support.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,12 +31,12 @@ Starting with the current `PlanResourceURL` struct:

```go
type PlanResourceURL struct {
// URL is the URL of a downloadable resource.
URL string `json:"url"`
// URL is the URL of a downloadable resource.
URL string `json:"url"`

// Sha256 provides an optional SHA256 hash of the URL's content for
// verification.
Sha256 string `json:"sha256,omitempty"`
// Sha256 provides an optional SHA256 hash of the URL's content for
// verification.
Sha256 string `json:"sha256,omitempty"`
}
```

Expand All @@ -45,22 +45,22 @@ pulls. This will be achieved by adjusting the struct as follows:

```go
type PlanResourceURL struct {
// URL is the URL of a downloadable resource.
URL string `json:"url"`

// Sha256 provides an optional SHA256 hash of the URL's content for
// verification.
Sha256 string `json:"sha256,omitempty"`

// SecretRef holds a reference to a secret where the credentials are
// stored. We use these credentials when pulling the artifacts from the
// provided URL using
// any of the supported protocols (http, https, and oci).
SecretRef *corev1.SecretReference `json:"secretRef,omitempty"`

// InsecureSkipTLSVerify indicates whether certificates in the remote
// URL (if using TLS) can be ignored.
InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty"`
// URL is the URL of a downloadable resource.
URL string `json:"url"`

// Sha256 provides an optional SHA256 hash of the URL's content for
// verification.
Sha256 string `json:"sha256,omitempty"`

// SecretRef holds a reference to a secret where the credentials are
// stored. We use these credentials when pulling the artifacts from the
// provided URL using
// any of the supported protocols (http, https, and oci).
SecretRef *corev1.SecretReference `json:"secretRef,omitempty"`

// InsecureSkipTLSVerify indicates whether certificates in the remote
// URL (if using TLS) can be ignored.
InsecureSkipTLSVerify bool `json:"insecureSkipTLSVerify,omitempty"`
}
```

Expand Down

0 comments on commit 620c736

Please sign in to comment.