Merge pull request 'docs: link entities to platform-docs READMEs' (#5) from documentor-annotations-9e0e917a into main

Reviewed-on: #5

README.md

@@ -21,3 +21,5 @@ is migrated to a different runtime.
 | `runtime` | `typescript-nestjs` |
 | `health_path` | `/health` |
 | `container_port` | `3000` |
+
+

catalog-info.yaml

@@ -6,62 +6,56 @@ metadata:
   annotations:
     humanitec.com/orgId: skillful-wild-chicken-2617
     humanitec.com/projectId: domain-demo-apps
-    cjot.io/target-domain: "demo-apps"
+    cjot.io/target-domain: demo-apps
     backstage.io/techdocs-ref: dir:.
     backstage.io/kubernetes-namespace: dev
-    backstage.io/kubernetes-namespaces: "dev"
+    backstage.io/kubernetes-namespaces: dev
-    backstage.io/kubernetes-label-selector: "app=sonar-test-nest4"
+    backstage.io/kubernetes-label-selector: app=sonar-test-nest4
-    gitea.kyndemo.live/repo-slug: "validate/sonar-test-nest4"
+    gitea.kyndemo.live/repo-slug: validate/sonar-test-nest4
     sonarqube.org/project-key: sonar-test-nest4
-    prometheus.io/scrape: "true"
+    prometheus.io/scrape: 'true'
-    prometheus.io/port: "3000"
+    prometheus.io/port: '3000'
-    prometheus.io/path: "/metrics"
+    prometheus.io/path: /metrics
     grafana/grafana-instance: default
-    grafana/alert-label-selector: "app=sonar-test-nest4"
+    grafana/alert-label-selector: app=sonar-test-nest4
-    
+    grafana/dashboard-selector: uid == 'otel-app-observability-v2'
-    grafana/dashboard-selector: "uid == 'otel-app-observability-v2'"
+    grafana.com/alert-label-selector: app=sonar-test-nest4
-    grafana.com/alert-label-selector: "app=sonar-test-nest4"
+    grafana.com/dashboard-url: 
-    grafana.com/dashboard-url: "https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4"
+      https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4
-    chaos-mesh/enabled: "true"
+    chaos-mesh/enabled: 'true'
-    
+    k6/enabled: 'true'
-    
+    k6/test-configmap: k6-test-sonar-test-nest4
-    k6/enabled: "true"
+    k6/test-namespace: dev
-    k6/test-configmap: "k6-test-sonar-test-nest4"
+    k6/target-service: sonar-test-nest4
-    k6/test-namespace: "dev"
+    k6/target-port: '3000'
-    k6/target-service: "sonar-test-nest4"
+    docs.kyndemo.live/readme: 
-    k6/target-port: "3000"
+      catalog/component/default/sonar-test-nest4/README.md
-    
   tags:
-    - microservice
+  - microservice
-    - golden-path
+  - golden-path
-    - typescript-nestjs
+  - typescript-nestjs
-    - stateless
+  - stateless
-    
+  - opentelemetry
-    - opentelemetry
+  - load-testing
-    
+  - k6
-    
-    - load-testing
-    - k6
-    
   links:
-    - url: https://console.humanitec.dev/orgs/skillful-wild-chicken-2617/projects/domain-demo-apps
+  - url: 
-      title: Humanitec Console
+      https://console.humanitec.dev/orgs/skillful-wild-chicken-2617/projects/domain-demo-apps
-      icon: dashboard
+    title: Humanitec Console
-    
+    icon: dashboard
-    - url: https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4
+  - url: 
-      title: Grafana Dashboard
+      https://grafana.kyndemo.live/d/otel-app-observability-v2/opentelemetry-application-observability?orgId=1&var-app=sonar-test-nest4
-      icon: dashboard
+    title: Grafana Dashboard
-    
+    icon: dashboard
-    - url: https://gitea.kyndemo.live/validate/sonar-test-nest4
+  - url: https://gitea.kyndemo.live/validate/sonar-test-nest4
-      title: Source Repository
+    title: Source Repository
-      icon: github
+    icon: github
 spec:
   type: service
   owner: group:default/platform-engineering
-  
   lifecycle: experimental
   providesApis:
-    - sonar-test-nest4-api
+  - sonar-test-nest4-api
 ---
 apiVersion: backstage.io/v1alpha1
 kind: API
@@ -74,66 +68,20 @@ spec:
   type: openapi
   lifecycle: experimental
   owner: group:default/platform-engineering
-  
+  definition: "openapi: \"3.0.0\"\ninfo:\n  title: sonar-test-nest4\n  version: \"\
-  definition: |
+    0.1.0\"\n  description: \"sonar-test-nest4\"\nservers:\n  - url: https://sonar-test-nest4.kyndemo.live\n\
-    openapi: "3.0.0"
+    paths:\n  /api/items:\n    get:\n      summary: List all items\n      responses:\n\
-    info:
+    \        \"200\":\n          description: OK\n    post:\n      summary: Create
-      title: sonar-test-nest4
+    item\n      responses:\n        \"201\":\n          description: Created\n  /api/items/{id}:\n\
-      version: "0.1.0"
+    \    get:\n      summary: Get by ID\n      parameters:\n        - name: id\n \
-      description: "sonar-test-nest4"
+    \         in: path\n          required: true\n          schema:\n            type:
-    servers:
+    integer\n      responses:\n        \"200\":\n          description: OK\n     \
-      - url: https://sonar-test-nest4.kyndemo.live
+    \   \"404\":\n          description: Not found\n    put:\n      summary: Update
-    paths:
+    item\n      parameters:\n        - name: id\n          in: path\n          required:
-      /api/items:
+    true\n          schema:\n            type: integer\n      responses:\n       \
-        get:
+    \ \"200\":\n          description: OK\n    delete:\n      summary: Update item\n\
-          summary: List all items
+    \      parameters:\n        - name: id\n          in: path\n          required:
-          responses:
+    true\n          schema:\n            type: integer\n      responses:\n       \
-            "200":
+    \ \"200\":\n          description: Deleted\n  /health:\n    get:\n      summary:
-              description: OK
+    Health check\n      responses:\n        \"200\":\n          description: \"{ status:
-        post:
+    UP }\"\n"
-          summary: Create item
-          responses:
-            "201":
-              description: Created
-      /api/items/{id}:
-        get:
-          summary: Get by ID
-          parameters:
-            - name: id
-              in: path
-              required: true
-              schema:
-                type: integer
-          responses:
-            "200":
-              description: OK
-            "404":
-              description: Not found
-        put:
-          summary: Update item
-          parameters:
-            - name: id
-              in: path
-              required: true
-              schema:
-                type: integer
-          responses:
-            "200":
-              description: OK
-        delete:
-          summary: Update item
-          parameters:
-            - name: id
-              in: path
-              required: true
-              schema:
-                type: integer
-          responses:
-            "200":
-              description: Deleted
-      /health:
-        get:
-          summary: Health check
-          responses:
-            "200":
-              description: "{ status: UP }"

docs/architecture.md

@@ -18,6 +18,9 @@ Push to dev/staging/prod
   → deploy-humanitec.yml (hctl score deploy)
 ```
 
+## Deployment alternative method
+
+
 ## Branch model
 
 | Branch | Purpose |