Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move "Customizing the registries" to the Contributor guide #1633

Merged
merged 4 commits into from
Oct 9, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

6 changes: 0 additions & 6 deletions modules/administration-guide/nav.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@
** xref:che-workspace-controller.adoc[]
** xref:che-workspaces-architecture.adoc[]
* xref:calculating-che-resource-requirements.adoc[]
* xref:customizing-the-devfile-and-plug-in-registries.adoc[]
** xref:building-and-running-a-custom-registry-image.adoc[]
** xref:including-the-plug-in-binaries-in-the-registry-image.adoc[]
** xref:editing-a-devfile-and-plug-in-at-runtime.adoc[]
** xref:using-a-visual-studio-code-extension-in-che.adoc[]
** xref:testing-a-visual-studio-code-extension-in-che.adoc[]
* xref:retrieving-che-logs.adoc[]
** xref:viewing-kubernetes-events.adoc[]
** xref:viewing-operator-events.adoc[]
Expand Down

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,22 +1,3 @@
// building-and-running-a-custom-registry-image

[id="building-a-custom-devfile-registry_{context}"]
= Building a custom devfile registry

This section describes how to build a custom devfiles registry. Following operations are covered:

* Getting a copy of the source code necessary to build a devfiles registry.
* Adding a new devfile.
* Building the devfiles registry.

.Procedure

. Clone the devfile registry repository:
+
----
include::example${project-context}-clone-the-devfile-registry-repository.adoc[]
----

. In the `./che-devfile-registry/devfiles/` directory, create a subdirectory `__<devfile-name>__/` and add the `devfile.yaml` and `meta.yaml` files.
+
.File organization for a devfile
Expand Down Expand Up @@ -47,10 +28,4 @@ tags, List of tags. Tags usually include the tools included in the stack.
[source,yaml]
----
include::example${project-context}-devfile-meta.adoc[]
----

. Build the containers for the custom devfile registry:
+
----
include::example${project-context}-build-the-devfile-registry.adoc[]
----
----
Original file line number Diff line number Diff line change
@@ -1,23 +1,4 @@
// building-and-running-a-custom-registry-image

[id="building-a-custom-plug-in-registry_{context}"]
= Building a custom plug-in registry

This section describes how to build a custom plug-in registry. Following operations are covered:

* Getting a copy of the source code necessary to build a custom plug-in registry.
* Adding a new plug-in.
* Building the custom plug-in registry.

.Procedure

. Clone the plug-in registry repository:
+
----
include::example${project-context}-clone-the-plug-in-registry-repository.adoc[]
----

. In the `./che-plugin-registry/v3/plugins/` directory, create new directories `__<publisher>__/__<plugin-name>__/__<plugin-version>__/` and a `meta.yaml` file in the last directory.
. In the `./che-plugin-registry/v3/plugins/` directory, create new directories `__<publisher>__/__<plugin-name>__/__<plugin-version>__/` and a `meta.yaml` file in the last directory.
+
.File organization for a plugin
[subs="+quotes"]
Expand Down Expand Up @@ -56,9 +37,3 @@ $ cat che-plugin-registry/v3/plugins/redhat/java/latest.txt
----
====

. Build the containers for the custom plug-in registry:
+
[source,shell]
----
$ ./build.sh
----
6 changes: 5 additions & 1 deletion modules/contributor-guide/nav.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
.Contributor Guide

* xref:customizing-the-devfile-and-plug-in-registries.adoc[]
** xref:building-a-custom-devfile-registry.adoc[]
** xref:building-a-custom-plug-in-registry.adoc[]
** xref:running-custom-registries.adoc[]
** xref:testing-a-visual-studio-code-extension-in-che.adoc[]
* xref:branding-che-theia.adoc[]
* xref:developing-che-theia-plug-ins.adoc[]
* xref:testing-che-theia-plug-ins.adoc[]
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[id="building-and-running-a-custom-devfile-registry-image"]
// = Customizing the devfile registry
:navtitle: Building custom devfile registry
:keywords: contributor-guide, customizing-the-devfile-and-plug-in-registries, building-and-running-a-custom-devfile-registry-image
:page-aliases: .:building-and-running-a-custom-devfile-registry-image

:registry-mode: custom
:registry-mode-name: a custom
:registry-id: devfile
:registry-name: devfile

include::installation-guide:example$proc_{project-context}-building-a-registry-image.adoc[]

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[id="customizing-the-plug-in-registry"]
// = Customizing the plug-in registry
:navtitle: Building custom plug-in registry
:keywords: contributor-guide, customizing-the-plug-in-registry, including-the-plug-in-binaries-in-the-registry-image, building-and-running-a-custom-in-registry-image
:page-aliases: .:building-and-running-a-custom-plug-in-registry-image, administration-guide:including-the-plug-in-binaries-in-the-registry-image

:registry-mode: custom
:registry-mode-name: a custom
:registry-id: plugin
:registry-name: plug-in

include::installation-guide:example$proc_{project-context}-building-a-registry-image.adoc[]

Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[id="customizing-the-devfile-and-plug-in-registries"]
// = Customizing devfile and plug-in registries
:navtitle: Customizing the registries
:keywords: contributor-guide, customizing-the-devfile-and-plug-in-registries, including-the-plug-in-binaries-in-the-registry-image
:page-aliases: .:customizing-the-devfile-and-plug-in-registries, administration-guide:customizing-the-devfile-and-plug-in-registries, administration-guide:building-and-running-a-custom-registry-image

include::partial$assembly_customizing-the-registries.adoc[]
13 changes: 13 additions & 0 deletions modules/contributor-guide/pages/running-custom-registries.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
[id="running-custom-registries"]
// = Running custom registries
:navtitle: Running custom registries
:keywords: contributor-guide, running-custom-registries
:page-aliases: .:running-custom-registries,

:registry-mode: custom
:registry-mode-name: a custom
:registry-id: plugin
:registry-name: plug-in

include::partial$assembly_deploying-the-registries.adoc[]

Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[id="testing-a-visual-studio-code-extension-in-che"]
// = Testing a VS Code extension in Che
:navtitle: Testing a VS Code extension in Che
:keywords: administration-guide, testing-a-visual-studio-code-extension-in-che
:page-aliases: .:testing-a-visual-studio-code-extension-in-che
:keywords: contributor-guide, testing-a-visual-studio-code-extension-in-che
:page-aliases: .:testing-a-visual-studio-code-extension-in-che, administration-guide:testing-a-visual-studio-code-extension-in-che

include::partial$assembly_testing-a-visual-studio-code-extension-in-che.adoc[]
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,18 @@ This section describes the building of registries and updating a running {prod-s

// include::partial$assembly_modifying-the-registries.adoc[leveloffset=+1]

include::partial$proc_building-a-custom-devfile-registry.adoc[leveloffset=+1]
:registry-mode: custom
:registry-mode-name: a custom
:registry-id: devfile
:registry-name: devfile

include::installation-guide:example${project-context}-proc_building-a-registry-image.adoc[leveloffset=+1]

:registry-id: plugin
:registry-name: plug-in

include::installation-guide:example${project-context}-proc_building-a-registry-image.adoc[leveloffset=+1]

include::partial$proc_building-a-custom-plug-in-registry.adoc[leveloffset=+1]

include::partial$assembly_deploying-the-registries.adoc[leveloffset=+1]

Expand Down
Loading