fix: replace apl-docs with techdocs (#750)

Author: dennisvankekem

src/openapi/api.yaml

@@ -10,7 +10,7 @@ servers:
 
 externalDocs:
   description: 'This is the base url of the external documentation'
-  url: https://apl-docs.net/ #Using this URL a final docUrl can be made using this+info.version+ the component's x-externalDocsPath
+  url: https://techdocs.akamai.com/app-platform/docs/ #Using this URL a final docUrl can be made using this+info.version+ the component's x-externalDocsPath
 
 x-responses:
   BadRequest: &BadRequest

src/openapi/backup.yaml

@@ -17,7 +17,7 @@ Backup:
       - delete
   type: object
   description: Create Velero backup schedules for Persistent Volumes.
-  x-externalDocsPath: docs/for-devs/console/backups
+  x-externalDocsPath: disaster-recovery
   properties:
     id:
       type: string

src/openapi/build.yaml

@@ -16,7 +16,7 @@ Build:
       - update
       - delete
   type: object
-  x-externalDocsPath: docs/for-devs/console/builds
+  x-externalDocsPath: team-container-images
   properties:
     id:
       type: string

src/openapi/cloudtty.yaml

@@ -16,7 +16,7 @@ Cloudtty:
       - update-any
       - delete-any
   type: object
-  x-externalDocsPath: docs/for-devs/console/cloudtty
+  x-externalDocsPath: shell-tty
   properties:
     iFrameUrl:
       $ref: 'definitions.yaml#/wordCharacterPattern'

src/openapi/netpol.yaml

@@ -16,7 +16,7 @@ Netpol:
       - update
       - delete
   type: object
-  x-externalDocsPath: docs/for-devs/console/netpols
+  x-externalDocsPath: team-network-policies
   properties:
     id:
       type: string

src/openapi/policies.yaml

@@ -155,7 +155,7 @@ Policy:
       - update
       - delete
   type: object
-  x-externalDocsPath: docs/for-devs/console/policies
+  x-externalDocsPath: team-security-policies
   properties:
     action:
       type: string

src/openapi/service.yaml

@@ -15,7 +15,7 @@ Service:
       - read
       - update
       - delete
-  x-externalDocsPath: docs/for-devs/console/services
+  x-externalDocsPath: team-services
   properties:
     id:
       type: string
@@ -238,10 +238,10 @@ AplServiceSpec:
           title: Weight v2
           description: 'Percentage of traffic to version 2.'
     ingressClassName:
-          description: Assign service to a paricular Load Balancer by selecting ingress class name.
-          title: Ingress Class Name
-          $ref: 'definitions.yaml#/idName'
-          default: 'platform'
+      description: Assign service to a paricular Load Balancer by selecting ingress class name.
+      title: Ingress Class Name
+      $ref: 'definitions.yaml#/idName'
+      default: 'platform'
     tlsPass:
       description: Pass through the request as is to the backing service. Only available for pre-deployed regular (non-Knative) services.
       title: TLS passthrough

test/apps.yaml

@@ -5,8 +5,7 @@ appsInfo:
     repo: https://github.com/prometheus/alertmanager
     maintainers: Prometheus Community
     relatedLinks:
-      - https://apl-docs.net/docs/apps/alertmanager
-      - https://prometheus.io/docs/alerting/latest/alertmanager]
+      - https://prometheus.io/docs/alerting/latest/alertmanager
     license: Apache 2.0
     dependencies: Prometheus
     about: Alertmanager handles alerts sent by client applications such as the Prometheus server. It takes care of de-duplicating, grouping, and routing them to the correct receiver integration such as email, PagerDuty, or OpsGenie. Alertmanager also takes care of silencing and inhibition of alerts.
@@ -17,7 +16,6 @@ appsInfo:
     repo: https://github.com/argoproj/argo-helm
     maintainers: Argo Project
     relatedLinks:
-      - https://apl-docs.net/docs/apps/argocd
       - https://argo-cd.readthedocs.io
     license: Apache 2.0
     dependencies: None
@@ -29,7 +27,6 @@ appsInfo:
     repo: https://github.com/cert-manager/cert-manager
     maintainers: The Linux Foundation
     relatedLinks:
-      - https://apl-docs.net/docs/apps/certmanager
       - https://cert-manager.io/
     license: Apache 2.0
     about: Cert-manager adds certificates and certificate issuers as resource types in Kubernetes clusters, and simplifies the process of obtaining, renewing and using those certificates. It can issue certificates from a variety of supported sources, including Let's Encrypt, HashiCorp Vault, and Venafi as well as private PKI, and it ensures certificates remain valid and up to date, attempting to renew certificates at an appropriate time before expiry.
@@ -51,7 +48,6 @@ appsInfo:
     repo: https://github.com/harness/drone
     maintainers: Harness
     relatedLinks:
-      - https://apl-docs.net/docs/apps/drone
       - https://www.drone.io/
     license: Apache 2.0
     about: Drone is a continuous delivery system built on container technology. Drone uses a simple YAML build file, to define and execute build pipelines inside Docker containers.
@@ -80,7 +76,6 @@ appsInfo:
     repo: https://github.com/kubernetes-sigs/external-dns
     maintainers: Kubernetes SIGs
     relatedLinks:
-      - https://apl-docs.net/docs/apps/external-dns
       - https://kubernetes-sigs.github.io/external-dns/v0.12.2/
     license: Apache 2.0
     about: ExternalDNS synchronizes exposed Kubernetes Services and Ingresses with DNS providers.
@@ -91,7 +86,6 @@ appsInfo:
     repo: https://github.com/external-secrets/external-secrets
     maintainers: External Secrets community
     relatedLinks:
-      - https://apl-docs.net/docs/apps/external-secrets
       - https://external-secrets.io
     license: Apache 2.0
     about: External Secrets Operator reads information from a third-party service like AWS Secrets Manager and automatically injects the values as Kubernetes Secrets.
@@ -102,7 +96,6 @@ appsInfo:
     repo: https://github.com/falcosecurity/falco
     maintainers: The Falco Authors
     relatedLinks:
-      - https://apl-docs.net/docs/apps/falco
       - https://falco.org/docs
     license: Apache 2.0
     dependencies: None. Prometheus and Grafana are adviced
@@ -114,7 +107,6 @@ appsInfo:
     repo: https://github.com/open-policy-agent/gatekeeper
     maintainers: Open Policy Agent
     relatedLinks:
-      - https://apl-docs.net/docs/apps/gatekeeper
       - https://open-policy-agent.github.io/gatekeeper/website/docs/
     license: Apache 2.0
     dependencies: None. Prometheus and Grafana are adviced.
@@ -126,7 +118,6 @@ appsInfo:
     repo: https://github.com/go-gitea/gitea
     maintainers: Gitea
     relatedLinks:
-      - https://apl-docs.net/docs/apps/gitea
       - https://docs.gitea.io/en-us/
     license: MIT
     about: Gitea is a painless self-hosted Git service. It is similar to GitHub, Bitbucket, and GitLab. Gitea is a fork of Gogs. See the Gitea Announcement blog post to read about the justification for a fork.
@@ -137,7 +128,6 @@ appsInfo:
     repo: https://github.com/grafana/grafana
     maintainers: Grafana Labs
     relatedLinks:
-      - https://apl-docs.net/docs/apps/grafana
       - https://grafana.com/docs/grafana/latest/
     license: AGPL-3.0
     dependencies: Prometheus
@@ -149,7 +139,6 @@ appsInfo:
     repo: https://github.com/goharbor/harbor
     maintainers: Project Harbor
     relatedLinks:
-      - https://apl-docs.net/docs/apps/harbor
       - https://goharbor.io/docs/2.6.0/
     license: Apache 2.0
     dependencies: None
@@ -170,7 +159,8 @@ appsInfo:
     appVersion: 1.7.1
     repo: https://github.com/kubernetes/ingress-nginx
     maintainers: NGINX
-    relatedLinks: ['https://apl-docs.net/docs/apps/ingress-nginx', 'https://docs.nginx.com/nginx-ingress-controller/']
+    relatedLinks:
+      - https://docs.nginx.com/nginx-ingress-controller
     license: Apache 2.0
     about: ingress-nginx is an Ingress controller for Kubernetes using NGINX as a reverse proxy and load balancer.
     integration: Otomi integrated ingress-nginx into an advanced ingress architecture.
@@ -180,7 +170,6 @@ appsInfo:
     repo: https://github.com/istio/istio
     maintainers: Istio
     relatedLinks:
-      - https://apl-docs.net/docs/apps/istio
       - https://istio.io/
     license: Apache 2.0
     about: Istio is an open platform for providing a uniform way to integrate microservices, manage traffic flow across microservices, enforce policies and aggregate telemetry data. Istio's control plane provides an abstraction layer over the underlying cluster management platform.
@@ -192,7 +181,6 @@ appsInfo:
     repo: https://github.com/jaegertracing/jaeger
     maintainers: CNCF
     relatedLinks:
-      - https://apl-docs.net/docs/apps/jaeger
       - https://www.jaegertracing.io/docs/1.37/
     license: Apache 2.0
     about: Jaeger is a distributed tracing platform. It can be used for monitoring microservices-based distributed systems. As on-the-ground microservice practitioners are quickly realizing, the majority of operational problems that arise when moving to a distributed architecture are ultimately grounded in networking and observability. It is simply an orders of magnitude larger problem to network and debug a set of intertwined distributed services versus a single monolithic application.
@@ -203,7 +191,6 @@ appsInfo:
     repo: https://github.com/keycloak/keycloak
     maintainers: Keycloak
     relatedLinks:
-      - https://apl-docs.net/docs/apps/keycloak
       - https://www.keycloak.org/documentation.html
     license: Apache 2.0
     about: Keycloak is an Open Source Identity and Access Management solution for modern Applications and Services.
@@ -226,7 +213,6 @@ appsInfo:
     repo: https://github.com/knative/serving
     maintainers: Knative
     relatedLinks:
-      - https://apl-docs.net/docs/apps/knative
       - https://knative.dev/docs/serving/
     license: Apache 2.0
     about: Knative Serving builds on Kubernetes to support deploying and serving of applications and functions as serverless containers. Serving is easy to get started with and scales to support advanced scenarios.
@@ -237,7 +223,6 @@ appsInfo:
     repo: https://github.com/kyverno/kyverno
     maintainers: Knative
     relatedLinks:
-      - https://apl-docs.net/docs/apps/kyverno
       - https://kyverno.io/docs/kyverno-policies/
     license: Apache 2.0
     about: Kyverno is a policy engine designed for Kubernetes. It can validate, mutate, and generate configurations using admission controls and background scans. Kyverno policies are Kubernetes resources and do not require learning a new language.
@@ -247,7 +232,6 @@ appsInfo:
     repo: https://github.com/kubereboot/kured
     maintainers: Kured project
     relatedLinks:
-      - https://apl-docs.net/docs/apps/kured
       - https://kured.dev/
     license: Apache 2.0
     about: Kured (KUbernetes REboot Daemon) is a Kubernetes daemonset that performs safe automatic node reboots when the need to do so is indicated by the package management system of the underlying OS.
@@ -258,7 +242,6 @@ appsInfo:
     repo: https://github.com/tektoncd/pipeline
     maintainers: Tekton
     relatedLinks:
-      - https://apl-docs.net/docs/apps/tekton
       - https://github.com/tektoncd/pipeline/blob/main/docs/README.md
       - https://github.com/tektoncd/catalog/tree/main/task/buildpacks/0.6
       - https://github.com/tektoncd/catalog/tree/main/task/git-clone/0.9
@@ -273,7 +256,6 @@ appsInfo:
     repo: https://github.com/grafana/loki
     maintainers: Grafana Labs
     relatedLinks:
-      - https://apl-docs.net/docs/apps/loki
       - https://grafana.com/docs/loki/latest/
     license: AGPL-3.0
     dependencies: Prometheus, Grafana, Minio (if no external Object Storage is used)
@@ -285,7 +267,6 @@ appsInfo:
     repo: https://github.com/minio/minio
     maintainers: Minio
     relatedLinks:
-      - https://apl-docs.net/docs/apps/minio
       - https://minio.io/
     license: Apache 2.0
     dependencies: None
@@ -297,7 +278,6 @@ appsInfo:
     repo: https://github.com/prometheus/prometheus
     maintainers: Prometheus
     relatedLinks:
-      - https://apl-docs.net/docs/apps/prometheus
       - https://prometheus.io/
     license: Apache 2.0
     about: Prometheus is a systems and service monitoring system. It collects metrics from configured targets at given intervals, evaluates rule expressions, displays the results, and can trigger alerts when specified conditions are observed.
@@ -321,7 +301,6 @@ appsInfo:
     repo: https://github.com/bitnami-labs/sealed-secrets
     maintainers: Bitnami Labs
     relatedLinks:
-      - https://apl-docs.net/docs/apps/sealed-secrets
       - https://github.com/bitnami-labs/sealed-secrets/tree/main/docs
     license: Apache 2.0
     about: Sealed Secrets is a Kubernetes Custom Resource Definition Controller which allows you to store even sensitive information in Git repositories.
@@ -343,7 +322,6 @@ appsInfo:
     repo: https://github.com/aquasecurity/trivy-operator
     maintainers: Aqua Security
     relatedLinks:
-      - https://apl-docs.net/docs/apps/trivy-operator
       - https://aquasecurity.github.io/trivy-operator/v0.16.4/
     license: Apache 2.0
     dependencies: Prometheus, Grafana
@@ -355,7 +333,6 @@ appsInfo:
     repo: https://github.com/open-telemetry/opentelemetry-operator
     maintainers: Grafana labs
     relatedLinks:
-      - https://apl-docs.net/docs/apps/otel
       - https://opentelemetry.io/docs/collector/
     license: AGPL-3.0
     dependencies: Prometheus, Grafana, Loki, Tempo
@@ -367,7 +344,6 @@ appsInfo:
     repo: https://github.com/vmware-tanzu/velero
     maintainers: VMware Tanzu
     relatedLinks:
-      - https://apl-docs.net/docs/apps/velero
       - https://velero.io/docs/v1.9/
       - https://velero.io/docs/main/restic/
     license: Apache 2.0