Skip to content

Commit 1f52edb

Browse files
[DOCS] Fix broken links (#373)
* [DOCS] EMF fix docu links temp * Fixing broken links * [DOCS] Fixing broken links * [DOCS] fix missing TODO link --------- Co-authored-by: Golebiewski, SebastianX <sebastianx.golebiewski@intel.com>
1 parent 43cb748 commit 1f52edb

25 files changed

Lines changed: 60 additions & 59 deletions

File tree

docs/deployment_guide/cloud_deployment/cloud_advanced/cloud_manual_modules.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Add configuration for modules
2121
+++++++++++++++++++++++++++++
2222

2323
Each ``backend.tf`` file contains three values: ``region``, ``bucket``, and ``key``. These values are the same
24-
used during `Terraform configuration <adv_manual_terraconfig>`_.
24+
used during `Terraform configuration <./cloud_manual_terraconfig.html>`_.
2525

2626
Every environment must use a unique region, bucket, and key combination. Terraform can't distinguish between environments.
2727

docs/deployment_guide/cloud_deployment/cloud_get_started/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -53,13 +53,13 @@ Supported AWS regions
5353
Edge Orchestrator must be installed to an AWS Region with at least **three**
5454
`Availability Zones* <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html#concepts-availability-zones>`_.
5555

56-
You can use an `AWS Region map <https://www.cloudregions.io/aws/regions-map>`_ that lists Availability Zones per region to verify
56+
You can use an `AWS Region map <https://aws.amazon.com/about-aws/global-infrastructure/regions_az/>`_ that lists Availability Zones per region to verify
5757
that the AWS Region you plan to install to has a minimum of three Availability Zones.
5858

5959
The Edge Orchestrator installer will verify that the selected AWS Region has at least three Availability Zones and error out if the requirement is not met.
6060

6161
For Firewall configuration, see
62-
`Firewall Configuration </../../shared/shared_gs_iam>`__
62+
`Firewall Configuration <../../../shared/shared_gs_firewall_config.html>`__
6363

6464
.. toctree::
6565
:hidden:

docs/deployment_guide/cloud_deployment/cloud_how_to/cloud_scale_orch.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ Update Cluster Scale Settings
169169
.. note::
170170
Scaling Edge Orchestrator cluster may require changing of observability profile.
171171
For details on observability profiles, see
172-
`Observability Configuration <../../cloud_deployment/cloud_get_started/system_requirements_aws_orch#edge-orchestrator-observability-configuration>`__.
172+
`Observability Configuration <../../cloud_deployment/cloud_get_started/system_requirements_aws_orch.html#edge-orchestrator-observability-configuration>`__.
173173

174174
.. note::
175175
When updating the cluster scale, you also need to provide flags from the installation step;

docs/deployment_guide/cloud_deployment/cloud_how_to/cloud_uninstall.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,4 @@ Uninstall Edge Orchestrator with no load balancer installed
4545
4646
4747
For a full list of flags available, see
48-
`flag examples <../cloud_examples/cloud_flags#flag-examples>`__.
48+
`flag examples <../cloud_examples/cloud_flags.html>`__.

docs/deployment_guide/on_prem_deployment/on_prem_get_started/index.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -297,7 +297,7 @@ To install Edge Orchestrator and Edge Node, the following Egress rules are requi
297297
- https://github.com/
298298
- Container images
299299
* - Edge Orchestrator
300-
- https://kubernetes.github.io/
300+
- https://kubernetes.io/
301301
- Helm Chart
302302
* - Edge Orchestrator
303303
- https://charts.external-secrets.io/
@@ -315,22 +315,22 @@ To install Edge Orchestrator and Edge Node, the following Egress rules are requi
315315
- https://kiali.org/
316316
- Helm Chart
317317
* - Edge Orchestrator
318-
- https://kyverno.github.io/
318+
- https://kyverno.github.io/kyverno/
319319
- Helm Chart
320320
* - Edge Orchestrator
321-
- https://metallb.github.io/
321+
- https://metallb.io/
322322
- Helm Chart
323323
* - Edge Orchestrator
324-
- https://prometheus-community.github.io/
324+
- https://github.com/prometheus-community/helm-charts
325325
- Helm Chart
326326
* - Edge Orchestrator
327327
- https://charts.bitnami.com/
328328
- Helm Chart
329329
* - Edge Orchestrator
330-
- https://stakater.github.io/
330+
- https://github.com/stakater/
331331
- Helm Chart
332332
* - Edge Orchestrator
333-
- https://helm.traefik.io/
333+
- https://github.com/traefik/traefik-helm-chart
334334
- Helm Chart
335335
* - Edge Orchestrator
336336
- https://helm.releases.hashicorp.com
@@ -387,7 +387,7 @@ To install Edge Orchestrator and Edge Node, the following Egress rules are requi
387387
- https://\*.archive.ubuntu.com
388388
- Onboarding
389389
* - Edge Node
390-
- https://ppa.launchpad.net
390+
- https://launchpad.net/+tour/ppa
391391
- Onboarding
392392
* - Edge Node
393393
- https://esm.ubuntu.com

docs/deployment_guide/on_prem_deployment/on_prem_how_to/on_prem_certificates.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ Create an Amazon Certificate
5151
If you use the AWS DNS service, see `Requesting a public certificate <https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html>`_.
5252

5353
Verify that your Amazon certificate matches the
54-
`Certificate Requirements <../../cloud_deployment/cloud_how_to/cloud_certificates#new-certificate-requirements>`__
54+
`Certificate Requirements <../../cloud_deployment/cloud_how_to/cloud_certificates.html#new-certificate-requirements>`__
5555
before completing it.
5656

5757
Generate a New Certificate with CSR Generator

docs/developer_guide/agents/arch/platform_observability.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -427,14 +427,14 @@ Platform Observability Agent depends on |software_prod_name| endpoints:
427427
Platform Observability Agent external telemetry collectors:
428428

429429
- Official `fluent-bit
430-
<https://docs.fluentbit.io/manual/installation/linux/ubuntu>`_ Debian
430+
<https://docs.fluentbit.io/manual/installation/downloads/linux/ubuntu>`_ Debian
431431
package.
432432

433433
- Official `telegraf <https://docs.influxdata.com/telegraf/v1/install/>`_
434434
Debian package.
435435

436436
- Official `Otel Collector
437-
<https://opentelemetry.io/docs/collector/installation/#deb-installation>`_
437+
<https://opentelemetry.io/docs/collector/install/binary/linux/#deb-installation>`_
438438
Debian package.
439439

440440
.. figure:: ./images/poa-system.png

docs/developer_guide/agents/arch/reporting.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -193,11 +193,11 @@ which must be provided in the ``/etc/edge-node/metrics/token`` file in the forma
193193

194194
TLS version 1.3 is used for backend communication if supported by the server; otherwise, TLS 1.2 is used.
195195

196-
The user running the application should be added to the `sudoers file <https://github.com/open-edge-platform/edge-node-agents/blob/main/config/sudoers.d/reporting-agent>`_,
196+
The user running the application should be added to the `sudoers file <https://github.com/open-edge-platform/edge-node-agents/blob/main/reporting-agent/config/sudoers.d/reporting-agent>`_,
197197
as the ``dmidecode`` and ``lshw`` applications require such privileges.
198198

199199
The same user must also have execute access to the ``kubectl`` binary and read access to the ``kubeconfig`` file.
200-
The paths to these files are specified in the ``reporting-agent.yaml`` `configuration file <https://github.com/open-edge-platform/edge-node-agents/blob/main/config/reporting-agent.yaml>`_.
200+
The paths to these files are specified in the ``reporting-agent.yaml`` `configuration file <https://github.com/open-edge-platform/edge-node-agents/blob/main/reporting-agent/config/reporting-agent.yaml>`_.
201201

202202
Auditing
203203
~~~~~~~~

docs/developer_guide/application_developer_workflow/deployment-helm/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ properly:
151151
helm -n testns template --release-name foobar . -f <values.yaml from deployment package>
152152
153153
#. Be aware of the preinstalled network policies applied to various namespaces on the Edge Node cluster.
154-
These can be seen in `network-policies <https://github.com/open-edge-platform/cluster-extensions/tree/main/helm/network-policies/templates>`_
154+
These can be seen in `network-policies <https://github.com/open-edge-platform/cluster-extensions/tree/main/helm/>`_
155155
or by running `kubectl` on the Edge Node:
156156

157157
.. code:: shell
@@ -194,7 +194,7 @@ properly:
194194
dependent on any specific configuration, then default configuration can be left as is.
195195

196196
#. Scan the Helm Chart for security vulnerabilities. This can be done using
197-
`Trivy <https://trivy.dev/latest/>`_.
197+
`Trivy <https://trivy.dev/docs/latest/guide/>`_.
198198

199199
.. code:: shell
200200

docs/developer_guide/application_developer_workflow/packaging-applications/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ integrity of containerized applications. Some key practices include:
111111

112112
There are many online guides with more details on these practices.
113113

114-
The `Trivy\* <https://trivy.dev/latest/>`_ tool can be used to scan images for
114+
The `Trivy\* <https://trivy.dev/docs/latest/getting-started/>`_ tool can be used to scan images for
115115
vulnerabilities. It can be installed locally or added to a CI check. The following
116116
command will scan the image:
117117

0 commit comments

Comments
 (0)