Fix typo and unify TechDocs casing in doc strings

Signed-off-by: Łukasz Jernaś <lukasz.jernas@allegro.com>
This commit is contained in:
Łukasz Jernaś
2024-08-19 16:14:20 +02:00
parent e86ca7105b
commit 4417dd40d1
3 changed files with 15 additions and 10 deletions
+5
View File
@@ -0,0 +1,5 @@
---
'@backstage/plugin-techdocs-node': patch
---
Fix typo and unify TechDocs casing in doc strings
+8 -8
View File
@@ -25,7 +25,7 @@ import {
import * as winston from 'winston';
/**
* Extension point type for configuring Techdocs builds.
* Extension point type for configuring TechDocs builds.
*
* @public
*/
@@ -35,7 +35,7 @@ export interface TechdocsBuildsExtensionPoint {
}
/**
* Extension point for configuring Techdocs builds.
* Extension point for configuring TechDocs builds.
*
* @public
*/
@@ -45,7 +45,7 @@ export const techdocsBuildsExtensionPoint =
});
/**
* Extension point type for configuring a custom Techdocs generator
* Extension point type for configuring a custom TechDocs generator
*
* @public
*/
@@ -54,7 +54,7 @@ export interface TechdocsGeneratorExtensionPoint {
}
/**
* Extension point for configuring a custom Techdocs generator
* Extension point for configuring a custom TechDocs generator
*
* @public
*/
@@ -64,7 +64,7 @@ export const techdocsGeneratorExtensionPoint =
});
/**
* Extension point type for configuring a custom Techdocs preparer
* Extension point type for configuring a custom TechDocs preparer
*
* @public
*/
@@ -73,7 +73,7 @@ export interface TechdocsPreparerExtensionPoint {
}
/**
* Extension point for configuring a custom Techdocs preparer
* Extension point for configuring a custom TechDocs preparer
*
* @public
*/
@@ -83,7 +83,7 @@ export const techdocsPreparerExtensionPoint =
});
/**
* Extension point type for configuring a custom Techdocs publisher
* Extension point type for configuring a custom TechDocs publisher
*
* @public
*/
@@ -92,7 +92,7 @@ export interface TechdocsPublisherExtensionPoint {
}
/**
* Extension point for configuring a custom Techdocs publisher
* Extension point for configuring a custom TechDocs publisher
*
* @public
*/
+2 -2
View File
@@ -38,7 +38,7 @@ export type ParsedLocationAnnotation = {
};
/**
* Returns a parset locations annotation
* Returns a parsed locations annotation
* @public
* @param annotationName - The name of the annotation in the entity metadata
* @param entity - A TechDocs entity instance
@@ -114,7 +114,7 @@ export const transformDirLocation = (
};
/**
* Returns a entity reference based on the TechDocs annotation type
* Returns an entity reference based on the TechDocs annotation type
* @public
* @param entity - A TechDocs instance
* @param scmIntegration - An implementation for SCM integration API