Skip to content

Commit 81c5dec

Browse files
themr0chmanwani-rh
andauthored
Apply suggestions from code review
Co-authored-by: Heena Manwani <[email protected]>
1 parent 7825392 commit 81c5dec

File tree

2 files changed

+20
-20
lines changed

2 files changed

+20
-20
lines changed

modules/importing-repositories/procedure-importing-multiple-repositories-from-github.adoc

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,20 +18,20 @@ This option allows you to select one or more repositories from the selected orga
1818
The pull request details form is preloaded with some data, and you can also preview the content of the `catalog-info.yaml`.
1919
If the repository already has a `.github/CODEOWNERS` file, you can select the *Use CODEOWNERS file as Entity Owner* checkbox to use it, rather than having the `content-info.yaml` contain a specific entity owner.
2020
. Click on *Save*.
21-
. Click on *Create pull requests*.
22-
At this point, a set of dry-run checks will be run against the selected repositories to make sure they meet the requirements to be imported, that is:
23-
.. Checking that there is no entity in the Developer Hub catalog with the name specified in the repository `catalog-info.yaml`
21+
. Click *Create pull requests*.
22+
At this point, a set of dry-run checks runs against the selected repositories to ensure they meet the requirements for import, such as:
23+
.. Verifying that there is no entity in the {product-short} catalog with the name specified in the repository `catalog-info.yaml`
2424
.. Checking that the repository is not empty
25-
.. Checking that the repository already has a `.github/CODEOWNERS` file if the *Use CODEOWNERS file as Entity Owner* checkbox was selected for that repository.
25+
.. Verifying that the repository contains a `.github/CODEOWNERS` file if the *Use CODEOWNERS file as Entity Owner* checkbox is selected for that repository.
2626

27-
** If there are any errors, the pull requests will not be created, but you will see a _Failed to create PR_ error message indicating the failures.
28-
Clicking on *Edit* will show more details about the reasons.
27+
** If any errors occur, the pull requests are not created, and you will see a _Failed to create PR_ error message detailing the issues.
28+
To view more details about the reasons, click *Edit*.
2929

30-
** If there are no errors, the pull requests will be created, and you will be redirected to the list of Added repositories.
30+
** If there are no errors, the pull requests are created, and you will be redirected to the list of added repositories.
3131

3232
. Review and merge each pull request that creates a `catalog-info.yml` file.
3333

3434
.Verification
3535
* The *Added repositories* list displays the repositories you just imported, each with an appropriate status: either _Waiting for approval_ or _Added_.
36-
* For each _Waiting for approval_ Import job listed, there is a corresponding pull request adding the `catalog-info.yaml` file in the corresponding repository
36+
* For each _Waiting for approval_ import job listed, there is a corresponding pull request adding the `catalog-info.yaml` file in the corresponding repository
3737
Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
11
= Managing the list of Added repositories
22

33
.Prerequisites
4-
* xref:enabling-ang-giving-access-to-the-bulk-import-feature[You enabled the Bulk Import feature].
5-
* xref:enabling-ang-giving-access-to-the-bulk-import-feature[Your {product-short} user has access to the Bulk Import feature].
4+
* You have xref:enabling-ang-giving-access-to-the-bulk-import-feature[enabled the Bulk Import feature].
5+
* You have xref:enabling-ang-giving-access-to-the-bulk-import-feature[access to the Bulk Import feature].
66
77
88
.Procedure
9-
. Click on *Bulk Import* in the left sidebar to display all the current repositories that are being tracked as Import jobs, along with their status.
9+
. Click *Bulk Import* in the left sidebar to display all the current repositories that are being tracked as Import jobs, along with their status.
1010

11-
Added:: The repository has been added to the Developer Hub catalog.
11+
Added:: The repository is added to the {product-short} catalog after the import pull request is merged or if the repository already contained a `catalog-info.yaml` file during the bulk import.
1212
This can be the case after the import PR has been merged, or if the repository already had a `catalog-info.yaml` when it was bulk-imported.
13-
Please note that it might take a few minutes until the entities are available in the catalog.
13+
Note that it may take a few minutes for the entities to be available in the catalog.
1414

15-
Waiting for approval:: There is an open pull request adding a `catalog-info.yaml`.
15+
Waiting for approval:: There is an open pull request adding a `catalog-info.yaml` file to the repository.
1616
You can:
17-
* Click on the *pencil icon* on the right to see details about this pull request or edit the pull request content right from {product-short}.
18-
* Delete the Import job, in which case the import PR will be closed as well.
17+
* Click the *pencil icon* on the right to see details about the pull request or edit the pull request content right from {product-short}.
18+
* Delete the Import job, this closes the import PR as well.
1919
* To transition the Import job to the _Added_ state, merge the import pull request from the Git repository.
2020

21-
Empty:: {product-short} was not able to determine the Import job status.
21+
Empty:: {product-short} is unable to determine the import job status because the repository is imported from other sources but does not have a `catalog-info.yaml` file and lacks any import pull request adding it.
2222
This can be the case if the repository was imported from other sources but does not have any `catalog-info.yaml` file and does not have any import PR adding it.
2323

2424
[NOTE]
2525
====
26-
* After an import pull request is merged, the Import status will be _Added_ in the list of Added Repositories, but it might take a few seconds until the corresponding entities show up in the Developer Hub Catalog.
27-
* A Location added through other sources (like statically in an `app-config.yaml` file, dynamically when link:{linkgettingstartedguide}#enabling-github-discovery-in-red-hat-developer-hub[enabling GitHub discovery], or registered manually via the "Register an existing component" page) may show up in the Bulk Import list of Added Repositories if both conditions are met:
26+
* After an import pull request is merged, the import status is marked as _Added_ in the list of Added Repositories, but it might take a few seconds for the corresponding entities to appear in the {product-short} Catalog.
27+
* A location added through other sources (like statically in an `app-config.yaml` file, dynamically when link:{linkgettingstartedguide}#enabling-github-discovery-in-red-hat-developer-hub[enabling GitHub discovery], or registered manually using the "Register an existing component" page) may show up in the Bulk Import list of Added Repositories if the following conditions are met:
2828
** The target repository is accessible from the configured GitHub integrations.
29-
** The Location URL points to a `catalog-info.yaml` file at the root of the repository default branch.
29+
** The location URL points to a `catalog-info.yaml` file at the root of the repository default branch.
3030
====

0 commit comments

Comments
 (0)