Add kubeconform docs and cleanup (#1191)

* Add kubeconform docs and cleanup

Signed-off-by: Fiachra Corcoran <[email protected]>

* Remove more GCP data

Signed-off-by: Fiachra Corcoran <[email protected]>

* Add netlify.toml

Signed-off-by: Fiachra Corcoran <[email protected]>

* Downgrade docsy

Signed-off-by: Fiachra Corcoran <[email protected]>

---------

Signed-off-by: Fiachra Corcoran <[email protected]>

Author: efiacor

.gitignore

@@ -1,7 +1,11 @@
 .idea
 .vscode
 dist
-node_modules
+
+# Node dependencies
+node_modules/
+package-lock.json
+
 *.iml
 .npmrc
 .DS_Store
@@ -10,6 +14,12 @@ bin/
 __pycache__
 .docker
 documentation/resources
+documentation/content/en/examples
+
+# Hugo
+.hugo*
+resources/
+public/
 
 # We use sed -i.bak when doing in-line replace, because it works better cross-platform
 *.bak

documentation/Makefile

@@ -1,4 +1,4 @@
-serve: copy-examples
+serve: clean copy-examples inject-relatedexamples
 	hugo server \
 		--disableFastRender \
 		--buildDrafts \
@@ -12,13 +12,13 @@ serve: copy-examples
 		--templateMetricsHints \
 		--gc
 
-production-build: copy-examples
+production-build: copy-examples inject-relatedexamples
 	hugo version
 	hugo \
 		--minify
 	npx -y pagefind --site public
 
-preview-build: copy-examples
+preview-build: copy-examples inject-relatedexamples
 	hugo \
 		--baseURL $(DEPLOY_PRIME_URL) \
 		--buildDrafts \
@@ -27,8 +27,35 @@ preview-build: copy-examples
 	npx -y pagefind --site public
 
 copy-examples:
-#	mkdir -p public/examples
-#	cp -R ../examples public/examples
+	@mkdir -p content/en/examples
+	@echo "Syncing only README.md files"
+	@rsync -av \
+		--exclude='.expected/' \
+		--include='*/' \
+		--include='README.md' \
+		--exclude='*' \
+		../examples/ content/en/examples/
 
-	mkdir -p content/en/
-	cp -R ../examples content/en/examples
+inject-relatedexamples:
+	@echo "Injecting {{< relatedexamples >}} shortcode above 'Overview'..."
+	@find content/en/examples -type f -name "README.md" ! -path "*/.expected/*" | while read file; do \
+		if ! grep -q '{{< relatedexamples' "$$file"; then \
+			if grep -qi '^### *Overview' "$$file"; then \
+				echo "Updating $$file with relatedexamples shortcode"; \
+				tmpfile=$$(mktemp); \
+				awk -v shortcode="{{< relatedexamples >}}" 'BEGIN{inserted=0} \
+					/^### *[Oo]verview/ && !inserted {print shortcode "\n"; inserted=1} \
+					{print}' "$$file" > "$$tmpfile"; \
+				mv "$$tmpfile" "$$file"; \
+			fi; \
+		fi; \
+	done
+
+
+clean:
+	rm -rf content/en/examples \
+	       node_modules \
+	       public \
+	       resources \
+	       .hugo_build.lock \
+	       package-lock.json

documentation/content/en/function-catalog/_index.md

@@ -1,7 +1,5 @@
 ---
-title: Function Catalog
 linkTitle: Function Catalog
-description: Function Catalog
 toc_hide: false
 menu:
   main:
@@ -10,5 +8,4 @@ menu:
 
 ## Curated Functions Catalog
 
-
 {{< listfunctions >}}

documentation/content/en/function-catalog/apply-replacements/v0.1/_index.md

@@ -4,15 +4,12 @@ linkTitle: "apply-replacements"
 tags: "mutator"
 weight: 4
 description: |
-   Use the [kustomize replacements] feature as a KRM function. 
+   Use the kustomize replacements feature as a KRM function
 menu:
   main:
     parent: "Function Catalog"
 ---
 
-
-# apply-replacements
-
 {{< listversions >}}
 
 {{< listexamples >}}

documentation/content/en/function-catalog/apply-setters/v0.1/_index.md

@@ -3,16 +3,12 @@ title: "apply-setters"
 linkTitle: "apply-setters"
 tags: "mutator"
 weight: 4
-description: |
-   Update the field values parameterized by setters.
+description: Update the field values parameterized by setters
 menu:
   main:
     parent: "Function Catalog"
 ---
 
-
-# apply-setters
-
 {{< listversions >}}
 
 {{< listexamples >}}
@@ -40,7 +36,7 @@ A setter comment can be derived by replacing all the instances of setter values
 in the field value, with the corresponding setter names along with 'kpt-set:' prefix.
 
 ```shell
-e.g. image: gcr.io/nginx:1.16.1 # kpt-set: gcr.io/${image}:${tag}
+e.g. image: ghcr.io/nginx:1.16.1 # kpt-set: ghcr.io/${image}:${tag}
 ```
 
 <!--mdtogo-->
@@ -117,13 +113,13 @@ data:
 Invoke the function:
 
 ```shell
-$ kpt fn eval --image gcr.io/kpt-fn/apply-setters:v0.1.1 --fn-config ./apply-setters-fn-config
+$ kpt fn eval --image ghcr.io/kptdev/krm-functions-catalog/apply-setters:v0.1 --fn-config ./apply-setters-fn-config
 ```
 
 Alternatively, setter values can be passed as key-value pairs in the CLI
 
 ```shell
-$ kpt fn eval --image gcr.io/kpt-fn/apply-setters:v0.1.1 -- image=ubuntu replicas=3
+$ kpt fn eval --image ghcr.io/kptdev/krm-functions-catalog/apply-setters:v0.1 -- image=ubuntu replicas=3
 ```
 
 Modified resource looks like the following:
@@ -186,7 +182,7 @@ data:
 Invoke the function using the input config:
 
 ```shell
-$ kpt fn eval --image gcr.io/kpt-fn/apply-setters:v0.1.1 --fn-config ./apply-setters-fn-config
+$ kpt fn eval --image ghcr.io/kptdev/krm-functions-catalog/apply-setters:v0.1 --fn-config ./apply-setters-fn-config
 ```
 
 Modified resource looks like the following:
@@ -205,4 +201,4 @@ environments: # kpt-set: ${env}
 
 #### Note:
 
-Refer to the `create-setters` function documentation for information about creating setters.
+Refer to the [`create-setters`]({{< relref "function-catalog/create-setters/v0.1/" >}}) function documentation for information about creating setters.

documentation/content/en/function-catalog/apply-setters/v0.2/_index.md

@@ -3,16 +3,11 @@ title: "apply-setters"
 linkTitle: "apply-setters"
 tags: "mutator"
 weight: 4
-description: |
-   Update the field values parameterized by setters.
+description: Update the field values parameterized by setters
 menu:
   main:
     parent: "Function Catalog"
 ---
-
-
-# apply-setters
-
 {{< listversions >}}
 
 {{< listexamples >}}
@@ -40,7 +35,7 @@ A setter comment can be derived by replacing all the instances of setter values
 in the field value, with the corresponding setter names along with 'kpt-set:' prefix.
 
 ```shell
-e.g. image: gcr.io/nginx:1.16.1 # kpt-set: gcr.io/${image}:${tag}
+e.g. image: ghcr.io/nginx:1.16.1 # kpt-set: ghcr.io/${image}:${tag}
 ```
 
 <!--mdtogo-->
@@ -117,13 +112,13 @@ data:
 Invoke the function:
 
 ```shell
-$ kpt fn eval --image gcr.io/kpt-fn/apply-setters:v0.2.0 --fn-config ./apply-setters-fn-config
+$ kpt fn eval --image ghcr.io/kptdev/krm-functions-catalog/apply-setters:v0.2 --fn-config ./apply-setters-fn-config
 ```
 
 Alternatively, setter values can be passed as key-value pairs in the CLI
 
 ```shell
-$ kpt fn eval --image gcr.io/kpt-fn/apply-setters:v0.2.0 -- image=ubuntu replicas=3
+$ kpt fn eval --image ghcr.io/kptdev/krm-functions-catalog/apply-setters:v0.2 -- image=ubuntu replicas=3
 ```
 
 Modified resource looks like the following:
@@ -186,7 +181,7 @@ data:
 Invoke the function using the input config:
 
 ```shell
-$ kpt fn eval --image gcr.io/kpt-fn/apply-setters:v0.2.0 --fn-config ./apply-setters-fn-config
+$ kpt fn eval --image ghcr.io/kptdev/krm-functions-catalog/apply-setters:v0.2 --fn-config ./apply-setters-fn-config
 ```
 
 Modified resource looks like the following:
@@ -205,4 +200,4 @@ environments: # kpt-set: ${env}
 
 #### Note:
 
-Refer to the `create-setters` function documentation for information about creating setters.
+Refer to the [`create-setters`]({{< relref "function-catalog/create-setters/v0.1/" >}}) function documentation for information about creating setters.

documentation/content/en/function-catalog/create-setters/v0.1/_index.md

@@ -4,14 +4,12 @@ linkTitle: "create-setters"
 tags: "mutator"
 weight: 4
 description: |
-   Parameterize the field values by adding [setter] comments.
+   Parameterize the field values by adding `setter` comments.
 menu:
   main:
     parent: "Function Catalog"
 ---
 
-# create-setters
-
 {{< listversions >}}
 
 {{< listexamples >}}
@@ -50,14 +48,11 @@ data:
    - For an array node, checks if all values match with any of the array setters.
 4. Adds comments to the fields matching the setter values using setter names as parameters.
 
->? If this function adds setter comments to the fields for which you didn't intend to parameterize,
+> If this function adds setter comments to the fields for which you didn't intend to parameterize,
 you can simply review and delete/modify those comments manually.
 
 <!--mdtogo-->
 
-?> If this function adds setter comments to fields for which you didn't intend 
-to parameterize, you can simply review and delete/modify those comments manually.
-
 ### Examples
 
 <!--mdtogo:Examples-->
@@ -106,13 +101,13 @@ data:
 Invoke the function:
 
 ```shell
-$ kpt fn eval --image gcr.io/kpt-fn/create-setters:v0.1.0 --fn-config ./create-setters-fn-config.yaml
+$ kpt fn eval --image ghcr.io/kptdev/krm-functions-catalog/create-setters:v0.1 --fn-config ./create-setters-fn-config.yaml
 ```
 
 Alternatively, setter values can be passed as key-value pairs in the CLI
 
 ```shell
-$ kpt fn eval --image gcr.io/kpt-fn/create-setters:v0.1.0 -- replicas=4 tag=1.1.2
+$ kpt fn eval --image ghcr.io/kptdev/krm-functions-catalog/create-setters:v0.1 -- replicas=4 tag=1.1.2
 ```
 
 Modified resource looks like the following:
@@ -141,7 +136,7 @@ spec:
              containerPort: 80
 ```
 
->? This function doesn't add comments to scalar nodes with multi-line values.
+> This function doesn't add comments to scalar nodes with multi-line values.
 
 Explanation for the changes:
 
@@ -187,7 +182,7 @@ data:
 ```
 
 ```shell
-$ kpt fn eval --image gcr.io/kpt-fn/create-setters:v0.1.0 --fn-config ./create-setters-fn-config.yaml
+$ kpt fn eval --image ghcr.io/kptdev/krm-functions-catalog/create-setters:v0.1 --fn-config ./create-setters-fn-config.yaml
 ```
 
 Modified resource looks like the following:
@@ -208,4 +203,4 @@ Explanation for the changes:
 Here, the comment is added to the `environments` field as it is an array node, and the intent is to paremeterize entire array.
 <!--mdtogo-->
 
-[setter]: https://catalog.kpt.dev/apply-setters/v0.1/?id=definitions
+[setter]: {{< relref "function-catalog/apply-setters/v0.2/#definitions" >}}