Skip to content

Commit b43a167

Browse files
committed
ADD: Add TechDocs documentation for CODE-IDP platform
1 parent aa2cd92 commit b43a167

File tree

5 files changed

+728
-19
lines changed

5 files changed

+728
-19
lines changed

app-config.yaml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,11 +41,7 @@ techdocs:
4141
generator:
4242
runIn: 'local'
4343
publisher:
44-
type: 'googleGcs'
45-
googleGcs:
46-
bucketName: 'backstage-codeidp-techdocs'
47-
projectId: code-idp
48-
credentials: ${TECHDOCS_GCS_CREDENTIALS}
44+
type: 'local'
4945

5046
# scaffolder:
5147

mkdocs.yml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,15 @@ site_description: This is the user guide for the CODE-IDP platform.
33
docs_dir: docs
44
nav:
55
- Overview:
6-
- Introduction: 'index.md'
6+
- Introduction: 'index.md'
77
- Components:
8-
- Register Your Software Component: 'how-to-register-a-component.md'
9-
- Technical Documentation:
10-
- Publish Your Docs: 'how-to-publish-documentation.md'
8+
- Register Your Software Component: 'how-to-register-a-component.md'
9+
- Technical Documentation:
10+
- Publish Your Docs: 'how-to-publish-documentation.md'
11+
- Deployment:
12+
- How to Deploy Your App: 'how-to-deploy-your-app.md'
1113
- CHANGELOG: 'CHANGELOG.md'
1214

13-
plugins:
15+
plugins:
1416
- techdocs-core
1517
- include-markdown

package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@
4949
"@backstage/e2e-test-utils": "^0.1.1",
5050
"@playwright/test": "^1.32.3",
5151
"@spotify/prettier-config": "^12.0.0",
52+
"@techdocs/cli": "^1.9.8",
5253
"@testing-library/react": "^16.2.0",
5354
"@types/babel__core": "^7.1.20",
5455
"@types/babel__preset-env": "^7.4.7",

tsconfig.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
],
1111
"exclude": ["node_modules"],
1212
"compilerOptions": {
13+
"moduleResolution": "bundler",
1314
"outDir": "dist-types",
1415
"rootDir": "."
1516
}

0 commit comments

Comments
 (0)