Skip to content

Commit 4b637c5

Browse files
authored
Merge branch 'redhat-developer:main' into secure-workflow
2 parents e29b59c + 01a0412 commit 4b637c5

File tree

36 files changed

+349
-298
lines changed

36 files changed

+349
-298
lines changed

artifacts/rhdh-plugins-reference/aap-backend/aap-backend-plugin-readme.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@ The AAP backend plugin is pre-loaded in {product-short} with basic configuration
2828

2929
[source,yaml]
3030
----
31-
global:
32-
dynamic:
33-
includes:
31+
global:
32+
dynamic:
33+
includes:
3434
- dynamic-plugins.default.yaml
35-
plugins:
35+
plugins:
3636
- package: ./dynamic-plugins/dist/janus-idp-backstage-plugin-aap-backend-dynamic
3737
disabled: false
3838
----
@@ -60,9 +60,9 @@ To enable the AAP plugin, you must set the following environment variables:
6060
owner: <owner>
6161
system: <system>
6262
schedule: # optional; same options as in TaskScheduleDefinition
63-
# supports cron, ISO duration, "human duration" as used in code
63+
# supports cron, ISO 8601 duration strings, and duration objects
6464
frequency: { minutes: 1 }
65-
# supports ISO duration, "human duration" as used in code
65+
# supports ISO 8601 duration strings and duration objects
6666
timeout: { minutes: 1 }
6767
----
6868
--

artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-admin.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,9 +53,9 @@ You can configure a schedule in the `app-config.yaml` file, as follows:
5353
# ...
5454
# highlight-add-start
5555
schedule: # optional; same options as in TaskScheduleDefinition
56-
# supports cron, ISO duration, "human duration" as used in code
56+
# supports cron, ISO 8601 duration strings, and duration objects
5757
frequency: { minutes: 1 }
58-
# supports ISO duration, "human duration" as used in code
58+
# supports ISO 8601 duration strings and duration objects
5959
timeout: { minutes: 1 }
6060
initialDelay: { seconds: 15 }
6161
# highlight-add-end

artifacts/rhdh-plugins-reference/keycloak/keycloak-plugin-readme.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[id="rhdh-keycloak_{context}"]
2-
= Installation and configuration of Keycloak
2+
= Installation and configuration of Keycloak
33

44
The Keycloak backend plugin, which integrates Keycloak into {product-short}, has the following capabilities:
55

@@ -12,11 +12,11 @@ The Keycloak plugin is pre-loaded in {product-short} with basic configuration pr
1212

1313
[source,yaml]
1414
----
15-
global:
16-
dynamic:
17-
includes:
15+
global:
16+
dynamic:
17+
includes:
1818
- dynamic-plugins.default.yaml
19-
plugins:
19+
plugins:
2020
- package: ./dynamic-plugins/dist/backstage-community-plugin-catalog-backend-module-keycloak-dynamic
2121
disabled: false
2222
----
@@ -48,9 +48,9 @@ You can configure a schedule in the `app-config.yaml` file, as follows:
4848
# ...
4949
# highlight-add-start
5050
schedule: # optional; same options as in TaskScheduleDefinition
51-
# supports cron, ISO duration, "human duration" as used in code
51+
# supports cron, ISO 8601 duration strings, and duration objects
5252
frequency: { minutes: 1 }
53-
# supports ISO duration, "human duration" as used in code
53+
# supports ISO 8601 duration strings and duration objects
5454
timeout: { minutes: 1 }
5555
initialDelay: { seconds: 15 }
5656
# highlight-add-end

artifacts/rhdh-plugins-reference/ocm/ocm-plugin-readme.adoc

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -25,15 +25,15 @@ The Red Hat Plug-ins for Backstage (RHPIB) packages are hosted in a separate NPM
2525
----
2626
# update your .npmrc or .yarnrc file
2727
yarn config set "@redhat:registry" https://npm.registry.redhat.com
28-
# then pull a package
28+
# then pull a package
2929
yarn add @redhat/backstage-plugin-quay
3030
----
3131

32-
For more information, see link:https://docs.npmjs.com/cli/v9/configuring-npm/npmrc[npm docs].
32+
For more information, see link:https://docs.npmjs.com/cli/v9/configuring-npm/npmrc[npm docs].
3333

34-
Creating a `.npmrc` file ensures that all the packages are scoped under `@redhat` and are fetched from link:https://npm.registry.redhat.com/[Red Hat's NPM registry], while the rest dependencies remain sourced from other link:registry.npmjs.org[registry].
34+
Creating a `.npmrc` file ensures that all the packages are scoped under `@redhat` and are fetched from link:https://npm.registry.redhat.com/[Red Hat's NPM registry], while the rest dependencies remain sourced from other link:registry.npmjs.org[registry].
3535

