remove internal refs and tidy up (#33)

* remove refs to chainops and internal dev env; typos --------- Signed-off-by: Colin Douglas <[email protected]>
chainguard-dev · Nov 13, 2023 · 2407796 · 2407796
1 parent 065469c
commit 2407796
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 24 deletions.
diff --git a/pkg/auth/login/html.go b/pkg/auth/login/html.go
@@ -5,8 +5,8 @@ SPDX-License-Identifier: Apache-2.0
 
 package login
 
-const (
-	HTMLAuthSucessful = `<!DOCTYPE html>
+var (
+	HTMLAuthSuccessful = `<!DOCTYPE html>
 <html>
 	<head>
 		<title>Chainguard Authentication</title>
@@ -51,8 +51,8 @@ const (
 		</a>
 		<div class="container">
 			<div class="title">
-				<span class="chainctl">chainctl </span>
-				<span>authentication successful!</span>
+				<span class="logo">Chainguard</span>
+				<span> authentication successful!</span>
 			</div>
 			<div class="content">
 				<span>You may now close </span>
@@ -61,7 +61,7 @@ const (
 			</div>
 			<div class="links if-online">
 				<a href="https://console.enforce.dev" class="link login"><span class="logo">Chainguard Console</span></a>
-				<a href="https://go.chainguard.dev/chainctl-docs" class="link"><span class="chainctl">chainctl</span> documentation</a>
+				<a href="https://edu.chainguard.dev" class="link"><span class="logo">Chainguard Academy</span></a>
 				<a href="https://www.chainguard.dev/unchained" class="link"><span class="logo">Chainguard Blog</span></a>
 			</div>
 		</div>

diff --git a/pkg/auth/login/server.go b/pkg/auth/login/server.go
@@ -54,7 +54,7 @@ func newServer(ctx context.Context) (*server, error) {
 func (s *server) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	switch r.URL.Path {
 	case "/":
-		fmt.Fprint(w, HTMLAuthSucessful)
+		fmt.Fprint(w, HTMLAuthSuccessful)
 		close(s.token)
 		return
 

diff --git a/pkg/auth/token/token.go b/pkg/auth/token/token.go
@@ -80,11 +80,9 @@ func DeleteAll() error {
 	//
 	//  $ tree ~/Library/Caches/chainguard
 	// /Users/foo/Library/Caches/chainguard
-	// ├── https:--console-api.chainops.dev
-	// │   └── oidc-token
 	// ├── https:--console-api.enforce.dev
 	// │   └── oidc-token
-	// ├── https:--console-api.test-env.dev
+	// ├── https:--cgr.dev
 	//    └── oidc-token
 	for _, file := range files {
 		if !file.IsDir() {

diff --git a/pkg/validation/enforcer_options.go b/pkg/validation/enforcer_options.go
@@ -19,9 +19,9 @@ const (
 )
 
 var (
-	// Valid webhook label selection options for a managed cluster
+	// ValidNamespaceEnforcementModeOpts are valid webhook label selection options for a managed cluster
 	ValidNamespaceEnforcementModeOpts = sets.NewString(NamespaceEnforcementModeOptIn, NamespaceEnforcementModeOptOut)
 
-	// Valid enforcer options available field names
+	// ValidEnforcerOptions are valid field names of enforcer options available
 	ValidEnforcerOptions = sets.NewString(EnforcerOptionWebhookFailOpen, EnforcerOptionEnableCIPCache, EnforcerOptionNamespaceEnforcementMode)
 )
diff --git a/proto/capabilities/capabilities.go b/proto/capabilities/capabilities.go
@@ -12,7 +12,7 @@ import (
 	"io"
 	"sort"
 	"strings"
-	sync "sync"
+	"sync"
 
 	"github.com/bits-and-blooms/bitset"
 	"go.uber.org/zap"

diff --git a/proto/platform/tenant/v1/attestation.platform.pb.go b/proto/platform/tenant/v1/attestation.platform.pb.go
diff --git a/proto/platform/tenant/v1/attestation.platform.proto b/proto/platform/tenant/v1/attestation.platform.proto
@@ -28,21 +28,22 @@ service Attestations {
 message Attestation {
   // id, The Attestation UIDP at which this Attestation resides in the hierarchy.
   string id = 1;
-  // raw_attestation is a free form typr to stub in any attesations so we don't end up a
-  // adding new tables for all the new type of attesations , initial goal is to add image configs a
-  // and anything which comes up after that
 
+  // raw_attestation is a free form type to stub in any attestations so we don't end up a
+  // adding new tables for all the new type of attestations, initial goal is to add image configs
+  // and anything which comes up after that
   bytes raw_attestation = 2;
 
-  // format holds whether the Document format type
+  // format holds the Document format type
   string format = 3;
+
   // generated_at holds when the Attestation was generated.
   google.protobuf.Timestamp generated_at = 4;
 
   // Name of the Attestation.
   string name = 5;
 
-  // Short description of the Attesation
+  // Short description of the Attestation
   string description = 6;
 
   // digest of the Attestation when ingested

diff --git a/proto/platform/tenant/v1/context.platform.pb.go b/proto/platform/tenant/v1/context.platform.pb.go
diff --git a/proto/platform/tenant/v1/context.platform.proto b/proto/platform/tenant/v1/context.platform.proto
@@ -52,7 +52,7 @@ message RecordContext {
     // Ancestry relationships are added to records when a "base image"
     // relationship has been uncovered.  This context is added to BOTH
     // records with their respective roles.  The base image will get
-    // the Role BASE, and the derivative image will get the Rile DERIVED.
+    // the Role BASE, and the derivative image will get the Role DERIVED.
     message Ancestry {
       Role role = 1;
 
@@ -75,7 +75,7 @@ message RecordContext {
     // index.  The INDEX will typically contain N contexts carrying the Role
     // INDEX, the id of the VARIANT's record, and the version information
     // that discriminates that VARIANT from other VARIANTs.  The VARIANT
-    // will typically (but not always!) contain 1 context varrying the Role
+    // will typically (but not always!) contain 1 context carrying the Role
     // VARIANT, the id of the INDEX's record, and the version information
     // that discriminates it among the other VARIANTs in the INDEX.
     message Variant {