Skip to content

Commit 184ec6d

Browse files
authored
Updated Documentation in /docs folder (backstage#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]>
1 parent c9e8956 commit 184ec6d

File tree

8 files changed

+354
-276
lines changed

8 files changed

+354
-276
lines changed

docs/README.md

Lines changed: 202 additions & 0 deletions
Large diffs are not rendered by default.

docs/compatibility/compatibility.md

Lines changed: 96 additions & 75 deletions
Large diffs are not rendered by default.

docs/compatibility/new-backend-system.md

Lines changed: 21 additions & 2 deletions
Large diffs are not rendered by default.

docs/compatibility/new-frontend-system.md

Lines changed: 27 additions & 13 deletions
Large diffs are not rendered by default.

docs/index.md

Lines changed: 0 additions & 180 deletions
This file was deleted.

scripts/list-backend-feature.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ async function main(args) {
6060
backendFeatureReport.package = pkg.packageJson.name;
6161
backendFeatureReport.role = pkgRole;
6262
backendFeatureReport.readme = `[README](${pkg.packageJson.repository.url}/blob/master/${pkg.packageJson.repository.directory}/README.md)`;
63-
const apiReportPath = join(pkg.dir, 'api-report.md');
63+
const apiReportPath = join(pkg.dir, 'report.api.md');
6464
const apiReport = (await fs.readFile(apiReportPath)).toString();
6565
if (
6666
apiReport.includes(BACKEND_FEATURE) ||
@@ -70,7 +70,7 @@ async function main(args) {
7070
backendFeatureReport.alpha = false;
7171
}
7272

73-
const apiReportAlphaPath = join(pkg.dir, 'api-report-alpha.md');
73+
const apiReportAlphaPath = join(pkg.dir, 'report-alpha.api.md');
7474
if (fs.existsSync(apiReportAlphaPath)) {
7575
const apiReportAlpha = (
7676
await fs.readFile(apiReportAlphaPath)

scripts/list-frontend-feature.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,14 @@ async function main(args) {
5858
frontendFeatureReport.package = pkg.packageJson.name;
5959
frontendFeatureReport.role = pkgRole;
6060
frontendFeatureReport.readme = `[README](${pkg.packageJson.repository.url}/blob/master/${pkg.packageJson.repository.directory}/README.md)`;
61-
const apiReportPath = join(pkg.dir, 'api-report.md');
61+
const apiReportPath = join(pkg.dir, 'report.api.md');
6262
const apiReport = (await fs.readFile(apiReportPath)).toString();
6363
if (apiReport.includes(BACKSTAGE_PLUGIN)) {
6464
frontendFeatureReport.supported = true;
6565
frontendFeatureReport.alpha = false;
6666
}
6767

68-
const apiReportAlphaPath = join(pkg.dir, 'api-report-alpha.md');
68+
const apiReportAlphaPath = join(pkg.dir, 'report-alpha.api.md');
6969
if (fs.existsSync(apiReportAlphaPath)) {
7070
const apiReportAlpha = (
7171
await fs.readFile(apiReportAlphaPath)

scripts/list-workspaces-for-docs.js

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,12 @@ async function main(args) {
5252
o => o !== '@backstage/community-plugins-maintainers',
5353
);
5454
filteredOwners.forEach((owner, index) => {
55-
if (owner === '@backstage/sda-se-reviewers') {
55+
if (owner.includes('/')) {
56+
const org = owner.substring(1, owner.indexOf('/'));
57+
const team = owner.substring(owner.indexOf('/') + 1);
5658
filteredOwners[
5759
index
58-
] = `[@backstage/sda-se-reviewers](https://github.com/orgs/backstage/teams/sda-se-reviewers)`;
60+
] = `[${owner}](https://github.com/orgs/${org}/teams/${team})`;
5961
} else {
6062
filteredOwners[
6163
index

0 commit comments

Comments
 (0)