Merge branch 'master' of https://github.com/backstage/backstage into update-prism-theme
This commit is contained in:
@@ -506,9 +506,10 @@ import {
|
||||
processingResult,
|
||||
CatalogProcessor,
|
||||
CatalogProcessorEmit,
|
||||
LocationSpec,
|
||||
} from '@backstage/plugin-catalog-node';
|
||||
|
||||
import { LocationSpec } from '@backstage/plugin-catalog-common';
|
||||
|
||||
// A processor that reads from the fictional System-X
|
||||
export class SystemXReaderProcessor implements CatalogProcessor {
|
||||
constructor(private readonly reader: UrlReader) {}
|
||||
|
||||
@@ -58,6 +58,10 @@ It shouldn't take too long, and you'll have a success screen!
|
||||
If it fails, you'll be able to click on each section to get the log from the
|
||||
step that failed which can be helpful in debugging.
|
||||
|
||||
You can also cancel the running process. Once you clicked on button "Cancel", the abort signal
|
||||
will be sent to a task and all next steps won't be executed. The current step will be cancelled
|
||||
only if it supports it.
|
||||
|
||||

|
||||
|
||||
## View Component in Catalog
|
||||
|
||||
@@ -71,7 +71,7 @@ You can also choose to define your custom action using JSON schema instead of `z
|
||||
|
||||
```ts title="With JSON Schema"
|
||||
import { createTemplateAction } from '@backstage/plugin-scaffolder-node';
|
||||
import fs from 'fs-extra';
|
||||
import { writeFile } from 'fs';
|
||||
|
||||
export const createNewFileAction = () => {
|
||||
return createTemplateAction<{ contents: string; filename: string }>({
|
||||
@@ -95,9 +95,12 @@ export const createNewFileAction = () => {
|
||||
},
|
||||
},
|
||||
async handler(ctx) {
|
||||
await fs.outputFile(
|
||||
const { signal } = ctx;
|
||||
await writeFile(
|
||||
`${ctx.workspacePath}/${ctx.input.filename}`,
|
||||
ctx.input.contents,
|
||||
{ signal },
|
||||
_ => {},
|
||||
);
|
||||
},
|
||||
});
|
||||
|
||||
@@ -200,6 +200,15 @@ Options:
|
||||
-h, --help display help for command
|
||||
```
|
||||
|
||||
#### Publishing from behind a proxy
|
||||
|
||||
For users attempting to publish TechDocs content behind a proxy, the TechDocs CLI leverages `global-agent` to navigate the proxy to successfully connect to that location. To enable `global-agent`, the following variables need to be set prior to running the techdocs-cli command:
|
||||
|
||||
```bash
|
||||
export GLOBAL_AGENT_HTTPS_PROXY=${HTTP_PROXY}
|
||||
export GLOBAL_AGENT_NO_PROXY=${NO_PROXY}
|
||||
```
|
||||
|
||||
### Migrate content for case-insensitive access
|
||||
|
||||
Prior to the beta version of TechDocs (`v[0.11.0]`), TechDocs were stored in
|
||||
|
||||
Reference in New Issue
Block a user