From 920e3c64d75abebcbef3014ba6c055dd8f52358c Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Wed, 2 Jun 2021 14:35:34 -0400 Subject: [PATCH 01/20] added devfile registry docs --- docs/modules/user-guide/nav.adoc | 1 + .../user-guide/pages/devfile-registry.adoc | 6 +++ .../partials/proc_devfile-registry.adoc | 50 +++++++++++++++++++ 3 files changed, 57 insertions(+) create mode 100644 docs/modules/user-guide/pages/devfile-registry.adoc create mode 100644 docs/modules/user-guide/partials/proc_devfile-registry.adoc diff --git a/docs/modules/user-guide/nav.adoc b/docs/modules/user-guide/nav.adoc index 3452be05..03c6cbf3 100644 --- a/docs/modules/user-guide/nav.adoc +++ b/docs/modules/user-guide/nav.adoc @@ -1,4 +1,5 @@ * xref:index.adoc[] +* xref:devfile-registry.adoc[] * xref:authoring-stacks.adoc[] ** xref:adding-schema-version-to-a-devfile.adoc[] diff --git a/docs/modules/user-guide/pages/devfile-registry.adoc b/docs/modules/user-guide/pages/devfile-registry.adoc new file mode 100644 index 00000000..1af9ad4b --- /dev/null +++ b/docs/modules/user-guide/pages/devfile-registry.adoc @@ -0,0 +1,6 @@ +:description: Devfile Registry +:navtitle: devfile-registry +:keywords: devfile +// :page-aliases: + +include::partial$proc_devfile-registry.adoc[] diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc new file mode 100644 index 00000000..f00e6436 --- /dev/null +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -0,0 +1,50 @@ +[id="proc_devfile-registry_{context}"] += Devfile registry + +[role="_abstract"] +A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che and the OpenShift Developer Console. Therefore, users can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification, and devfile stacks are stored as OCI-artifacts in the registry. + +Each devfile stack corresponds to a specific runtime or framework, such as, NodeJS, Quarkus, and Wildfly. A devfile stack also contains resources, such as, a devfile.yaml, logo, and outerloop resources. These devfile stacks give users a template so they can get started developing with devfiles. For more information on the structure of a devfile registry, see https://github.com/johnmcollier/registry-docs/blob/main/registry-structure.adoc[registry-structure]. + +== Devfile registry components + +A devfile registry is composed of two components, a devfile index server and an OCI registry server. + +.Devfile index server + +The server, and the resulting container image, does the following: + +* Uses the index.json file to obtain metadata about the stacks and samples and hosts this metadata in the registry for tools to consume +* Bootstraps the OCI registry with the devfile stacks +* Provides an API to interact with the OCI registry and to retrieve devfile stacks + +For more information on the index server, see https://github.com/johnmcollier/registry-docs/blob/main/registry-REST-API.adoc[registry-REST-API]. + +.OCI registry + +The devfile stacks in a devfile registry are stored in an OCI-compatible artifact registry, currently based on the https://github.com/distribution/distribution[reference implementation of an OCI registry]. + +When a devfile registry is deployed, the stacks belonging to the devfile registry are pushed to the OCI registry as multi-layer artifacts. For more information on the structure of the devfile stacks within the OCI registry, see https://github.com/johnmcollier/registry-docs/blob/main/registry-structure.adoc[registry-structure]. + +== Types of devfile registries + +Users can use multiple types of devfile registries to access devfile stacks and tools. + +.Public community registry + +The public community registry provides stacks for various community tools to consume. Examples include: https://registry.devfile.io/devfiles/nodejs[NodeJS], https://registry.devfile.io/devfiles/java-quarkus[Quarkus], and https://registry.devfile.io/devfiles/java-openliberty[Open Liberty]. + +Locate the source repository for the stacks in the public community registry at the https://github.com/devfile/registry[devfile/registry repository]. + +.On-cluster devfile registry + +Private, on-cluster devfile registries can be configured on a user's own Kubernetes cluster, deployed using either the https://github.com/devfile/registry-operator[devfile registry operator] or the https://github.com/devfile/registry-support/tree/master/deploy/chart/devfile-registry[devfile registry helm chart]. + +The on-cluster devfile registries can be configured with custom devfile stacks suited to users' needs for their organization. + +== Additional resources + +After understanding the basics of a devfile registry, start working with a devfile registry by going to: + +* https://github.com/johnmcollier/registry-docs/blob/main/setting-up-registry.adoc[Setting up registry] +* https://github.com/johnmcollier/registry-docs/blob/main/deploy-registry.adoc[Deploying registry] From 6d138be454affd567666e9afd3ec129edd79f2d7 Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Mon, 7 Jun 2021 15:44:28 -0400 Subject: [PATCH 02/20] applied minor changes from SME review --- .../partials/proc_devfile-registry.adoc | 23 ++++++++----------- 1 file changed, 9 insertions(+), 14 deletions(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index f00e6436..2967305c 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -4,27 +4,25 @@ [role="_abstract"] A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che and the OpenShift Developer Console. Therefore, users can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification, and devfile stacks are stored as OCI-artifacts in the registry. -Each devfile stack corresponds to a specific runtime or framework, such as, NodeJS, Quarkus, and Wildfly. A devfile stack also contains resources, such as, a devfile.yaml, logo, and outerloop resources. These devfile stacks give users a template so they can get started developing with devfiles. For more information on the structure of a devfile registry, see https://github.com/johnmcollier/registry-docs/blob/main/registry-structure.adoc[registry-structure]. +Each devfile stack corresponds to a specific runtime or framework, such as, NodeJS, Quarkus, and Wildfly. A devfile stack also contains resources, such as, a devfile.yaml, logo, and outerloop resources. These devfile stacks give users a template so they can get started developing cloud-native applications. == Devfile registry components A devfile registry is composed of two components, a devfile index server and an OCI registry server. -.Devfile index server +.Devfile index container -The server, and the resulting container image, does the following: +The devfile index container image does the following: * Uses the index.json file to obtain metadata about the stacks and samples and hosts this metadata in the registry for tools to consume * Bootstraps the OCI registry with the devfile stacks * Provides an API to interact with the OCI registry and to retrieve devfile stacks -For more information on the index server, see https://github.com/johnmcollier/registry-docs/blob/main/registry-REST-API.adoc[registry-REST-API]. - .OCI registry -The devfile stacks in a devfile registry are stored in an OCI-compatible artifact registry, currently based on the https://github.com/distribution/distribution[reference implementation of an OCI registry]. +The devfile stacks in a devfile registry are stored in an OCI-compatible artifact registry, currently based on the reference implementation of an OCI registry. -When a devfile registry is deployed, the stacks belonging to the devfile registry are pushed to the OCI registry as multi-layer artifacts. For more information on the structure of the devfile stacks within the OCI registry, see https://github.com/johnmcollier/registry-docs/blob/main/registry-structure.adoc[registry-structure]. +When a devfile registry is deployed, the stacks belonging to the devfile registry are pushed to the OCI registry as multi-layer artifacts. == Types of devfile registries @@ -32,19 +30,16 @@ Users can use multiple types of devfile registries to access devfile stacks and .Public community registry -The public community registry provides stacks for various community tools to consume. Examples include: https://registry.devfile.io/devfiles/nodejs[NodeJS], https://registry.devfile.io/devfiles/java-quarkus[Quarkus], and https://registry.devfile.io/devfiles/java-openliberty[Open Liberty]. +The public community registry provides stacks for various community tools to consume. Examples include: NodeJS, Quarkus, and Open Liberty. -Locate the source repository for the stacks in the public community registry at the https://github.com/devfile/registry[devfile/registry repository]. +Locate the source repository for the stacks in the public community registry at the devfile/registry repository. .On-cluster devfile registry -Private, on-cluster devfile registries can be configured on a user's own Kubernetes cluster, deployed using either the https://github.com/devfile/registry-operator[devfile registry operator] or the https://github.com/devfile/registry-support/tree/master/deploy/chart/devfile-registry[devfile registry helm chart]. +Private, on-cluster devfile registries can be configured on a user's own Kubernetes cluster, deployed using either the devfile registry operator or the devfile registry helm chart. The on-cluster devfile registries can be configured with custom devfile stacks suited to users' needs for their organization. == Additional resources -After understanding the basics of a devfile registry, start working with a devfile registry by going to: - -* https://github.com/johnmcollier/registry-docs/blob/main/setting-up-registry.adoc[Setting up registry] -* https://github.com/johnmcollier/registry-docs/blob/main/deploy-registry.adoc[Deploying registry] +After understanding the basics of a devfile registry, start working with a devfile registry by going to xref:authoring-stacks.adoc[]. From cbd974c12fb28d164a7efcf71156b96fb695d95f Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 7 Jun 2021 15:48:31 -0400 Subject: [PATCH 03/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc Co-authored-by: Rolfe Dlugy-Hegwer --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index 2967305c..bb9ce139 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -2,7 +2,7 @@ = Devfile registry [role="_abstract"] -A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che and the OpenShift Developer Console. Therefore, users can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification, and devfile stacks are stored as OCI-artifacts in the registry. +A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che, and the OpenShift Developer Console. Therefore, users can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification and devfile stacks are stored as OCI-artifacts in the registry. Each devfile stack corresponds to a specific runtime or framework, such as, NodeJS, Quarkus, and Wildfly. A devfile stack also contains resources, such as, a devfile.yaml, logo, and outerloop resources. These devfile stacks give users a template so they can get started developing cloud-native applications. From ed135f8024d8c7f509ad0cec619b75b0fa07e953 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 7 Jun 2021 15:49:29 -0400 Subject: [PATCH 04/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc Co-authored-by: Rolfe Dlugy-Hegwer --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index bb9ce139..538cb1b5 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -8,7 +8,7 @@ Each devfile stack corresponds to a specific runtime or framework, such as, Nod == Devfile registry components -A devfile registry is composed of two components, a devfile index server and an OCI registry server. +A devfile registry has two components: a devfile index server and an OCI registry server. .Devfile index container From 97db6e8c1104a56c10e2bbe0f47a107f530179bf Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 7 Jun 2021 15:50:58 -0400 Subject: [PATCH 05/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc Co-authored-by: Rolfe Dlugy-Hegwer --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index 538cb1b5..d30d92dc 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -15,8 +15,8 @@ A devfile registry has two components: a devfile index server and an OCI registr The devfile index container image does the following: * Uses the index.json file to obtain metadata about the stacks and samples and hosts this metadata in the registry for tools to consume -* Bootstraps the OCI registry with the devfile stacks -* Provides an API to interact with the OCI registry and to retrieve devfile stacks +* Bootstraps the OCI registry with the devfile stacks. +* Provides an API to interact with the OCI registry and to retrieve devfile stacks. .OCI registry From 7d9558a78c17fd8d8def7f253e9a0acecaadc403 Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Mon, 7 Jun 2021 16:02:59 -0400 Subject: [PATCH 06/20] addressed doc review --- .../partials/proc_devfile-registry.adoc | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index 2967305c..b8daa827 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -2,9 +2,9 @@ = Devfile registry [role="_abstract"] -A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che and the OpenShift Developer Console. Therefore, users can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification, and devfile stacks are stored as OCI-artifacts in the registry. +A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che and the OpenShift Developer Console. Therefore, you can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification, and devfile stacks are stored as OCI-artifacts in the registry. -Each devfile stack corresponds to a specific runtime or framework, such as, NodeJS, Quarkus, and Wildfly. A devfile stack also contains resources, such as, a devfile.yaml, logo, and outerloop resources. These devfile stacks give users a template so they can get started developing cloud-native applications. +Each devfile stack corresponds to a specific runtime or framework, such as, NodeJS, Quarkus, and Wildfly. A devfile stack also contains resources, such as, a devfile.yaml, logo, and outerloop resources. These devfile stacks give developers a template so they can get started developing cloud-native applications. == Devfile registry components @@ -12,7 +12,7 @@ A devfile registry is composed of two components, a devfile index server and an .Devfile index container -The devfile index container image does the following: +The devfile index container image does the following actions: * Uses the index.json file to obtain metadata about the stacks and samples and hosts this metadata in the registry for tools to consume * Bootstraps the OCI registry with the devfile stacks @@ -20,13 +20,13 @@ The devfile index container image does the following: .OCI registry -The devfile stacks in a devfile registry are stored in an OCI-compatible artifact registry, currently based on the reference implementation of an OCI registry. +The devfile stacks in a devfile registry are stored in an OCI-compatible artifact registry. The artifact registry is based on the reference implementation of an OCI registry. When a devfile registry is deployed, the stacks belonging to the devfile registry are pushed to the OCI registry as multi-layer artifacts. == Types of devfile registries -Users can use multiple types of devfile registries to access devfile stacks and tools. +As a developer, you can use multiple types of devfile registries to access devfile stacks and tools. .Public community registry @@ -36,10 +36,10 @@ Locate the source repository for the stacks in the public community registry at .On-cluster devfile registry -Private, on-cluster devfile registries can be configured on a user's own Kubernetes cluster, deployed using either the devfile registry operator or the devfile registry helm chart. +Private, on-cluster devfile registries can be configured on your own Kubernetes cluster, deployed using either the devfile registry operator or the devfile registry helm chart. -The on-cluster devfile registries can be configured with custom devfile stacks suited to users' needs for their organization. +The on-cluster devfile registries can be configured with custom devfile stacks suited to your needs for your organization. == Additional resources -After understanding the basics of a devfile registry, start working with a devfile registry by going to xref:authoring-stacks.adoc[]. +After understanding the basics of a devfile registry, start working with a devfile registry by going to xref:authoring-stacks.adoc[]. From 002a434ea29a8d0d7d1f160a35cfbc0a405bdb7c Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Mon, 7 Jun 2021 16:20:18 -0400 Subject: [PATCH 07/20] removed HEAD message --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index b0cdc9d5..dacbe96f 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -2,11 +2,7 @@ = Devfile registry [role="_abstract"] -<<<<<<< HEAD A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che and the OpenShift Developer Console. Therefore, you can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification, and devfile stacks are stored as OCI-artifacts in the registry. -======= -A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che, and the OpenShift Developer Console. Therefore, users can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification and devfile stacks are stored as OCI-artifacts in the registry. ->>>>>>> origin/jcberger_191_devfileregistry Each devfile stack corresponds to a specific runtime or framework, such as, NodeJS, Quarkus, and Wildfly. A devfile stack also contains resources, such as, a devfile.yaml, logo, and outerloop resources. These devfile stacks give developers a template so they can get started developing cloud-native applications. @@ -18,7 +14,7 @@ A devfile registry has two components: a devfile index server and an OCI registr The devfile index container image does the following actions: -* Uses the index.json file to obtain metadata about the stacks and samples and hosts this metadata in the registry for tools to consume +* Uses the index.json file to obtain metadata about the stacks and samples and hosts this metadata in the registry for tools to consume. * Bootstraps the OCI registry with the devfile stacks. * Provides an API to interact with the OCI registry and to retrieve devfile stacks. From a6449a17088816122cb47b93401eabd8f3deeaee Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Tue, 8 Jun 2021 11:27:39 -0400 Subject: [PATCH 08/20] minor grammatical and language changes --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index dacbe96f..fc25c3dd 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -2,7 +2,7 @@ = Devfile registry [role="_abstract"] -A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che and the OpenShift Developer Console. Therefore, you can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification, and devfile stacks are stored as OCI-artifacts in the registry. +A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che, and the OpenShift Developer Console. Therefore, you can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification, and devfile stacks are stored as OCI-artifacts in the registry. Each devfile stack corresponds to a specific runtime or framework, such as, NodeJS, Quarkus, and Wildfly. A devfile stack also contains resources, such as, a devfile.yaml, logo, and outerloop resources. These devfile stacks give developers a template so they can get started developing cloud-native applications. @@ -30,7 +30,7 @@ As a developer, you can use multiple types of devfile registries to access devfi .Public community registry -The public community registry provides stacks for various community tools to consume. Examples include: NodeJS, Quarkus, and Open Liberty. +The public community registry provides stacks for various community tools to consume, such as NodeJS, Quarkus, and Open Liberty. Locate the source repository for the stacks in the public community registry at the devfile/registry repository. From fb4ae8ea122d1e6b956785ad545b48fafe0218c9 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Tue, 8 Jun 2021 12:34:38 -0400 Subject: [PATCH 09/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc Co-authored-by: Rolfe Dlugy-Hegwer --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index fc25c3dd..67ffde0e 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -4,7 +4,7 @@ [role="_abstract"] A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che, and the OpenShift Developer Console. Therefore, you can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification, and devfile stacks are stored as OCI-artifacts in the registry. -Each devfile stack corresponds to a specific runtime or framework, such as, NodeJS, Quarkus, and Wildfly. A devfile stack also contains resources, such as, a devfile.yaml, logo, and outerloop resources. These devfile stacks give developers a template so they can get started developing cloud-native applications. +Each devfile stack corresponds to a specific runtime or framework, such as NodeJS, Quarkus, or Wildfly. A devfile stack also contains resources like a `devfile.yaml` file, logo, and outerloop resources. These devfile stacks give developers a template to get started developing cloud-native applications. == Devfile registry components From ca74b1b62048875dbd3abdefd36c0666425c92e9 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 21 Jun 2021 12:57:54 -0400 Subject: [PATCH 10/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index 67ffde0e..30c8c60a 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -4,7 +4,7 @@ [role="_abstract"] A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che, and the OpenShift Developer Console. Therefore, you can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification, and devfile stacks are stored as OCI-artifacts in the registry. -Each devfile stack corresponds to a specific runtime or framework, such as NodeJS, Quarkus, or Wildfly. A devfile stack also contains resources like a `devfile.yaml` file, logo, and outerloop resources. These devfile stacks give developers a template to get started developing cloud-native applications. +Each devfile stack corresponds to a specific runtime or framework, such as Node.js, Quarkus, or WildFly. A devfile stack also contains resources like a `devfile.yaml` file, logo, and outerloop resources. These devfile stacks provide developers with templates to get started developing cloud-native applications. == Devfile registry components From 9556145f525d0396a46b1af04e6a9e423fc6914b Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 21 Jun 2021 12:58:29 -0400 Subject: [PATCH 11/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index 30c8c60a..45597a1f 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -1,4 +1,4 @@ -[id="proc_devfile-registry_{context}"] +[id="devfile-registry_{context}"] = Devfile registry [role="_abstract"] From a5014b2bf1787809401c43d951156599403db342 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 21 Jun 2021 12:58:41 -0400 Subject: [PATCH 12/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index 45597a1f..80b5ca45 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -8,7 +8,10 @@ Each devfile stack corresponds to a specific runtime or framework, such as Node. == Devfile registry components -A devfile registry has two components: a devfile index server and an OCI registry server. +A devfile registry has two components: + + * Devfile index server + * OCI registry server .Devfile index container From 631b767a9c5cdd301bd93e5b46d5a676ab775ce6 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 21 Jun 2021 12:58:56 -0400 Subject: [PATCH 13/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index 80b5ca45..44e8063a 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -17,7 +17,7 @@ A devfile registry has two components: The devfile index container image does the following actions: -* Uses the index.json file to obtain metadata about the stacks and samples and hosts this metadata in the registry for tools to consume. +* Uses the `index.json` file to obtain metadata about the stacks and samples and hosts this metadata in the registry for tools to consume. * Bootstraps the OCI registry with the devfile stacks. * Provides an API to interact with the OCI registry and to retrieve devfile stacks. From 9ee1362ef54f0854ab064dbbe64aae20ffef417c Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 21 Jun 2021 12:59:10 -0400 Subject: [PATCH 14/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index 44e8063a..510fc498 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -33,7 +33,7 @@ As a developer, you can use multiple types of devfile registries to access devfi .Public community registry -The public community registry provides stacks for various community tools to consume, such as NodeJS, Quarkus, and Open Liberty. +The public community registry provides stacks for various community tools to consume, such as Node.js, Quarkus, and Open Liberty. Locate the source repository for the stacks in the public community registry at the devfile/registry repository. From c62bdfc215d3fd0b5c11476ad0d86203cb5f83b6 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 21 Jun 2021 12:59:27 -0400 Subject: [PATCH 15/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index 510fc498..33b0d1fa 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -35,7 +35,7 @@ As a developer, you can use multiple types of devfile registries to access devfi The public community registry provides stacks for various community tools to consume, such as Node.js, Quarkus, and Open Liberty. -Locate the source repository for the stacks in the public community registry at the devfile/registry repository. +Locate the source for the stacks in the public community registry in the link:https://github.com/devfile/registry[devfile/registry repository]. .On-cluster devfile registry From 1b31579970a9d8ff7d087c9e1959eafe87532c99 Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 21 Jun 2021 12:59:41 -0400 Subject: [PATCH 16/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index 33b0d1fa..2528ef09 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -39,7 +39,7 @@ Locate the source for the stacks in the public community registry in the link:ht .On-cluster devfile registry -Private, on-cluster devfile registries can be configured on your own Kubernetes cluster, deployed using either the devfile registry operator or the devfile registry helm chart. +Devfile registries can be operated on private Kubernetes clusters, deployed using either the devfile registry Operator or the devfile registry Helm Chart. The on-cluster devfile registries can be configured with custom devfile stacks suited to your needs for your organization. From ac30434c4c2a5a388e09879aa8f4aac093602b1f Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 21 Jun 2021 13:00:21 -0400 Subject: [PATCH 17/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index 2528ef09..7ea9fa95 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -41,7 +41,7 @@ Locate the source for the stacks in the public community registry in the link:ht Devfile registries can be operated on private Kubernetes clusters, deployed using either the devfile registry Operator or the devfile registry Helm Chart. -The on-cluster devfile registries can be configured with custom devfile stacks suited to your needs for your organization. +The on-cluster devfile registries can be configured with custom devfile stacks suited to the needs of the owner organization. == Additional resources From b5c2e314cbd735d2c357b1f0fc25348a0d043e1c Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 21 Jun 2021 13:00:45 -0400 Subject: [PATCH 18/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index 7ea9fa95..526e33fe 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -45,4 +45,4 @@ The on-cluster devfile registries can be configured with custom devfile stacks s == Additional resources -After understanding the basics of a devfile registry, start working with a devfile registry by going to xref:authoring-stacks.adoc[]. +* xref:authoring-stacks.adoc[]. From 7346bbe430b71921422ab87d7214d617d588fe3a Mon Sep 17 00:00:00 2001 From: jc-berger <70717303+jc-berger@users.noreply.github.com> Date: Mon, 21 Jun 2021 13:00:55 -0400 Subject: [PATCH 19/20] Update docs/modules/user-guide/partials/proc_devfile-registry.adoc MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: Robert Krátký --- docs/modules/user-guide/partials/proc_devfile-registry.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/proc_devfile-registry.adoc index 526e33fe..5d8c5704 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/proc_devfile-registry.adoc @@ -29,7 +29,7 @@ When a devfile registry is deployed, the stacks belonging to the devfile registr == Types of devfile registries -As a developer, you can use multiple types of devfile registries to access devfile stacks and tools. +There are multiple types of devfile registries to access devfile stacks and tools. .Public community registry From a05c3a8533e0eebf62b525e8fc85c11081cc09c7 Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Mon, 21 Jun 2021 14:00:35 -0400 Subject: [PATCH 20/20] content tweaks and title changes --- docs/modules/user-guide/pages/devfile-registry.adoc | 2 +- .../{proc_devfile-registry.adoc => con_devfile-registry.adoc} | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) rename docs/modules/user-guide/partials/{proc_devfile-registry.adoc => con_devfile-registry.adoc} (86%) diff --git a/docs/modules/user-guide/pages/devfile-registry.adoc b/docs/modules/user-guide/pages/devfile-registry.adoc index 1af9ad4b..26f9c071 100644 --- a/docs/modules/user-guide/pages/devfile-registry.adoc +++ b/docs/modules/user-guide/pages/devfile-registry.adoc @@ -3,4 +3,4 @@ :keywords: devfile // :page-aliases: -include::partial$proc_devfile-registry.adoc[] +include::partial$con_devfile-registry.adoc[] diff --git a/docs/modules/user-guide/partials/proc_devfile-registry.adoc b/docs/modules/user-guide/partials/con_devfile-registry.adoc similarity index 86% rename from docs/modules/user-guide/partials/proc_devfile-registry.adoc rename to docs/modules/user-guide/partials/con_devfile-registry.adoc index 5d8c5704..1392b10b 100644 --- a/docs/modules/user-guide/partials/proc_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/con_devfile-registry.adoc @@ -4,7 +4,7 @@ [role="_abstract"] A devfile registry is a service that stores and provides devfile stacks to Kubernetes developer tools like odo, Eclipse Che, and the OpenShift Developer Console. Therefore, you can access devfiles through the devfile registry. Devfile registries are based on the Oracle Cloud Infrastructure (OCI) Specification, and devfile stacks are stored as OCI-artifacts in the registry. -Each devfile stack corresponds to a specific runtime or framework, such as Node.js, Quarkus, or WildFly. A devfile stack also contains resources like a `devfile.yaml` file, logo, and outerloop resources. These devfile stacks provide developers with templates to get started developing cloud-native applications. +Each devfile stack corresponds to a specific runtime or framework, such as Node.js, Quarkus, or WildFly. A devfile stack also contains resources like a `devfile.yaml` file, logo, and outer loop resources. Outer loop runs on containers and entails code reviews and integration tests, typically automated by continuous integration/continuous delivery (CI/CD) pipelines. These devfile stacks provide developers with templates to get started developing cloud-native applications. == Devfile registry components