From bee418a36b7db3d8ebdfa82e2d43cede76e8a11d Mon Sep 17 00:00:00 2001
From: Mikko Korhonen <mikko.korhonen@gmail.com>
Date: Tue, 25 Jan 2022 11:36:18 +0200
Subject: [PATCH] docs(catalog-import): update documentation about catalog
 filename customizations

Signed-off-by: Mikko Korhonen <mikko.korhonen@gmail.com>
---
 plugins/catalog-import/README.md | 33 ++++++++++++++++++++++++++++++++
 1 file changed, 33 insertions(+)

diff --git a/plugins/catalog-import/README.md b/plugins/catalog-import/README.md
index f492619690..86f3aecba9 100644
--- a/plugins/catalog-import/README.md
+++ b/plugins/catalog-import/README.md
@@ -35,6 +35,8 @@ import { CatalogImportPage } from '@backstage/plugin-catalog-import';
 
 ## Customizations
 
+### Custom layout
+
 A custom layout can be passed to the import page, as it's already
 supported by the search page. If no custom layout is passed, the default layout
 is used.
@@ -72,6 +74,37 @@ feature by passing options to `<CatalogImportPage>` (`pullRequest.disable` and
 function. The function can either be overridden to generate a different content
 for the pull request, or removed to disable this feature.
 
+### Entity filename and branch name
+
+Entity filename (default: `catalog-info.yaml`) and branch name (default: `backstage-integration`) used in pull requests can be configured in `app-config.yaml` as follows:
+
+```yaml
+// app-config.yaml
+
+catalog:
+  import:
+    entityFilename: anvil.yaml
+    pullRequestBranchName: anvil-integration
+```
+
+### Entity examples
+
+Following React components accept optional props for providing custom example entity and repository paths:
+
+```tsx
+<StepInitAnalyzeUrl
+  ...
+  exampleLocationUrl="https://github.com/acme-corp/our-awesome-api/blob/main/anvil.yaml"
+/>
+```
+
+```tsx
+<ImportInfoCard
+  exampleLocationUrl="https://github.com/acme-corp/our-awesome-api/blob/main/anvil.yaml"
+  exampleRepositoryUrl="https://github.com/acme-corp/our-awesome-api"
+/>
+```
+
 ## Development
 
 Use `yarn start` to run a [development version](./dev/index.tsx) of the plugin that can be used to validate each flow with mocked data.