36-
Using this configuration, you can proceed with the installation of the individual packages.
36+
Using this configuration, you can proceed with the installation of the individual packages.
3737

3838
The OCM plugin is composed of two packages, including:
3939

@@ -204,9 +204,9 @@ For more information about the configuration, see https://backstage.io/docs/feat
204204
# ...
205205
# highlight-add-start
206206
schedule: # optional; same options as in TaskScheduleDefinition
207-
# supports cron, ISO duration, "human duration" as used in code
207+
# supports cron, ISO 8601 duration strings, and duration objects
208208
frequency: { minutes: 1 }
209-
# supports ISO duration, "human duration" as used in code
209+
# supports ISO 8601 duration strings and duration objects
210210
timeout: { minutes: 1 }
211211
# highlight-add-end
212212
+
@@ -295,7 +295,7 @@ yarn workspace app add @redhat/backstage-plugin-ocm
295295
--
296296

297297
. Select the components that you want to use, such as:
298-
298+
299299
** `OcmPage`: This is a standalone page or dashboard displaying all clusters as tiles. You can add `OcmPage` to `packages/app/src/App.tsx` file as follows:
300300
+
301301
--

assemblies/assembly-centralizing-your-software-components-in-rhdh.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ include::modules/centralizing-your-software-components-in-rhdh/proc-registering-
2424

2525
include::modules/centralizing-your-software-components-in-rhdh/proc-updating-existing-components-in-your-rhdh-catalog.adoc[leveloffset=+1]
2626

27-
include::modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-kind.adoc[leveloffset=+1]
27+
include::modules/centralizing-your-software-components-in-rhdh/proc-finding-components-by-kind-in-the-rhdh-catalog.adoc[leveloffset=+1]
2828

29-
include::modules/centralizing-your-software-components-in-rhdh/proc-finding-the-right-components-quickly-in-the-rhdh-catalog-by-using-the-filter-field.adoc[leveloffset=+1]
29+
include::modules/centralizing-your-software-components-in-rhdh/proc-filtering-components-by-text-in-the-rhdh-catalog.adoc[leveloffset=+1]
3030

3131
include::modules/centralizing-your-software-components-in-rhdh/proc-reviewing-the-yaml-configuration-of-your-rhdh-software-catalog.adoc[leveloffset=+1]
3232

assemblies/assembly-importing-and-using-an-existing-template-for-faster-development.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ include::modules/importing-and-using-an-existing-template-for-faster-development
1414

1515
include::modules/importing-and-using-an-existing-template-for-faster-development/ref-creating-templates.adoc[leveloffset=+1]
1616

17-
include::modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-a-new-software-component-using-templates.adoc[leveloffset=+1]
17+
include::modules/importing-and-using-an-existing-template-for-faster-development/proc-creating-a-software-component-using-templates.adoc[leveloffset=+1]
1818

1919
include::modules/importing-and-using-an-existing-template-for-faster-development/proc-searching-and-filtering-software-templates.adoc[leveloffset=+1]
2020

assemblies/assembly-rhdh-default-configuration.adoc

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,6 @@ include::modules/configuring-external-databases/con-mounts-for-default-secret-pv
1919

2020
include::modules/configuring-external-databases/proc-configuring-mount-paths.adoc[leveloffset=+2]
2121

22-
include::modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc[leveloffset=+2]
22+
include::modules/configuring-external-databases/proc-mounting-to-specific-containers.adoc[leveloffset=+2]
23+
24+
include::modules/configuring/ref-time-syntax.adoc[leveloffset=1]

assemblies/assembly-using-developer-lightspeed.adoc

Lines changed: 27 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,27 @@ endif::[]
1111

1212
:context: Using-developer-lightspeed
1313

14-
{ls-brand-name} is designed to support you when performing various tasks during your development workflow.
14+
{ls-brand-name} is designed to help you perform development tasks through a conversational interface. You can ask questions, analyze logs, generate code, and create test plans.
15+
16+
.Capabilities
17+
The scope of questions you can ask depends on your configuration:
18+
19+
* *Question Validation* enabled (default): Supports general questions about {product}. For example:
20+
21+
** “Tell me about {product}.”
22+
** “What are the benefits of {product-very-short}?”
23+
** “Can I use {product-very-short} on an {ocp-short}?”
24+
** “How do I install plugins on {product}?”
25+
26+
* *Question Validation* disabled: Supports broader tasks such as log analysis, code generation, and creating Kubernetes deployments. For example:
27+
28+
** “Analyze this log for me…”
29+
** “Suggest libraries and frameworks I can use to build Event Driven Architecture microservices.”
30+
** “I'm not familiar with this language, so explain to me what this code snippet is doing…”
31+
** “Create a Kubernetes deployment for this service…”
32+
** “Create a test plan for the following scenarios and conditions…”
33+
** “Create a Jira record that describes the following feature…”
34+
** “Draft the end-user documentation describing how to use the following cli command…”
1535

