Update docs for all spelling errors, and add auth0 session and spec.presence

Signed-off-by: Joe Patterson <jrwpatterson@gmail.com>

.changeset/fifty-paws-attack.md

@@ -0,0 +1,8 @@
+---
+'@backstage/catalog-model': patch
+'@backstage/plugin-scaffolder-common': patch
+'@backstage/plugin-search-backend-module-elasticsearch': patch
+'@backstage/plugin-search-backend-node': patch
+---
+
+Documentation update fixing the vale missing spellings, fixing errors, updating the `provider` document to include updates about auth0 needing a session, updating `descriptor-format` to include spec.presence on location which is missing

docs/auth/auth0/provider.md

@@ -37,6 +37,8 @@ auth:
         audience: ${AUTH_AUTH0_AUDIENCE}
         connection: ${AUTH_AUTH0_CONNECTION}
         connectionScope: ${AUTH_AUTH0_CONNECTION_SCOPE}
+  session:
+    secret: 'supersecret'
 ```
 
 The Auth0 provider is a structure with three configuration keys:
@@ -46,6 +48,8 @@ The Auth0 provider is a structure with three configuration keys:
   page
 - `domain`: The Application domain, found on the Auth0 Application page
 
+Because Auth0 requires a session you need to give the session a secret key.
+
 ## Optional Configuration
 
 - `audience`: The intended recipients of the token

docs/features/software-catalog/descriptor-format.md

@@ -1309,3 +1309,7 @@ resolved relative to the location of this Location entity itself.
 A list of targets as strings. They can all be either absolute paths/URLs
 (depending on the type), or relative paths such as `./details/catalog-info.yaml`
 which are resolved relative to the location of this Location entity itself.
+
+### `spec.presence` [optional]
+
+Describes whether the target of a location is required to exist or not. It defaults to `'required'` if not specified, can also be `'optional'`.

packages/catalog-model/src/kinds/SystemEntityV1alpha1.ts

@@ -15,11 +15,11 @@
  */
 
 import type { Entity } from '../entity/Entity';
-import schema from '../schema/kinds/System.v1alpha1.schema.json';
 import { ajvCompiledJsonSchemaValidator } from './util';
+import schema from '../schema/kinds/System.v1alpha1.schema.json';
 
 /**
- * Backstage catalog System kind Entity. Systems group Comopnents, Resources and APIs together.
+ * Backstage catalog System kind Entity. Systems group Components, Resources and APIs together.
  *
  * @remarks
  *

plugins/scaffolder-common/src/TaskSpec.ts

@@ -15,7 +15,7 @@
  */
 
 import type { EntityMeta, UserEntity } from '@backstage/catalog-model';
-import type { JsonValue, JsonObject } from '@backstage/types';
+import type { JsonObject, JsonValue } from '@backstage/types';
 
 /**
  * Information about a template that is stored on a task specification.
@@ -51,7 +51,7 @@ export type TemplateInfo = {
  */
 export interface TaskStep {
   /**
-   * A unqiue identifier for this step.
+   * A unique identifier for this step.
    */
   id: string;
   /**

plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngine.ts

@@ -14,8 +14,6 @@
  * limitations under the License.
  */
 
-import { awsGetCredentials, createAWSConnection } from 'aws-os-connection';
-import { Config } from '@backstage/config';
 import {
   IndexableDocument,
   IndexableResult,
@@ -23,15 +21,18 @@ import {
   SearchEngine,
   SearchQuery,
 } from '@backstage/plugin-search-common';
+import { awsGetCredentials, createAWSConnection } from 'aws-os-connection';
+import { isEmpty, isNumber, isNaN as nan } from 'lodash';
+
+import { Config } from '@backstage/config';
+import { ElasticSearchClientOptions } from './ElasticSearchClientOptions';
+import { ElasticSearchClientWrapper } from './ElasticSearchClientWrapper';
+import { ElasticSearchCustomIndexTemplate } from './types';
+import { ElasticSearchSearchEngineIndexer } from './ElasticSearchSearchEngineIndexer';
+import { Logger } from 'winston';
 import { MissingIndexError } from '@backstage/plugin-search-backend-node';
 import esb from 'elastic-builder';
-import { isEmpty, isNaN as nan, isNumber } from 'lodash';
 import { v4 as uuid } from 'uuid';
-import { Logger } from 'winston';
-import { ElasticSearchClientOptions } from './ElasticSearchClientOptions';
-import { ElasticSearchSearchEngineIndexer } from './ElasticSearchSearchEngineIndexer';
-import { ElasticSearchCustomIndexTemplate } from './types';
-import { ElasticSearchClientWrapper } from './ElasticSearchClientWrapper';
 
 export type { ElasticSearchClientOptions };
 
@@ -63,7 +64,7 @@ export type ElasticSearchQueryTranslator = (
 ) => ElasticSearchConcreteQuery;
 
 /**
- * Options for instansiate ElasticSearchSearchEngine
+ * Options for instantiate ElasticSearchSearchEngine
  * @public
  */
 export type ElasticSearchOptions = {

plugins/search-backend-module-elasticsearch/src/engines/ElasticSearchSearchEngineIndexer.ts

@@ -15,13 +15,13 @@
  */
 
 import { BatchSearchEngineIndexer } from '@backstage/plugin-search-backend-node';
-import { IndexableDocument } from '@backstage/plugin-search-common';
-import { Readable } from 'stream';
-import { Logger } from 'winston';
 import { ElasticSearchClientWrapper } from './ElasticSearchClientWrapper';
+import { IndexableDocument } from '@backstage/plugin-search-common';
+import { Logger } from 'winston';
+import { Readable } from 'stream';
 
 /**
- * Options for instansiate ElasticSearchSearchEngineIndexer
+ * Options for instantiate ElasticSearchSearchEngineIndexer
  * @public
  */
 export type ElasticSearchSearchEngineIndexerOptions = {

plugins/search-backend-node/src/collators/NewlineDelimitedJsonCollatorFactory.ts

@@ -14,16 +14,16 @@
  * limitations under the License.
  */
 
-import { UrlReader } from '@backstage/backend-common';
 import { Config } from '@backstage/config';
-import { Permission } from '@backstage/plugin-permission-common';
 import { DocumentCollatorFactory } from '@backstage/plugin-search-common';
-import { parse as parseNdjson } from 'ndjson';
-import { Readable } from 'stream';
 import { Logger } from 'winston';
+import { Permission } from '@backstage/plugin-permission-common';
+import { Readable } from 'stream';
+import { UrlReader } from '@backstage/backend-common';
+import { parse as parseNdjson } from 'ndjson';
 
 /**
- * Options for instansiate NewlineDelimitedJsonCollatorFactory
+ * Options for instantiate NewlineDelimitedJsonCollatorFactory
  * @public
  */
 export type NewlineDelimitedJsonCollatorFactoryOptions = {