Updated Documentation in /docs folder (#2439)

* Initial updates Signed-off-by: Andre Wanlin <[email protected]> * Further updates Signed-off-by: Andre Wanlin <[email protected]> * Improved group owner code Signed-off-by: Andre Wanlin <[email protected]> --------- Signed-off-by: Andre Wanlin <[email protected]>
backstage · Jan 3, 2025 · 184ec6d · 184ec6d
1 parent c9e8956
commit 184ec6d
Show file tree

Hide file tree

Showing 8 changed files with 354 additions and 276 deletions.
diff --git a/docs/README.md b/docs/README.md
diff --git a/docs/compatibility/compatibility.md b/docs/compatibility/compatibility.md
diff --git a/docs/compatibility/new-backend-system.md b/docs/compatibility/new-backend-system.md
diff --git a/docs/compatibility/new-frontend-system.md b/docs/compatibility/new-frontend-system.md
diff --git a/docs/index.md b/docs/index.md
diff --git a/scripts/list-backend-feature.js b/scripts/list-backend-feature.js
@@ -60,7 +60,7 @@ async function main(args) {
         backendFeatureReport.package = pkg.packageJson.name;
         backendFeatureReport.role = pkgRole;
         backendFeatureReport.readme = `[README](${pkg.packageJson.repository.url}/blob/master/${pkg.packageJson.repository.directory}/README.md)`;
-        const apiReportPath = join(pkg.dir, 'api-report.md');
+        const apiReportPath = join(pkg.dir, 'report.api.md');
         const apiReport = (await fs.readFile(apiReportPath)).toString();
         if (
           apiReport.includes(BACKEND_FEATURE) ||
@@ -70,7 +70,7 @@ async function main(args) {
           backendFeatureReport.alpha = false;
         }
 
-        const apiReportAlphaPath = join(pkg.dir, 'api-report-alpha.md');
+        const apiReportAlphaPath = join(pkg.dir, 'report-alpha.api.md');
         if (fs.existsSync(apiReportAlphaPath)) {
           const apiReportAlpha = (
             await fs.readFile(apiReportAlphaPath)

diff --git a/scripts/list-frontend-feature.js b/scripts/list-frontend-feature.js
@@ -58,14 +58,14 @@ async function main(args) {
         frontendFeatureReport.package = pkg.packageJson.name;
         frontendFeatureReport.role = pkgRole;
         frontendFeatureReport.readme = `[README](${pkg.packageJson.repository.url}/blob/master/${pkg.packageJson.repository.directory}/README.md)`;
-        const apiReportPath = join(pkg.dir, 'api-report.md');
+        const apiReportPath = join(pkg.dir, 'report.api.md');
         const apiReport = (await fs.readFile(apiReportPath)).toString();
         if (apiReport.includes(BACKSTAGE_PLUGIN)) {
           frontendFeatureReport.supported = true;
           frontendFeatureReport.alpha = false;
         }
 
-        const apiReportAlphaPath = join(pkg.dir, 'api-report-alpha.md');
+        const apiReportAlphaPath = join(pkg.dir, 'report-alpha.api.md');
         if (fs.existsSync(apiReportAlphaPath)) {
           const apiReportAlpha = (
             await fs.readFile(apiReportAlphaPath)

diff --git a/scripts/list-workspaces-for-docs.js b/scripts/list-workspaces-for-docs.js
@@ -52,10 +52,12 @@ async function main(args) {
       o => o !== '@backstage/community-plugins-maintainers',
     );
     filteredOwners.forEach((owner, index) => {
-      if (owner === '@backstage/sda-se-reviewers') {
+      if (owner.includes('/')) {
+        const org = owner.substring(1, owner.indexOf('/'));
+        const team = owner.substring(owner.indexOf('/') + 1);
         filteredOwners[
           index
-        ] = `[@backstage/sda-se-reviewers](https://github.com/orgs/backstage/teams/sda-se-reviewers)`;
+        ] = `[${owner}](https://github.com/orgs/${org}/teams/${team})`;
       } else {
         filteredOwners[
           index