DevTools Week 09/22: Docs Update - Devfile Registry (#36)

* building-a-custom-devfile-registry.md doc revisions:

- golang version updated
- air gap environment manual added as additional resource

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* creating-a-devfile-stack.md doc revision: Step 2 expanded.

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* deploying-a-devfile-registry.md doc revision: Deploying the devfile registry on Kubernetes cluster formatting fixed.

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* installation-of-in-cluster-offline-devfile-registry.md doc revisions:

- Modify devfile verification step heading fixed
- Colon at the end of modify devfile overview paragraph replace with period

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* adding-a-registry-schema.md revisions: example headers fixed.

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* golang versions revised.

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* revised Dockerfile under building custom registry guide.

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

* replace outdated doc link tags with standard markdown links.

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

---------

Signed-off-by: Michael Valdron <mvaldron@redhat.com>

Author: michael-valdron

libs/docs/src/docs/no-version/adding-a-registry-schema.md

@@ -94,7 +94,7 @@ To add samples and stacks from other repositories, place the
 - The architectures associated to the stack version.
 {% /table %}
 
-```yaml {% title="extraDevfileEntries.yaml sample" filename="devfile.yaml" %}
+```yaml {% title="extraDevfileEntries.yaml sample" filename="extraDevfileEntries.yaml" %}
 schemaVersion: <version>
 samples:
   - name: nodejs-basic
@@ -261,7 +261,7 @@ information such as name, language, and resources.
 - The project templates that can be used in a devfile.
 {% /table %}
 
-```json {% title="Index.json sample" %}
+```json {% title="Index.json sample" filename="index.json" %}
 [
   {
     "name": "go",

libs/docs/src/docs/no-version/building-a-custom-devfile-registry.md

@@ -61,7 +61,7 @@ your cloud or cluster to form the devfile registry.
 
 ### Prerequisites
 
-- Golang 1.13.x or higher
+- Golang 1.18.x or higher
 
 - Docker 17.05 or higher
 
@@ -77,14 +77,19 @@ your cloud or cluster to form the devfile registry.
     following:
 
     ```docker {% filename="Dockerfile" %}
-    FROM quay.io/openshift-pipeline/golang:1.15-alpine AS builder
-    # Install dependencies
-    RUN apk add --no-cache git bash
+    FROM registry.access.redhat.com/ubi8/go-toolset:1.18 AS builder
+    # Run tasks as root
+    USER root
+    # Install yq
+    RUN curl -sL -O https://github.com/mikefarah/yq/releases/download/v4.9.5/yq_linux_amd64 -o /usr/local/bin/yq && mv ./yq_linux_amd64 /usr/local/bin/yq && chmod +x /usr/local/bin/yq
+    # Copy registry contents
     COPY . /registry
     # Download the registry build tools
     RUN git clone https://github.com/devfile/registry-support.git /registry-support
     # Run the registry build tools
     RUN /registry-support/build-tools/build.sh /registry /build
+    # Reset user as non-root
+    USER 1001
     FROM quay.io/devfile/devfile-index-base:next
     COPY --from=builder /build/index.json /index.json
     COPY --from=builder /build/stacks /stacks
@@ -147,3 +152,4 @@ build, run, and deploy your application.
 ### Additional resources
 
 - For information on deploying the devfile index container image, see [deploying a devfile registry](./deploying-a-devfile-registry).
+- For information on deploying to air-gapped environment, see [installation of in-cluster offline devfile registry](./installation-of-in-cluster-offline-devfile-registry).

libs/docs/src/docs/no-version/creating-a-devfile-stack.md

@@ -12,7 +12,7 @@ various projects.
 1. Create a fork of the [devfile-registry repo](https://github.com/devfile/registry), clone
 your fork locally and go to its directory.
 
-2. Create a stack folder with a name that matches the stack name. For
+2. Within the stacks directory `registry/stacks/`, create a stack folder with a name that matches the stack name. For
     example, `tutorial-stack/`.
 
 3. Create version directories for storing different stack versions.

libs/docs/src/docs/no-version/deploying-a-devfile-registry.md

@@ -69,10 +69,10 @@ devfile registry.
             name: devfile-registry
         spec:
             devfileIndexImage: quay.io/devfile/devfile-index:next
-                tls:
-            enabled: false
+            tls:
+                enabled: false
             k8s:
-            ingressDomain: $INGRESS_DOMAIN
+                ingressDomain: $INGRESS_DOMAIN
         EOF
         ```
 

libs/docs/src/docs/no-version/installation-of-in-cluster-offline-devfile-registry.md

@@ -29,7 +29,7 @@ The main goal of this stage is:
 
 ### Prerequisites
 
-- Golang 1.17.x or higher
+- Golang 1.18.x or higher
 
 - Docker 17.05 or higher or Podman 4.0.x or higher
 
@@ -126,7 +126,7 @@ suffix `-offline` to be pulled into the registry.
 Change the devfile so you can update references to those offline
 resources as part of the registry build. For all the items pulled into
 the registry, update the corresponding devfile entries to reference the
-resources within the offline version in the registry:
+resources within the offline version in the registry.
 
 {% callout title="Note!" %}
 - All location references to `starterProjects` will change to local
@@ -162,7 +162,7 @@ resources within the offline version in the registry:
       under the stack root directory
       (`<registry_root>/stacks/<stack>/`).
 
-### Verification step
+#### Verification step
 
 To confirm you modified your devfile, verify your altered starter
 project definition is similar to the following example: