More Backend Migration Docs

* Added more documentation on migrating catalog modules to the new backend system.  (A-Github)
* Tweaked a few existing documentation page to recommend schedules are set via

Signed-off-by: Alex Crome <afscrome@users.noreply.github.com>

docs/integrations/aws-s3/discovery.md

@@ -32,7 +32,7 @@ catalog:
         bucketName: sample-bucket
         prefix: prefix/ # optional
         region: us-east-2 # optional, uses the default region otherwise
-        schedule: # optional; same options as in TaskScheduleDefinition
+        schedule: # same options as in TaskScheduleDefinition
           # supports cron, ISO duration, "human duration" as used in code
           frequency: { minutes: 30 }
           # supports ISO duration, "human duration" as used in code
@@ -52,7 +52,7 @@ catalog:
       bucketName: sample-bucket
       prefix: prefix/ # optional
       region: us-east-2 # optional, uses the default region otherwise
-      schedule: # optional; same options as in TaskScheduleDefinition
+      schedule: # same options as in TaskScheduleDefinition
         # supports cron, ISO duration, "human duration" as used in code
         frequency: { minutes: 30 }
         # supports ISO duration, "human duration" as used in code
@@ -79,12 +79,6 @@ const builder = await CatalogBuilder.create(env);
 builder.addEntityProvider(
   AwsS3EntityProvider.fromConfig(env.config, {
     logger: env.logger,
-    // optional: alternatively, use scheduler with schedule defined in app-config.yaml
-    schedule: env.scheduler.createScheduledTaskRunner({
-      frequency: { minutes: 30 },
-      timeout: { minutes: 3 },
-    }),
-    // optional: alternatively, use schedule
     scheduler: env.scheduler,
   }),
 );

docs/integrations/azure/discovery.md

@@ -71,7 +71,7 @@ The parameters available are:
 - **`repository:`** _(optional)_ The repository name. Wildcards are supported as show on the examples above. If not set, all repositories will be searched.
 - **`path:`** _(optional)_ Where to find catalog-info.yaml files. Defaults to /catalog-info.yaml.
 - **`branch:`** _(optional)_ The branch name to use.
-- **`schedule`** _(optional)_:
+- **`schedule`**:
   - **`frequency`**:
     How often you want the task to run. The system does its best to avoid overlapping invocations.
   - **`timeout`**:

docs/integrations/bitbucketCloud/discovery.md

