Merge remote-tracking branch 'upstream/master' into upgrade-techdocs-sdk-v3

Signed-off-by: Clare Liguori <liguori@amazon.com>
This commit is contained in:
Clare Liguori
2022-11-25 11:44:46 -08:00
808 changed files with 17550 additions and 4277 deletions
+3 -3
View File
@@ -68,7 +68,7 @@ export const searchPage = (
switch (result.type) {
case 'software-catalog':
return (
<CatalogResultListItem
<CatalogSearchResultListItem
key={result.document.location}
result={result.document}
highlight={result.highlight}
@@ -253,7 +253,7 @@ const MyCustomFilter = () => {
It's good practice for search results to highlight information that was used to
return it in the first place! The code below highlights how you might specify a
custom result item component, using the `<CatalogResultListItem />` component as
custom result item component, using the `<CatalogSearchResultListItem />` component as
an example:
```tsx {7-13}
@@ -265,7 +265,7 @@ an example:
switch (result.type) {
case 'software-catalog':
return (
<CatalogResultListItem
<CatalogSearchResultListItem
key={result.document.location}
result={result.document}
highlight={result.highlight}
@@ -159,7 +159,12 @@ Check out the numbered markings - let's go through them one by one.
the outcome of that. This example issues a `fetch` to the right service and
issues a full refresh of its entity bucket based on that.
5. The method translates the foreign data model to the native `Entity` form, as
expected by the catalog.
expected by the catalog. The `Entity` must include the
`backstage.io/managed-by-location` and
`backstage.io/managed-by-origin-location annotations`; otherwise, it will not
appear in the Catalog and will generate warning logs. The
[Well-known Annotations](./well-known-annotations.md#backstageiomanaged-by-location)
documentation has guidance on what values to use for these.
6. Finally, we issue a "mutation" to the catalog. This persists the entities in
our own bucket, along with an optional `locationKey` that's used for conflict
checks. But this is a bigger topic - mutations warrant their own explanatory
+6 -4
View File
@@ -141,14 +141,16 @@ jobs:
steps:
- name: Checkout code
uses: actions/checkout@v2
uses: actions/checkout@v3
- uses: actions/setup-node@v2
- uses: actions/setup-python@v2
- uses: actions/setup-node@v3
- uses: actions/setup-python@v4
with:
python-version: '3.9'
# the 2 steps below can be removed if you aren't using plantuml in your documentation
- name: setup java
uses: actions/setup-java@v2
uses: actions/setup-java@v3
with:
distribution: 'zulu'
java-version: '11'