paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 21 Packages Projects Releases Wiki Activity

techdocs: add a helpful link to docs page for warning

Browse Source 
Signed-off-by: Himanshu Mishra <himanshu@orkohunter.net>
This commit is contained in:
Himanshu Mishra
2021-07-20 12:42:04 +02:00
parent e47f2a3c09
commit c8dbc9aaa1
2 changed files with 4 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
packages/techdocs-common/src/stages/generate/techdocs.test.ts
+2 -1
View File
@@ -132,7 +132,8 @@ describe('readGeneratorConfig', () => {
runIn: 'local',
});
expect(logger.warn).toHaveBeenCalledWith(
`The 'techdocs.generators.techdocs' configuration key is deprecated and will be removed in the future. Please use 'techdocs.generator' instead.`,
`The 'techdocs.generators.techdocs' configuration key is deprecated and will be removed in the future. Please use 'techdocs.generator' instead. ` +
`See here https://backstage.io/docs/features/techdocs/configuration`,
);
});
});
packages/techdocs-common/src/stages/generate/techdocs.ts
+2 -1
View File
@@ -168,7 +168,8 @@ export function readGeneratorConfig(
if (legacyGeneratorType) {
logger.warn(
`The 'techdocs.generators.techdocs' configuration key is deprecated and will be removed in the future. Please use 'techdocs.generator' instead.`,
`The 'techdocs.generators.techdocs' configuration key is deprecated and will be removed in the future. Please use 'techdocs.generator' instead. ` +
`See here https://backstage.io/docs/features/techdocs/configuration`,
);
}