@@ -49,19 +49,6 @@ export default async function createPlugin(
 }
 ```
 
-Alternatively to the config-based schedule, you can use
-
-```ts
-/* highlight-remove-next-line */
-scheduler: env.scheduler,
-/* highlight-add-start */
-schedule: env.scheduler.createScheduledTaskRunner({
-  frequency: { minutes: 30 },
-  timeout: { minutes: 3 },
-}),
-/* highlight-add-end */
-```
-
 ### Installation with Events Support
 
 Please follow the installation instructions at
@@ -131,7 +118,7 @@ catalog:
         filters: # optional
           projectKey: '^apis-.*$' # optional; RegExp
           repoSlug: '^service-.*$' # optional; RegExp
-        schedule: # optional; same options as in TaskScheduleDefinition
+        schedule: # same options as in TaskScheduleDefinition
           # supports cron, ISO duration, "human duration" as used in code
           frequency: { minutes: 30 }
           # supports ISO duration, "human duration" as used in code
@@ -153,7 +140,7 @@ catalog:
     Regular expression used to filter results based on the project key.
   - **`repoSlug`** _(optional)_:
     Regular expression used to filter results based on the repo slug.
-- **`schedule`** _(optional)_:
+- **`schedule`**:
   - **`frequency`**:
     How often you want the task to run. The system does its best to avoid overlapping invocations.
   - **`timeout`**:

docs/integrations/bitbucketServer/discovery.md

@@ -38,12 +38,6 @@ export default async function createPlugin(
   builder.addEntityProvider(
     BitbucketServerEntityProvider.fromConfig(env.config, {
       logger: env.logger,
-      // optional: alternatively, use scheduler with schedule defined in app-config.yaml
-      schedule: env.scheduler.createScheduledTaskRunner({
-        frequency: { minutes: 30 },
-        timeout: { minutes: 3 },
-      }),
-      // optional: alternatively, use schedule
       scheduler: env.scheduler,
     }),
   );
@@ -69,7 +63,7 @@ catalog:
         filters: # optional
           projectKey: '^apis-.*$' # optional; RegExp
           repoSlug: '^service-.*$' # optional; RegExp
-        schedule: # optional; same options as in TaskScheduleDefinition
+        schedule: # same options as in TaskScheduleDefinition
           # supports cron, ISO duration, "human duration" as used in code
           frequency: { minutes: 30 }
           # supports ISO duration, "human duration" as used in code
@@ -87,7 +81,7 @@ catalog:
     Regular expression used to filter results based on the project key.
   - **`repoSlug`** _(optional)_:
     Regular expression used to filter results based on the repo slug.
-- **`schedule`** _(optional)_:
+- **`schedule`**:
   - **`frequency`**:
     How often you want the task to run. The system does its best to avoid overlapping invocations.
   - **`timeout`**:

docs/integrations/gerrit/discovery.md

@@ -26,18 +26,11 @@ Then add the plugin to the plugin catalog `packages/backend/src/plugins/catalog.
 ```ts
 /* packages/backend/src/plugins/catalog.ts */
 import { GerritEntityProvider } from '@backstage/plugin-catalog-backend-module-gerrit';
-import { Duration } from 'luxon';
 const builder = await CatalogBuilder.create(env);
 /** ... other processors and/or providers ... */
 builder.addEntityProvider(
   GerritEntityProvider.fromConfig(env.config, {
     logger: env.logger,
-    // optional: alternatively, use scheduler with schedule defined in app-config.yaml
-    schedule: env.scheduler.createScheduledTaskRunner({
-      frequency: { minutes: 30 },
-      timeout: { minutes: 3 },
-    }),
-    // optional: alternatively, use schedule
     scheduler: env.scheduler,
   }),
 );
@@ -57,7 +50,7 @@ catalog:
         host: gerrit-your-company.com
         branch: master # Optional
         query: 'state=ACTIVE&prefix=webapps'
-        schedule: # optional; same options as in TaskScheduleDefinition
+        schedule:
           # supports cron, ISO duration, "human duration" as used in code
           frequency: { minutes: 30 }
           # supports ISO duration, "human duration" as used in code

docs/integrations/github/discovery.md

@@ -40,12 +40,6 @@ export default async function createPlugin(
   builder.addEntityProvider(
     GithubEntityProvider.fromConfig(env.config, {
       logger: env.logger,
-      // optional: alternatively, use scheduler with schedule defined in app-config.yaml
-      schedule: env.scheduler.createScheduledTaskRunner({
-        frequency: { minutes: 30 },
-        timeout: { minutes: 3 },
-      }),
-      // optional: alternatively, use schedule
       scheduler: env.scheduler,
     }),
   );
@@ -85,12 +79,6 @@ export default async function createPlugin(
   /* highlight-add-start */
   const githubProvider = GithubEntityProvider.fromConfig(env.config, {
     logger: env.logger,
-    // optional: alternatively, use scheduler with schedule defined in app-config.yaml
-    schedule: env.scheduler.createScheduledTaskRunner({
-      frequency: { minutes: 30 },
-      timeout: { minutes: 3 },
-    }),
-    // optional: alternatively, use schedule
     scheduler: env.scheduler,
   });
   env.eventBroker.subscribe(githubProvider);
@@ -122,7 +110,7 @@ catalog:
         filters:
           branch: 'main' # string
           repository: '.*' # Regex
-        schedule: # optional; same options as in TaskScheduleDefinition
+        schedule: # same options as in TaskScheduleDefinition
           # supports cron, ISO duration, "human duration" as used in code
           frequency: { minutes: 30 }
           # supports ISO duration, "human duration" as used in code
@@ -213,7 +201,7 @@ This provider supports multiple organizations via unique provider IDs.
   Defaults to `false`.
   Due to limitations in the GitHub API's ability to query for repository objects, this option cannot be used in
   conjunction with wildcards in the `catalogPath`.
-- **`schedule`** _(optional)_:
+- **`schedule`**:
   - **`frequency`**:
     How often you want the task to run. The system does its best to avoid overlapping invocations.
   - **`timeout`**:
@@ -229,13 +217,12 @@ GitHub [rate limits](https://docs.github.com/en/rest/overview/resources-in-the-r
 accounts). The snippet below refreshes the Backstage catalog data every 35 minutes, which issues an API request for each discovered location.
 
 If your requests are too frequent then you may get throttled by
-rate limiting. You can change the refresh frequency of the catalog in your `packages/backend/src/plugins/catalog.ts` file:
+rate limiting. You can change the refresh frequency of the catalog in your `app-config.yaml` file by controlling the `schedule`.
 
-```typescript
-schedule: env.scheduler.createScheduledTaskRunner({
-  frequency: { minutes: 35 },
-  timeout: { minutes: 30 },
-}),
+```yaml
+schedule:
+  frequency: { minutes: 35 }
+  timeout: { minutes: 3 }
 ```
 
 More information about scheduling can be found on the [TaskScheduleDefinition](https://backstage.io/docs/reference/backend-tasks.taskscheduledefinition) page.