Skip to content

Commit f355285

Browse files
proc_stage-1-build-and-package-a-devfile-registry.adoc revisions made.
Signed-off-by: Michael Valdron <[email protected]>
1 parent 496f1b7 commit f355285

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

docs/modules/user-guide/partials/proc_stage-1-build-and-package-a-devfile-registry.adoc

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,10 @@ The main goal of this stage is:
66
. Pull in resources into the registry as part of the registry build.
77
. Modify the devfile to update references to those offline resources as part of the registry build.
88

9-
As part of the offline devfile registry build, we need to do a few steps.
10-
119
.Prerequisites
1210

1311
* Golang 1.17.x or higher
14-
* Docker 17.05 or higher / Podman 4.0.x or higher
12+
* Docker 17.05 or higher or Podman 4.0.x or higher
1513
* Git
1614
* Curl
1715
* Archive Tools (such as `unzip`)
@@ -38,7 +36,7 @@ git clone [email protected]:devfile/registry.git /path/to/registry
3836

3937
.Additional resources
4038

41-
* Creating your own registry Git repository, see xref:building-a-custom-devfile-registry.adoc[Building a custom devfile registry]
39+
* To create your own registry Git repository, see xref:building-a-custom-devfile-registry.adoc[Building a custom devfile registry]
4240

4341
=== Packaging Starter Projects
4442

@@ -109,12 +107,12 @@ curl -L https://github.com/odo-devfiles/nodejs-ex/archive/refs/heads/master.zip
109107

110108
=== Modify Devfile
111109

112-
Modification is to the devfile will be needed to 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.
110+
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.
113111

114112
.Procedure
115113

116-
. Under `starterProjects`, find the starter project definition you want to make offline
117-
. Under the definition for the starter project find either `git` or `zip`, as seen here:
114+
. Under `starterProjects`, find the starter project definition you want to make offline.
115+
. Under the definition for the starter project find either `git` or `zip`:
118116
+
119117
.Starter Project Before
120118
====
@@ -131,10 +129,13 @@ starterProjects:
131129
+
132130
. Do one of the following depending on the block type:
133131
* If `git`, replace all of the `git` block with a `zip` block and add the `location` to be the path to the local file under the stack root directory (`<registry_root>/stacks/<stack>/`).
134-
* If `zip`, just replace the value of `location` to the same as mention for `git`.
135-
. In either case, you should end up with something like as seen here:
136-
+
137-
.Starter Project After
132+
* If `zip`, just replace the value of `location` to the local file under the stack root directory (`<registry_root>/stacks/<stack>/`).
133+
134+
.Verification step
135+
136+
To confirm you modified your devfile, verify your altered starter project definition is similar to the following example:
137+
138+
.Altered Starter Project Definition
138139
====
139140
----
140141
...
@@ -148,20 +149,20 @@ starterProjects:
148149

149150
.Additional resources
150151

151-
* More about starter projects in devfiles, see xref:adding-projects-to-a-devfile.adoc[Adding projects to a devfile]
152+
* To learn more about starter projects in devfiles, see xref:adding-projects-to-a-devfile.adoc[Adding projects to a devfile]
152153

153154
=== Build Registry
154155

155156
.Procedure
156157

157-
. Change to registry root (if not already there)
158+
. If not already at the root of the registry, change to the root of the registry.
158159
+
159160
[source,bash]
160161
----
161162
cd /path/to/registry
162163
----
163164
+
164-
. Build Registry Image
165+
. Build the registry image.
165166
+
166167
[source,bash]
167168
----

0 commit comments

Comments
 (0)