Skip to content

Commit f2a8799

Browse files
authored
chore: JR-317: Updates image, and combines export sections, in Getting Started (#512)
1 parent 4adcd7e commit f2a8799

File tree

4 files changed

+18
-68
lines changed

4 files changed

+18
-68
lines changed

docs/api-designer/getting-started-api-designer/README.adoc

Lines changed: 17 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ endif::[]
103103
== Creating an {product-api-designer} schema or API design
104104

105105
[role="_abstract"]
106-
Use the {product-long-api-designer} web console to create an {product-api-designer} schema or API design. ...
106+
Use the {product-long-api-designer} web console to create an {product-api-designer} schema or API design.
107107

108108
ifndef::qs[]
109109
.Prerequisites
@@ -113,10 +113,11 @@ endif::[]
113113
.Procedure
114114
. In the {service-url-api-designer}[{product-api-designer} web console], click ...
115115
. Click ...
116-
116+
+
117117
[.screencapture]
118-
.{product-api-designer} placeholder image
119-
image::placeholder.png[Placeholder image for {product-api-designer} ]
118+
.Creating an {product-api-designer} design
119+
image::create-api-designer-design.png[Image of page to create an {product-api-designer} design]
120+
. Click ...
120121

121122
.Verification
122123
ifdef::qs[]
@@ -132,8 +133,7 @@ endif::[]
132133
== Importing an {product-api-designer} schema or API design
133134

134135
[role="_abstract"]
135-
You can import an {product-api-designer} schema or API design from a URL, from a file, or from a {registry} instance.
136-
...
136+
You can import an {product-api-designer} schema or API design from a URL, from a file, or from an {product-long-registry} instance.
137137

138138
.Prerequisites
139139
* You're logged in to the {product-api-designer} web console at {service-url-api-designer}[^].
@@ -142,7 +142,6 @@ You can import an {product-api-designer} schema or API design from a URL, from a
142142
. In the *{product-api-designer}* designs page of the web console, click ...
143143
. Click ...
144144

145-
146145
.Verification
147146
ifdef::qs[]
148147
* Is the imported {product-api-designer} design listed in the designs table?
@@ -160,13 +159,12 @@ endif::[]
160159
After you create or import an {product-api-designer} design, you can edit the schema or API content.
161160

162161
.Prerequisites
163-
* You've created or uploaded an {product-api-designer} design.
162+
* You've created or imported an {product-api-designer} design.
164163

165164
.Procedure
166165
. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to edit.
167166
. Click ...
168167

169-
170168
.Verification
171169
ifdef::qs[]
172170
* Is ...?
@@ -179,16 +177,15 @@ endif::[]
179177
== Validating an {product-api-designer} schema or API design
180178

181179
[role="_abstract"]
182-
After you edit an {product-api-designer} design, you can validate the schema or API content.
180+
You can validate the schema or API content in an {product-api-designer} design.
183181

184182
.Prerequisites
185-
* You've created, uploaded, or edited an {product-api-designer} design.
183+
* You've created, imported, or edited an {product-api-designer} design.
186184

187185
.Procedure
188186
. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to validate.
189187
. Click ...
190188

191-
192189
.Verification
193190
ifdef::qs[]
194191
* Is ...?
@@ -197,18 +194,17 @@ ifndef::qs[]
197194
* Verify that ...
198195
endif::[]
199196

200-
[id="proc-exporting-schema-api-design-locally_{context}"]
201-
== Saving {product-api-designer} designs locally
197+
[id="proc-exporting-schema-api-design_{context}"]
198+
== Exporting {product-api-designer} designs
202199

203200
[role="_abstract"]
204-
_*To confirm:* Not sure if we'll need this section -- perhaps the designs will be saved locally automatically: to the browser index.db in Phase 1, and to the backend database in later phases._
205-
To ...
201+
You can export an {product-api-designer} design to a file or to an {product-long-registry} instance.
206202

207203
.Prerequisites
208-
* You've created, uploaded, or edited an {product-api-designer} design.
204+
* You've created or imported an {product-api-designer} design.
209205

210206
.Procedure
211-
. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to save locally.
207+
. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to export.
212208
. Click ...
213209

214210
.Verification
@@ -219,61 +215,17 @@ ifndef::qs[]
219215
* Verify that ...
220216
endif::[]
221217

222-
[id="proc-exporting-schema-api-design-to-file_{context}"]
223-
== Exporting {product-api-designer} designs to a file
224-
225-
[role="_abstract"]
226-
To ...
227-
228-
.Prerequisites
229-
* You've created, uploaded, or edited an {product-api-designer} design.
230-
231-
.Procedure
232-
. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to save to a file.
233-
. Click ...
234-
235-
.Verification
236-
ifdef::qs[]
237-
* Is ...?
238-
endif::[]
239-
ifndef::qs[]
240-
* Verify that ...
241-
endif::[]
242-
243-
[id="proc-exporting-schema-api-design-to-registry_{context}"]
244-
== Exporting {product-api-designer} designs to {registry}
245-
246-
[role="_abstract"]
247-
To ...
248-
249-
.Prerequisites
250-
* You've created, uploaded, or edited an {product-api-designer} design.
251-
*
252-
253-
.Procedure
254-
. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to save to {registry}.
255-
. Click ...
256-
257-
.Verification
258-
ifdef::qs[]
259-
* Did you ...?
260-
endif::[]
261-
ifndef::qs[]
262-
. Verify that ...
263-
endif::[]
264-
265-
266218
[id="proc-deleting-schema-api-design_{context}"]
267219
== Deleting {product-api-designer} designs
268220

269221
[role="_abstract"]
270-
To ...
222+
You can delete one or more {product-api-designer} designs in a single action.
271223

272224
.Prerequisites
273-
* You've created or uploaded an {product-api-designer} design.
225+
* You've created or imported an {product-api-designer} design.
274226

275227
.Procedure
276-
. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} design that you want to delete.
228+
. In the *{product-api-designer}* designs page of the web console, select the {product-api-designer} designs that you want to delete.
277229
. Click ...
278230

279231
.Verification
54.7 KB
Loading

docs/api-designer/getting-started-api-designer/images/placeholder.png

Whitespace-only changes.

docs/api-designer/getting-started-api-designer/quickstart.yml

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,7 @@ spec:
2424
- !snippet/proc README.adoc#proc-importing-schema-api-design
2525
- !snippet/proc README.adoc#proc-editing-schema-api-design
2626
- !snippet/proc README.adoc#proc-validating-schema-api-design
27-
- !snippet/proc README.adoc#proc-exporting-schema-api-design-locally
28-
- !snippet/proc README.adoc#proc-exporting-schema-api-design-to-file
29-
- !snippet/proc README.adoc#proc-exporting-schema-api-design-to-registry
27+
- !snippet/proc README.adoc#proc-exporting-schema-api-design
3028
- !snippet/proc README.adoc#proc-deleting-schema-api-design
3129
conclusion: !snippet README.adoc#conclusion
3230
nextQuickStart:

0 commit comments

Comments
 (0)