fix documentation checks CI

NohaIhab commented 6 months ago

Context

documentation checks are failing due to issues with the links in the mlflow docs see in this run

Link check was failing with:

(how-to/deploy-eks: line   10) ok        https://aws.amazon.com/eks/
(tutorial/mlflow-kubeflow: line   12) ok        https://charmed-kubeflow.io/docs/get-started-with-charmed-kubeflow
(tutorial/mlflow-kubeflow: line   25) ok        https://charmed-kubeflow.io/docs/how-tosetup-ssh-vm-access-with-port-forwarding
(how-to/integrate-cos: line   17) ok        https://charmhub.io/grafana-agent-k8s
(how-to/integrate-cos: line   11) ok        https://charmhub.io/topics/canonical-observability-stack/tutorials/install-microk8s
(    contributing: line   62) ok        https://discourse.charmhub.io/
(how-to/integrate-ml-ckf-ck8s: line   17) ok        https://discourse.charmhub.io/t/deploying-charmed-kubeflow-to-charmed-kubernetes-on-aws/11667
(           index: line   53) ok        https://discourse.charmhub.io/tag/mlflow
(    contributing: line   62) ok        https://chat.charmhub.io/charmhub/channels/mlops-documentation
(           index: line   51) ok        https://chat.charmhub.io/charmhub/channels/charmed-mlops
(how-to/deploy-ck8s-aws: line   68) ok        https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/authorizing-access-to-an-instance.html
(how-to/create-ck8s-aws: line    9) ok        https://docs.aws.amazon.com/accounts/latest/reference/manage-acct-creating.html
(how-to/deploy-eks: line   21) broken    https://charmed-kubeflow.io/docs/create-eks-cluster-for-mlops - 404 Client Error:  for url: https://charmed-kubeflow.io/docs/create-eks-cluster-for-mlops
(how-to/create-ck8s-aws: line   14) ok        https://docs.aws.amazon.com/cli/latest/userguide/cli-authentication-user.html
(how-to/create-ck8s-aws: line   14) ok        https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html
(           index: line   50) ok        https://github.com/canonical/mlflow-operator/blob/main/CONTRIBUTING.md
(tutorial/mlflow-kubeflow: line  111) ok        https://github.com/canonical/bundle-kubeflow/issues/488
(    contributing: line   62) ok        https://github.com/canonical/mlflow-operator/issues
(tutorial/mlflow-kubeflow: line  185) ok        https://github.com/canonical/kubeflow-examples/issues/34
(tutorial/mlflow-kubeflow: line   73) ok        https://github.com/canonical/resource-dispatcher
(how-to/create-ck8s-aws: line   60) ok        https://github.com/charmed-kubernetes/bundle
(explanation/why-charmed: line   11) ok        https://juju.is/
(explanation/why-charmed: line   11) ok        https://juju.is/docs/juju/bundle
(tutorial/mlflow-kubeflow: line   91) ok        https://juju.is/docs/juju/juju-status
( tutorial/mlflow: line   12) ok        https://juju.is/docs/sdk/charm-bundles
(tutorial/mlflow-kubeflow: line  134) ok        https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
(    contributing: line   75) ok        https://juju.is/docs/sdk
( tutorial/mlflow: line  133) ok        https://kubernetes.io/docs/concepts/services-networking/service/#type-nodeport
(explanation/why-charmed: line    4) ok        https://mlflow.org/
( tutorial/mlflow: line   14) ok        https://microk8s.io/
( tutorial/mlflow: line  [121](https://github.com/canonical/mlflow-operator/actions/runs/7971374222/job/21760917706#step:6:123)) ok        https://min.io/product/multicloud-google-kubernetes-service?utm_term=&utm_campaign=MinIO+for+Google+Kubernetes+Engine+1.0&utm_source=adwords&utm_medium=ppc&hsa_acc=8976569894&hsa_cam=15844157882&hsa_grp=135899807670&hsa_ad=60866[122](https://github.com/canonical/mlflow-operator/actions/runs/7971374222/job/21760917706#step:6:124)5284&hsa_src=g&hsa_tgt=dsa-1425788495958&hsa_kw=&hsa_mt=&hsa_net=adwords&hsa_ver=3&gclid=Cj0KCQjwyLGjBhDKARIsAFRNgW-yGkAWWWjl0Nm7d0xJDiDqrExgaBQ8R-VnJGsPpzoACKsGaYqliycaAlOiEALw_wcB
( tutorial/mlflow: line   54) ok        https://microk8s.io/docs/addons
(           index: line   49) ok        https://ubuntu.com/community/ethos/code-of-conduct
(how-to/deploy-ck8s-aws: line   10) ok        https://ubuntu.com/kubernetes/charmed-k8s
(    contributing: line  [127](https://github.com/canonical/mlflow-operator/actions/runs/7971374222/job/21760917706#step:6:129)) ok        https://ubuntu.com/legal/contributors
(tutorial/mlflow-kubeflow: line  [134](https://github.com/canonical/mlflow-operator/actions/runs/7971374222/job/21760917706#step:6:136)) redirect  https://www.kubeflow.org/docs/components/multi-tenancy/getting-started/ - permanently to https://www.kubeflow.org/docs/components/central-dash/profiles/
( tutorial/mlflow: line  121) ok        https://www.mysql.com/
(tutorial/mlflow-kubeflow: line  113) redirect  https://juju.is/docs/juju/get-started-with-juju - with Found to https://juju.is/docs/juju/tutorial
build finished with problems.
make: *** [Makefile:54: linkcheck] Error 1
Command 'make linkcheck' returned non-zero exit status 2.
Error: Process completed with exit code 1.

specifically the broken link:

(how-to/deploy-eks: line   21) broken    https://charmed-kubeflow.io/docs/create-eks-cluster-for-mlops - 404 Client Error:  for url: https://charmed-kubeflow.io/docs/create-eks-cluster-for-mlops

What needs to get done

fix the links in mlflow docs

Definition of Done

Documentation Checks CI is passing

syncronize-issues-to-jira[bot] commented 6 months ago

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/KF-5419.

This message was autogenerated

NohaIhab commented 6 months ago

the Documentation checks actions passed with a re-run, the broken link for how-to/deploy-eks was fixed by @orfeas-k by adding the EKS guide to the docs website.

canonical / mlflow-operator