From 44394a8ebc0edada9a6448298d3f037aae1f63c0 Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Thu, 23 Sep 2021 14:42:04 -0400 Subject: [PATCH 1/2] added more assemblies to include more content on devfile registries --- docs/modules/user-guide/nav.adoc | 4 ++++ .../user-guide/pages/devfile-registry.adoc | 2 +- .../partials/assembly_devfile-registry.adoc | 21 +++++++++++++++++++ .../partials/con_devfile-registry.adoc | 2 +- 4 files changed, 27 insertions(+), 2 deletions(-) create mode 100644 docs/modules/user-guide/partials/assembly_devfile-registry.adoc diff --git a/docs/modules/user-guide/nav.adoc b/docs/modules/user-guide/nav.adoc index 05318a2b..b02b547a 100644 --- a/docs/modules/user-guide/nav.adoc +++ b/docs/modules/user-guide/nav.adoc @@ -31,6 +31,10 @@ * Registry Administrator ** xref:devfile-registry.adoc[] +*** xref:con_devfile-registry.adoc[] +*** xref:assembly_building-custom-devfile-registry.adoc[] +*** xref:assembly_deploying-devfile-registry.adoc[] +*** xref:assembly_registry-schema.adoc[] * xref:api-reference.adoc[] * xref:devfile-resources.adoc[] diff --git a/docs/modules/user-guide/pages/devfile-registry.adoc b/docs/modules/user-guide/pages/devfile-registry.adoc index 3352c82e..a32e4540 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$con_devfile-registry.adoc[] +include::partial$assembly_devfile-registry.adoc[] diff --git a/docs/modules/user-guide/partials/assembly_devfile-registry.adoc b/docs/modules/user-guide/partials/assembly_devfile-registry.adoc new file mode 100644 index 00000000..7bb6222f --- /dev/null +++ b/docs/modules/user-guide/partials/assembly_devfile-registry.adoc @@ -0,0 +1,21 @@ +ifdef::context[:parent-context-of-assembly_devfile-registry: {context}] + + +ifndef::context[] +[id="assembly_devfile-registry"] +endif::[] +ifdef::context[] +[id="assembly_devfile-registry_{context}"] +endif::[] += Devfile Registry + +:context: assembly_devfile-registry + + +[role="_abstract"] +Get started with devfile registries: + +* xref:con_devfile-registry.adoc[] +* xref:assembly_building-custom-devfile-registry.adoc[] +* xref:assembly_deploying-devfile-registry.adoc[] +* xref:assembly_registry-schema.adoc[] diff --git a/docs/modules/user-guide/partials/con_devfile-registry.adoc b/docs/modules/user-guide/partials/con_devfile-registry.adoc index 1392b10b..c057271f 100644 --- a/docs/modules/user-guide/partials/con_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/con_devfile-registry.adoc @@ -1,5 +1,5 @@ [id="devfile-registry_{context}"] -= Devfile registry += Overview of 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. From bcf189acd760811a745cadb2ebeb605920a44a3c Mon Sep 17 00:00:00 2001 From: jc-berger <> Date: Fri, 24 Sep 2021 10:20:44 -0400 Subject: [PATCH 2/2] changed file names --- docs/modules/user-guide/nav.adoc | 8 ++++---- docs/modules/user-guide/pages/devfile-registry.adoc | 6 ------ .../user-guide/pages/overview-devfile-registry.adoc | 6 ++++++ .../user-guide/partials/assembly_devfile-registry.adoc | 8 ++++---- .../modules/user-guide/partials/con_devfile-registry.adoc | 4 ++-- 5 files changed, 16 insertions(+), 16 deletions(-) delete mode 100644 docs/modules/user-guide/pages/devfile-registry.adoc create mode 100644 docs/modules/user-guide/pages/overview-devfile-registry.adoc diff --git a/docs/modules/user-guide/nav.adoc b/docs/modules/user-guide/nav.adoc index b02b547a..5f15cdd5 100644 --- a/docs/modules/user-guide/nav.adoc +++ b/docs/modules/user-guide/nav.adoc @@ -31,10 +31,10 @@ * Registry Administrator ** xref:devfile-registry.adoc[] -*** xref:con_devfile-registry.adoc[] -*** xref:assembly_building-custom-devfile-registry.adoc[] -*** xref:assembly_deploying-devfile-registry.adoc[] -*** xref:assembly_registry-schema.adoc[] +*** xref:overview-devfile-registry.adoc[] +*** xref:building-custom-devfile-registry.adoc[] +*** xref:deploying-devfile-registry.adoc[] +*** xref:registry-schema.adoc[] * xref:api-reference.adoc[] * xref:devfile-resources.adoc[] diff --git a/docs/modules/user-guide/pages/devfile-registry.adoc b/docs/modules/user-guide/pages/devfile-registry.adoc deleted file mode 100644 index a32e4540..00000000 --- a/docs/modules/user-guide/pages/devfile-registry.adoc +++ /dev/null @@ -1,6 +0,0 @@ -:description: Devfile Registry -:navtitle: Devfile registry -:keywords: devfile -// :page-aliases: - -include::partial$assembly_devfile-registry.adoc[] diff --git a/docs/modules/user-guide/pages/overview-devfile-registry.adoc b/docs/modules/user-guide/pages/overview-devfile-registry.adoc new file mode 100644 index 00000000..ee745cb6 --- /dev/null +++ b/docs/modules/user-guide/pages/overview-devfile-registry.adoc @@ -0,0 +1,6 @@ +:description: Devfile Registry +:navtitle: Devfile registry overview +:keywords: devfile +// :page-aliases: + +include::partial$con_devfile-registry.adoc[] diff --git a/docs/modules/user-guide/partials/assembly_devfile-registry.adoc b/docs/modules/user-guide/partials/assembly_devfile-registry.adoc index 7bb6222f..1222f7b2 100644 --- a/docs/modules/user-guide/partials/assembly_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/assembly_devfile-registry.adoc @@ -15,7 +15,7 @@ endif::[] [role="_abstract"] Get started with devfile registries: -* xref:con_devfile-registry.adoc[] -* xref:assembly_building-custom-devfile-registry.adoc[] -* xref:assembly_deploying-devfile-registry.adoc[] -* xref:assembly_registry-schema.adoc[] +* xref:overview-devfile-registry.adoc[] +* xref:building-custom-devfile-registry.adoc[] +* xref:deploying-devfile-registry.adoc[] +* xref:registry-schema.adoc[] diff --git a/docs/modules/user-guide/partials/con_devfile-registry.adoc b/docs/modules/user-guide/partials/con_devfile-registry.adoc index c057271f..348096cd 100644 --- a/docs/modules/user-guide/partials/con_devfile-registry.adoc +++ b/docs/modules/user-guide/partials/con_devfile-registry.adoc @@ -1,4 +1,4 @@ -[id="devfile-registry_{context}"] +[id="overview-devfile-registry_{context}"] = Overview of devfile registry [role="_abstract"] @@ -45,4 +45,4 @@ The on-cluster devfile registries can be configured with custom devfile stacks s == Additional resources -* xref:authoring-stacks.adoc[]. +* xref:building-custom-devfile-registry.adoc[].