1636
[NOTE]
1737
====
@@ -22,36 +42,14 @@ The `Question Validation` feature is enabled by default if you are using the `qu
2242
* `External_providers_dir` set to `null`
2343
====
2444

25-
With `Question Validation` enabled, you can ask {ls-short} the following types of questions:
26-
27-
* “Tell me about {product}.”
28-
29-
* “What are the benefits of {product-very-short}?”
30-
31-
* “Can I use {product-very-short} on an {ocp-short}?”
32-
33-
* “How do I install plugins on {product}?”
34-
35-
With `Question Validation` disabled, the scope of prompts you can put to {ls-short} is much broader. This allows {ls-short} to support you in a much more varied range of work situations as described in the following examples:
36-
37-
* “Analyze this log for me…”
38-
39-
* “Suggest libraries and frameworks I can use to build Event Driven Architecture microservices.”
40-
41-
* “I'm not familiar with this language, so explain to me what this code snippet is doing…”
42-
43-
* “Create a Kubernetes deployment for this service…”
44-
45-
* “Create a test plan for the following scenarios and conditions…”
46-
47-
* “Create a Jira record that describes the following feature…”
45+
.Prerequisites
4846

49-
* “Draft the end-user documentation describing how to use the following cli command…”
47+
* You have the {ls-short} plugin configured in your {product-very-short} instance.
5048
51-
include::modules/developer-lightspeed/proc-using-developer-lightspeed-to-start-a-chat-for-the-first-time.adoc[leveloffset=+1]
49+
include::modules/developer-lightspeed/proc-starting-a-chat-in-developer-lightspeed.adoc[leveloffset=+1]
5250

53-
include::modules/developer-lightspeed/proc-using-developer-lightspeed-to-create-new-chats-after-the-first-chat.adoc[leveloffset=+1]
51+
include::modules/developer-lightspeed/proc-starting-a-chat-in-developer-lightspeed-after-the-first-time.adoc[leveloffset=+1]
5452

55-
include::modules/developer-lightspeed/proc-using-developer-lightspeed-to-view-chat-history.adoc[leveloffset=+1]
53+
include::modules/developer-lightspeed/proc-viewing-chat-history-in-developer-lightspeed.adoc[leveloffset=+1]
5654

57-
include::modules/developer-lightspeed/proc-using-developer-lightspeed-to-delete-a-chat.adoc[leveloffset=+1]
55+
include::modules/developer-lightspeed/proc-deleting-a-chat-in-developer-lightspeed.adoc[leveloffset=+1]
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// Module included in the following assemblies:
2+
//
3+
// * assemblies/assembly-about-software-catalogs.adoc
4+
:_mod-docs-content-type: PROCEDURE
5+
[id="proc-filtering-components-by-text-in-the-rhdh-catalog_{context}"]
6+
= Filtering components by text in the {product} Catalog
7+
8+
Use this procedure to search and filter components by text in the Software Catalog.
9+
10+
.Procedure
11+
. In your {product} navigation menu, click *Catalog*.
12+
. In the *Search* field, enter a component name, description, or keyword that you are looking for.
13+
14+
.Verification
15+
* The *Catalog* list updates to display only components matching your search criteria.
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
:_mod-docs-content-type: PROCEDURE
2+
[id="proc-finding-components-by-kind-in-the-rhdh-catalog_{context}"]
3+
= Finding components by Kind in the {product} catalog
4+
5+
Use this procedure to filter the Software Catalog to display components by their type.
6+
7+
.Prerequisites
8+
* You are logged in to the {product-very-short} instance.
9+
10+
.Procedure
11+
. In your {product} navigation menu, click *Catalog*.
12+
. On the *Catalog* page, click the *Kind* drop-down list.
13+
. Select the *Kind* you want to filter by, such as *Component*, *API*, or *Template*.
14+
+
15+
[NOTE]
16+
====
17+
The available filter lists change based on the *Kind* you select, showing options relevant to that entity type.
18+
====
19+
20+
.Verification
21+
* The Catalog updates to list only the components matching the selected *Kind*.

0 commit comments

Comments
 (0)