reorganizing docs navigation for 2.2.0 and 2.2.1 (#86)

Signed-off-by: Michael Hoang <[email protected]>

Author: mike-hoang

apps/registry-viewer/navigation.ts

@@ -45,6 +45,7 @@ export const footerNavigation: FooterNavigation = {
     { name: 'Cloud Native Computing Foundation', href: 'https://www.cncf.io' },
     { name: 'Registry', href: '/' },
     { name: 'Documentation', href: `https://devfile.io/docs/${defaultVersion}/what-is-a-devfile` },
+    { name: 'Community', href: `https://devfile.io/docs/${defaultVersion}/community` },
   ],
   social: [
     {

libs/docs/src/docs/2.2.0/adding-a-container-component.md

@@ -121,12 +121,12 @@ configuration of a container in a workspace using the `container` component type
     `infinity` argument depend on the base image used in the particular
     images.
 
-    All tools will respect the specified `command`. When `command` 
-    is not defined, the container will use the default from the 
-    image specified. When `command` is defined, it will override 
-    the one present in the image as intended. Either the 
-    `command` defined by the image or by the container component 
-    within the devfile must be non-terminating, such as the case 
+    All tools will respect the specified `command`. When `command`
+    is not defined, the container will use the default from the
+    image specified. When `command` is defined, it will override
+    the one present in the image as intended. Either the
+    `command` defined by the image or by the container component
+    within the devfile must be non-terminating, such as the case
     of setting `command` to `sleep` with the `infinity` argument.
 
     ```yaml {% filename="devfile.yaml" %}

libs/docs/src/docs/2.2.0/authoring-overview.md

@@ -0,0 +1,35 @@
+---
+title: Overview
+description: Authoring devfile - Overview
+---
+
+## Creating a minimal devfile
+
+The `schemaVersion` attribute is mandatory in a devfile.
+
+### Procedure
+
+- Define the `schemaVersion` attribute in the devfile and specify a static name for the workspace with the `name` attribute.
+
+    ```yaml {% title="Minimal devfile with schema version and name" filename="devfile.yaml" %}
+    schemaVersion: <version>
+    metadata:
+      name: devfile-sample
+      version: 0.0.1
+    ```
+
+## Adding to a minimal devfile
+
+See the following documents to help you add to the minimal devfile to suit your development needs:
+
+- [Adding projects](./adding-projects)
+
+- [Adding components](./adding-components)
+
+- [Adding commands](./adding-commands)
+
+- [Defining variables](./defining-variables)
+
+- [Defining attributes](./defining-attributes)
+
+- [Referring to a parent devfile in a devfile](./referring-to-a-parent-devfile)

…/2.2.0/create-devfiles-with-templates.md …s/docs/src/docs/2.2.0/create-devfiles.mdlibs/docs/src/docs/2.2.0/create-devfiles-with-templates.md renamed to libs/docs/src/docs/2.2.0/create-devfiles.md libs/docs/src/docs/2.2.0/create-devfiles-with-templates.md renamed to libs/docs/src/docs/2.2.0/create-devfiles.md

@@ -1,6 +1,6 @@
 ---
-title: Creating devfiles with templates
-description: Creating devfiles with templates
+title: Creating devfiles
+description: Creating devfiles
 ---
 
 Most dev tools can utilize the devfile registry to 
@@ -25,10 +25,10 @@ building sample templates for common use cases.
     - `metadata` is optional but it is recommended to have in your 
     templates
     ```yaml {% title="Minimal Devfile" filename="devfile.yaml" %}
-    schemaVersion: 2.2.0
+    schemaVersion: <version>
     ```
     ```yaml {% title="Minimal Devfile with Metadata" filename="devfile.yaml" %}
-    schemaVersion: 2.2.0
+    schemaVersion: <version>
     metadata:
       name: devfile-sample
       version: 2.0.0
@@ -46,7 +46,7 @@ building sample templates for common use cases.
         the template
         - For improved readability on devfile registries, set `displayName` to the title that will be the display text for this template and `icon` to tie a stack icon to the template:
         ```yaml
-          schemaVersion: 2.2.0
+          schemaVersion: <version>
           metadata:
             name: web-service
             version: 1.0.0
@@ -131,7 +131,7 @@ building sample templates for common use cases.
           ```
     5. Completing the content, the complete devfile should look like the following:
     ```yaml {% title="Complete Web Service Template" filename="devfile.yaml" %}
-    schemaVersion: 2.2.0
+    schemaVersion: <version>
     metadata:
       name: web-service
       version: 1.0.0

libs/docs/src/docs/2.2.0/defining-attributes.md

@@ -44,17 +44,17 @@ Attributes can be defined at the top level of the devfile, or in the following o
     ----
     ```
 
-2. Define a custom attribute in the `metadata` object.
+2. Define a custom attribute at the devfile level.
 
     When no editor is specified, a default editor is provided. To represent this user-defined example, use the `editorFree` attribute as shown in the following example:
 
     ```yaml {% title="A devfile without an editor" %}
     ----
     schemaVersion: 2.2.0
+    attributes:
+        editorFree: true
     metadata:
       name: petclinic-dev-environment
-      attributes:
-        editorFree: true
     components:
       - name: myapp
         kubernetes:

libs/docs/src/docs/2.2.0/innerloop-vs-outerloop.md

@@ -19,7 +19,7 @@ In a devfile spec, there are two scopes of deployment: innerloop and outerloop.
     - This example will use `nodejs-18` UBI image
 
     ```yaml
-    schemaVersion: 2.2.0
+    schemaVersion: <version>
     metadata:
       name: nodejs
     components:
@@ -119,7 +119,7 @@ In a devfile spec, there are two scopes of deployment: innerloop and outerloop.
     ```
 
 ```yaml {% title="Final innerloop devfile" filename="devfile.yaml" %}
-schemaVersion: 2.2.0
+schemaVersion: <version>
 metadata:
   name: nodejs
 components:
@@ -255,7 +255,7 @@ The component and commands here allow the developer to build, run, debug, and te
     ```
 
 ```yaml {% title="Final outerloop devfile" filename="devfile.yaml" %}
-schemaVersion: 2.2.0
+schemaVersion: <version>
 metadata:
   name: nodejs
 components:

libs/docs/src/docs/2.2.0/overriding-pod-and-container-attributes.md

@@ -14,7 +14,7 @@ This attribute can be defined at the component level.
 ### Procedure
 1. Specify "container-overrides" at the component level.
     ```yaml {% title="Specify container-overrides to override security context for container at component level" filename="devfile.yaml" %}
-    schemaVersion: 2.2.0
+    schemaVersion: <version>
     components:
       - name: maven
         attributes:
@@ -43,7 +43,7 @@ This attribute can be defined at the component and devfile attributes levels. If
 ### Procedure
 1. Specify "pod-overrides" at the component level.
     ```yaml {% title="Specify pod-overrides to override security context for container at component level" filename="devfile.yaml" %}
-    schemaVersion: 2.2.0
+    schemaVersion: <version>
     components:
       - name: maven
         attributes:
@@ -56,7 +56,7 @@ This attribute can be defined at the component and devfile attributes levels. If
 
 2. Specify "pod-overrides" at the devfile attributes level. It will be defined as a top-level attribute.
     ```yaml {% title="Specify pod-overrides to override resources for container at the devfile level" filename="devfile.yaml" %}
-    schemaVersion: 2.2.0
+    schemaVersion: <version>
     attributes:
       pod-overrides:
         spec:

libs/docs/src/docs/2.2.0/packaging-devfile.md

@@ -5,7 +5,7 @@ description: Packaging devfile
 
 ## Creating a devfile
 
-To create a devfile, you can [start from scratch](./create-devfiles-with-templates) or use the [public community devfile registry](https://registry.devfile.io/viewer) to find predefined stacks for popular languages and frameworks. Once you have a devfile, save it as `.devfile.yaml` to your application’s root directory.
+To create a devfile, you can [start from scratch](./create-devfiles) or use the [public community devfile registry](https://registry.devfile.io/viewer) to find predefined stacks for popular languages and frameworks. Once you have a devfile, save it as `.devfile.yaml` to your application’s root directory.
 
 ## Resources to include with your devfile
 

libs/docs/src/docs/2.2.1-alpha/authoring-overview.md

@@ -0,0 +1,35 @@
+---
+title: Overview
+description: Authoring devfile - Overview
+---
+
+## Creating a minimal devfile
+
+The `schemaVersion` attribute is mandatory in a devfile.
+
+### Procedure
+
+- Define the `schemaVersion` attribute in the devfile and specify a static name for the workspace with the `name` attribute.
+
+    ```yaml {% title="Minimal devfile with schema version and name" filename="devfile.yaml" %}
+    schemaVersion: <version>
+    metadata:
+      name: devfile-sample
+      version: 0.0.1
+    ```
+
+## Adding to a minimal devfile
+
+See the following documents to help you add to the minimal devfile to suit your development needs:
+
+- [Adding projects](./adding-projects)
+
+- [Adding components](./adding-components)
+
+- [Adding commands](./adding-commands)
+
+- [Defining variables](./defining-variables)
+
+- [Defining attributes](./defining-attributes)
+
+- [Referring to a parent devfile in a devfile](./referring-to-a-parent-devfile)

…-alpha/create-devfiles-with-templates.md …/src/docs/2.2.1-alpha/create-devfiles.mdlibs/docs/src/docs/2.2.1-alpha/create-devfiles-with-templates.md renamed to libs/docs/src/docs/2.2.1-alpha/create-devfiles.md libs/docs/src/docs/2.2.1-alpha/create-devfiles-with-templates.md renamed to libs/docs/src/docs/2.2.1-alpha/create-devfiles.md

@@ -1,6 +1,6 @@
 ---
-title: Creating devfiles with templates
-description: Creating devfiles with templates
+title: Creating devfiles
+description: Creating devfiles
 ---
 
 Most dev tools can utilize the devfile registry to 
@@ -25,10 +25,10 @@ building sample templates for common use cases.
     - `metadata` is optional but it is recommended to have in your 
     templates
     ```yaml {% title="Minimal Devfile" filename="devfile.yaml" %}
-    schemaVersion: 2.2.1
+    schemaVersion: <version>
     ```
     ```yaml {% title="Minimal Devfile with Metadata" filename="devfile.yaml" %}
-    schemaVersion: 2.2.1
+    schemaVersion: <version>
     metadata:
       name: devfile-sample
       version: 2.0.0
@@ -46,7 +46,7 @@ building sample templates for common use cases.
         the template
         - For improved readability on devfile registries, set `displayName` to the title that will be the display text for this template and `icon` to tie a stack icon to the template:
         ```yaml
-          schemaVersion: 2.2.1
+          schemaVersion: <version>
           metadata:
             name: web-service
             version: 1.0.0
@@ -131,7 +131,7 @@ building sample templates for common use cases.
           ```
     5. Completing the content, the complete devfile should look like the following:
     ```yaml {% title="Complete Web Service Template" filename="devfile.yaml" %}
-    schemaVersion: 2.2.1
+    schemaVersion: <version>
     metadata:
       name: web-service
       version: 1.0.0