From 206a65cbfe57482b8ff2c53450776889d06682c8 Mon Sep 17 00:00:00 2001 From: Kostis Trantzas <ktrantzas@ece.upatras.gr> Date: Mon, 29 Jul 2024 19:17:59 +0300 Subject: [PATCH] fix documentation broken links #9 --- doc/architecture/CRIDGE/CRIDGEforDevelopers.md | 6 +++--- doc/portals_intro.md | 12 ++++++------ .../kubernetes/ExposingKubernetesResources.md | 7 ++++--- doc/service_design/kubernetes/helm/design_helmaas.md | 8 ++++---- doc/service_design/lcmrules/intro.md | 2 +- 5 files changed, 18 insertions(+), 17 deletions(-) diff --git a/doc/architecture/CRIDGE/CRIDGEforDevelopers.md b/doc/architecture/CRIDGE/CRIDGEforDevelopers.md index 10cd9ac4..0e5fc894 100644 --- a/doc/architecture/CRIDGE/CRIDGEforDevelopers.md +++ b/doc/architecture/CRIDGE/CRIDGEforDevelopers.md @@ -216,9 +216,9 @@ OSOM sends to CRIDGE a message with the following information: ## Probe further - - See examples of exposing operators via OpenSlice: - - [Exposing Kubernetes Operators as a Service : Offering "Calculator as a Service" through OpenSlice](../../service_design/examples/ExposingCRDs_aaS_Example_Calculator/ExposingCRDs_aaS_Example_Calculator.md) - +- See examples of exposing Kubernetes Operators as a Service via OpenSlice: + - [Offering "Calculator as a Service"](../../service_design/examples/ExposingCRDs_aaS_Example_Calculator/ExposingCRDs_aaS_Example_Calculator.md) + - [Offering "Helm installation as a Service" (Jenkins example)](../../service_design/examples/helmInstallation_aaS_Example_Jenkins/HELM_Installation_aaS_Jenkins_Example.md) diff --git a/doc/portals_intro.md b/doc/portals_intro.md index 995cb5de..9cc36e19 100644 --- a/doc/portals_intro.md +++ b/doc/portals_intro.md @@ -1,12 +1,12 @@ # OpenSlice Portals -OpenSlice comprises of a web landing page [(See Demo)](http://portal.openslice.io/) that navigates to the respective Portals: +OpenSlice comprises of a web landing page (See [Demo](http://portal.openslice.io/)) that navigates to the respective Portals: -- Services Portal [(See Demo)](http://portal.openslice.io/services) -- NFV Portal [(See Demo)](http://portal.openslice.io/nfvportal) -- Products Portal [(See Demo)](http://portal.openslice.io/products) -- Testing Portal [(See Demo)](http://portal.openslice.io/testing) -- Resources Portal [(See Demo)](http://portal.openslice.io/resources) +- Services Portal (See [Demo](http://portal.openslice.io/services)) +- NFV Portal (See [Demo](http://portal.openslice.io/nfvportal)) +- Products Portal (See [Demo](http://portal.openslice.io/products)) +- Testing Portal (See [Demo](http://portal.openslice.io/testing)) +- Resources Portal (See [Demo](http://portal.openslice.io/resources)) Following you may find the scope each portal focuses on and the main TMF APIs it supports: diff --git a/doc/service_design/kubernetes/ExposingKubernetesResources.md b/doc/service_design/kubernetes/ExposingKubernetesResources.md index ade87388..82112b8b 100644 --- a/doc/service_design/kubernetes/ExposingKubernetesResources.md +++ b/doc/service_design/kubernetes/ExposingKubernetesResources.md @@ -159,9 +159,10 @@ OpenSlice adds automatically as we see the following characteristics: ## Probe further - - See examples of exposing operators via OpenSlice: - - [Exposing Kubernetes Operators as a Service : Offering "Calculator as a Service" through OpenSlice](ExposingCRDs_aaS_Example_Calculator.md) - - [Learn more about CRIDGE, the service in OSL that manages CRDs/CRs](CRIDGEforDevelopers_Jenkins_Example.md) +- See examples of exposing Kubernetes Operators as a Service via OpenSlice: + - [Offering "Calculator as a Service"](../examples/ExposingCRDs_aaS_Example_Calculator/ExposingCRDs_aaS_Example_Calculator.md) + - [Offering "Helm installation as a Service" (Jenkins example)](../examples/helmInstallation_aaS_Example_Jenkins/HELM_Installation_aaS_Jenkins_Example.md) +- [Learn more about CRIDGE, the service in OpenSlice that manages CRDs/CRs](../../architecture/CRIDGE/CRIDGEforDevelopers.md) diff --git a/doc/service_design/kubernetes/helm/design_helmaas.md b/doc/service_design/kubernetes/helm/design_helmaas.md index 411910ea..e4f3d75e 100644 --- a/doc/service_design/kubernetes/helm/design_helmaas.md +++ b/doc/service_design/kubernetes/helm/design_helmaas.md @@ -31,7 +31,7 @@ Use OpenSlice to expose them in service catalogs and deploy them in complex scen ## The installation of HELM charts is based on OpenSlice CRD support -Please read more [here](../ExposingKubernetesResources.md) +Please read more [here](../ExposingKubernetesResources.md). For installing HELM charts we will use ArgoCD a well known Kubernetes-native continuous deployment (CD) tool @@ -57,11 +57,11 @@ Browse to Resource Specifications. You will see an entry like the following: see image: - + -## What's next +## Probe further -See the [Example: Offer Jenkins as a Service via Openslice](HELM_Installation_aaS_Jenkins_Example.md) +See the [Example: Offer Jenkins as a Service via Openslice](../../examples/helmInstallation_aaS_Example_Jenkins/HELM_Installation_aaS_Jenkins_Example.md) diff --git a/doc/service_design/lcmrules/intro.md b/doc/service_design/lcmrules/intro.md index 651f83c8..0fb4cf47 100644 --- a/doc/service_design/lcmrules/intro.md +++ b/doc/service_design/lcmrules/intro.md @@ -91,7 +91,7 @@ See our [LCM Blocks specification](./specification.md) ## Probe further -* Check our [examples](../examples/intro.md) for more usages +* Check our [examples](./examples.md) for more usages * See next the complete [specification](./specification.md) -- GitLab