feat: setup docs (#98)

* ADD: prod configurations

* ADD: migrate scaffolder plugin for github

* UPD: update database config

* UPD: techdocs config

* UPD: techdocs config

* UPD: fix errors

* UPD: fix errors

* UPD: fix dependencies issues

* UPD: fix Dockerfile issue

* UPD: fix Dockerfile commandas

* ADD: Add TechDocs documentation for CODE-IDP platform

Author: NewerKey

.github/workflows/cd-workflow.yaml

@@ -69,29 +69,9 @@ jobs:
         uses: 'google-github-actions/auth@v2'
         with:
           create_credentials_file: true
-          workload_identity_provider: 'projects/1006240973223/locations/global/workloadIdentityPools/deploy-backstage/providers/github-actions'
-          service_account: '[email protected]'
-      - id: 'deploy'
-        uses: 'google-github-actions/deploy-cloudrun@v2'
         with:
           service: 'backstage-deployment'
           image: 'europe-west10-docker.pkg.dev/code-idp/backstage-deploy/backstage-image:${{ github.sha }}'
           region: europe-west10
           flags: |
             --port=7007
-            --allow-unauthenticated
-            --add-cloudsql-instances=code-idp:europe-west10:backstage-pg
-          env_vars: |
-            POSTGRES_HOST=/cloudsql/code-idp:europe-west10:backstage-pg
-            POSTGRES_PORT=5432
-            POSTGRES_USER=postgres
-            POSTGRES_DB=postgres
-          secrets: |
-            POSTGRES_PASSWORD=postgres_password:latest
-            GITHUB_TOKEN=github_token:latest
-            GOOGLE_CLIENT_ID=google_client_id:latest
-            GOOGLE_CLIENT_SECRET=google_client_secret:latest
-            GITHUB_CLIENT_ID=github_client_id:latest
-            GITHUB_CLIENT_SECRET=github_client_secret:latest
-            GITLAB_TOKEN=gitlab_token:latest
-            TECHDOCS_GCS_CREDENTIALS=techdocs_gcs_credentials:latest

.github/workflows/techdocs-gcs.yml

@@ -16,30 +16,13 @@ jobs:
         node-version: ['20.x']
 
     env: 
-        TECHDOCS_BUCKET_NAME: backstage-codeidp-techdocs
-        TECHDOCS_GCS_CREDENTIALS: ${{ secrets.TECHDOCS_GCS_CREDENTIALS }}
-        TECHDOCS_REGION: europe-west10
         ENTITY_NAMESPACE: 'default'
         ENTITY_KIND: 'Component'
         ENTITY_NAME: 'code-idp-docs'
 
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-
-      - uses: actions/setup-node@v3
-      - uses: actions/setup-python@v4
-        with:
-          python-version: '3.9'
-
-      - name: Install techdocs-cli
-        run: sudo npm install -g @techdocs/cli
-
-      - name: Install mkdocs and required plugins
-        run: |
-          python3 -m pip install mkdocs-techdocs-core==1.*
-          python3 -m pip install mkdocs-include-markdown-plugin
-
 
       - name: Generate docs site
         run: techdocs-cli generate --no-docker --verbose

Dockerfile

@@ -27,7 +27,16 @@ ENV PYTHON=/usr/bin/python3
 RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
     --mount=type=cache,target=/var/lib/apt,sharing=locked \
     apt-get update && \
-    apt-get install -y --no-install-recommends python3 g++ build-essential && \
+    apt-get install -y --no-install-recommends \
+        python3 \
+        g++ \
+        build-essential \
+        libcairo2-dev \
+        libpango1.0-dev \
+        libjpeg-dev \
+        libgif-dev \
+        librsvg2-dev \
+        pkg-config && \
     rm -rf /var/lib/apt/lists/*
 
 # Enable Corepack (for Yarn management) and install the required Yarn version
@@ -48,6 +57,7 @@ COPY --from=packages --chown=node:node /app/backstage.json ./
 RUN mkdir -p /home/node/.cache/node/corepack/v1 && \
     chown -R node:node /home/node/.cache
 
+
 #ENV CYPRESS_INSTALL_BINARY=0
 #RUN yarn install --immutable --network-timeout 600000
 RUN --mount=type=cache,target=/home/node/.cache/yarn,sharing=locked,uid=1000,gid=1000 \

app-config.production.yaml

@@ -1,10 +1,10 @@
 app:
-  baseUrl: https://backstage-deployment-1006240973223.europe-west10.run.app
+  baseUrl: https://backstage.foundations-software-engineering.com
 
 backend:
-  baseUrl: https://backstage-deployment-1006240973223.europe-west10.run.app
+  baseUrl: https://backstage.foundations-software-engineering.com
   cors:
-    origin: https://backstage-deployment-1006240973223.europe-west10.run.app
+    origin: https://backstage.foundations-software-engineering.com
     methods: [GET, HEAD, PATCH, POST, PUT, DELETE]
     credentials: true
 

app-config.yaml

@@ -42,11 +42,7 @@ techdocs:
   generator:
     runIn: 'local'
   publisher:
-    type: 'googleGcs'
-    googleGcs:
-      bucketName: 'backstage-codeidp-techdocs' 
-      projectId: code-idp
-      credentials: ${TECHDOCS_GCS_CREDENTIALS}
+    type: 'local'
 
 # scaffolder:
 

docs/mkdocs.yml

@@ -0,0 +1,4 @@
+site_name: Documentation Site
+docs_dir: docs
+plugins:
+  - techdocs-core

mkdocs.yml

@@ -3,13 +3,10 @@ site_description: This is the user guide for the CODE-IDP platform.
 docs_dir: docs
 nav:
   - Overview:
-    - Introduction: 'index.md'
+      - Introduction: 'index.md'
   - Components:
-    - Register Your Software Component: 'how-to-register-a-component.md'
-  - Technical Documentation: 
-    - Publish Your Docs: 'how-to-publish-documentation.md'
   - CHANGELOG: 'CHANGELOG.md'
 
-plugins: 
+plugins:
   - techdocs-core
   - include-markdown

package.json

@@ -49,6 +49,7 @@
     "@backstage/e2e-test-utils": "^0.1.1",
     "@playwright/test": "^1.32.3",
     "@spotify/prettier-config": "^12.0.0",
+    "@techdocs/cli": "^1.9.8",
     "@testing-library/react": "^16.2.0",
     "@types/babel__core": "^7.1.20",
     "@types/babel__preset-env": "^7.4.7",

tsconfig.json

@@ -10,6 +10,7 @@
   ],
   "exclude": ["node_modules"],
   "compilerOptions": {
+    "moduleResolution": "bundler",
     "outDir": "dist-types",
     "rootDir": "."
   }