Skip to content

Commit ed845cb

Browse files
authored
Merge pull request RedHatInsights#913 from rvsia/updateUpdateWizardDoc
Update UpdateWizard documentation page
2 parents 379a0e6 + 0fce889 commit ed845cb

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

doc/update-wizard.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,17 +12,19 @@
1212

1313
# Updating Add Source Wizard
1414

15-
The Add Source Wizard is using several repositories as sources for information. Firstly, all source and application types are strictly defined in [Sources API repository](https://github.com/RedHatInsights/sources-api/tree/master/db/seeds).
15+
The Add Source Wizard is using several repositories as sources for information. Firstly, all source and application types are strictly defined in [Sources API repository](https://github.com/RedHatInsights/sources-api-go/tree/main/dao/seeds).
1616

17-
## [Source types](https://github.com/RedHatInsights/sources-api/blob/master/db/seeds/source_types.yml)
17+
## [Source types](https://github.com/RedHatInsights/sources-api-go/blob/main/dao/seeds/source_types.yml)
1818

1919
This YAML file defines source types for both backend and frontend.
2020

2121
Each type is identified by name (`amazon`), this name has to be unique. (Please, don't rely on source types' `id`s as they can be changed and depends only on the order of their creation.)
2222

2323
`product_name` defines the name for the UI.
2424

25-
There is also `vendor` key for the identification of the type's vendor. This value is not shown in the UI, but is used to split the UI to two sections: **Cloud sources** and **Red Hat sources**. Red Hat sources are sources of type with vendor = `Red Hat`. Cloud sources are all other types. The wizard determines what Sources to show depending on a URL query: `?activeVendor=Red Hat|Cloud`.
25+
There is also `vendor` key for the identification of the type's vendor. This value is not shown in the UI.
26+
27+
`category` is currently used to split the UI to two sections: **Cloud sources** and **Red Hat sources**. The wizard determines what Sources to show depending on a URL query: `?category=Red Hat|Cloud`.
2628

2729
`icon_url` is a URL leading to images in [Insights Frontend Assets](https://github.com/RedHatInsights/frontend-assets) repository. If you need to add/change/remove some icon, please do it there. The UI has no hardcoded images.
2830

@@ -74,9 +76,7 @@ How to setup predefined values? Each authentication type needs at least one pre-
7476

7577
Each time this 'hidden' field is used in the UI, the value 'authtype' is set to 'token'. Users cannot see this value, they cannot edit it.
7678

77-
*Notes: Topological Inventory is now **hidden** in the UI.*
78-
79-
## [Application types](https://github.com/RedHatInsights/sources-api/blob/master/db/seeds/application_types.yml)
79+
## [Application types](https://github.com/RedHatInsights/sources-api-go/blob/main/dao/seeds/application_types.yml)
8080

8181
An application type is defined by several basic attributes:
8282

@@ -217,7 +217,7 @@ If you want to add an additional API endpoint for application-specific values, p
217217

218218
# Quick check-list
219219

220-
- [ ] Check API definition - [Sources API](https://github.com/RedHatInsights/sources-api/tree/master/db/seeds)
220+
- [ ] Check API definition - [Sources API](https://github.com/RedHatInsights/sources-api-go/tree/main/dao/seeds)
221221
- [ ] Update [hardcoded schemas](https://github.com/RedHatInsights/sources-ui/blob/master/src/components/addSourceWizard/hardcodedSchemas.js)
222222
- [ ] Authtype is always selected
223223
- [ ] Users can switch between source/app types and the wizard should always work

0 commit comments

Comments
 (0)