diff --git a/docs/index.rst b/docs/index.rst index e1a53180..6e4ecad4 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -2,16 +2,17 @@ .. _home: -Charmed MLflow Documentation +Charmed MLflow documentation ============================ -Charmed MLflow is a platform for managing the end-to-end machine learning lifecycle. +Charmed MLflow is a platform for managing the end-to-end Machine Learning (ML) lifecycle. -It provides tools for tracking experiments, packaging code into reproducible runs, and sharing and deploying models. It integrates with popular machine learning frameworks. +It provides tools for tracking experiments, packaging code into reproducible runs, and sharing and deploying models. +It integrates with popular ML frameworks. -It addresses a number of common machine learning challenges: collaboration, reproducibility, maintenance, organisation and scaling. +It also addresses a number of common ML challenges including collaboration, reproducibility, maintenance, organisation and scaling. -It's ideal for data scientists, ML engineers, hobbyists and teams looking to optimise their ML workflows with charms. +It is intended for data scientists and ML engineers, looking to optimise their ML workflows with charms. --------- @@ -29,11 +30,6 @@ In this documentation **Step-by-step guides** covering key operations and common tasks in Charmed MLflow .. grid:: 1 1 2 2 - :reverse: - - .. grid-item:: :doc:`Reference ` - - **Technical information** - specifications, APIs, architecture of Charmed MLflow .. grid-item:: :doc:`Explanation ` @@ -46,18 +42,18 @@ Project and community Charmed MLflow is an open-source project that values its community. We warmly welcome contributions, suggestions, fixes, and constructive feedback from everyone. -* `Code of conduct`_ -* `Contribute`_ -* `Join our online chat`_ -* `Upstream Project`_ -* `Discourse Forum`_ +* Read our `Code of conduct`_. +* `Contribute`_ and `report bugs `_. +* Join the `Discourse forum`_. +* `Talk to us`_. +* Learn more about the `upstream project`_. .. toctree:: :hidden: :maxdepth: 2 + Home tutorial/index - how-to/index - reference/index + How to explanation/index - contributing \ No newline at end of file + Contribute \ No newline at end of file diff --git a/docs/reference/index.rst b/docs/reference/index.rst deleted file mode 100644 index 27ebe866..00000000 --- a/docs/reference/index.rst +++ /dev/null @@ -1,4 +0,0 @@ -Reference -========= - -Coming soon. \ No newline at end of file diff --git a/docs/reuse/links.txt b/docs/reuse/links.txt index fa7aee65..39391962 100644 --- a/docs/reuse/links.txt +++ b/docs/reuse/links.txt @@ -4,14 +4,14 @@ .. _Example product documentation: https://canonical-example-product-documentation.readthedocs-hosted.com/ .. _Code of conduct: https://ubuntu.com/community/ethos/code-of-conduct -.. _Join our online chat: https://chat.charmhub.io/charmhub/channels/charmed-mlops +.. _Talk to us: https://chat.charmhub.io/charmhub/channels/charmed-mlops .. _Contribute: https://github.com/canonical/mlflow-operator/blob/main/CONTRIBUTING.md -.. _Upstream Project: https://mlflow.org/ -.. _Discourse Forum: https://discourse.charmhub.io/tag/mlflow +.. _Upstream project: https://mlflow.org/ +.. _Discourse forum: https://discourse.charmhub.io/tag/mlflow .. _rclone: https://snapcraft.io/rclone .. _configured: https://rclone.org/s3/#configuration .. _yq binary: https://snapcraft.io/yq -.. _Create a backup: https://charmhub.io/mysql-k8s/docs/h-create-and-list-backups +.. _Create a backup: https://charmhub.io/mysql-k8s/docs/h-create-backup .. _MicroK8s: https://microk8s.io/ diff --git a/docs/tutorial/mlflow-kubeflow.rst b/docs/tutorial/mlflow-kubeflow.rst index 64465613..ba4e0370 100644 --- a/docs/tutorial/mlflow-kubeflow.rst +++ b/docs/tutorial/mlflow-kubeflow.rst @@ -1,5 +1,5 @@ -Getting Started with Charmed MLflow and Kubeflow -================================================ +Get started with Charmed MLflow and Kubeflow +============================================ +-----------+---------+ | Component | Version | diff --git a/docs/tutorial/mlflow.rst b/docs/tutorial/mlflow.rst index c955a21d..42b75f3a 100644 --- a/docs/tutorial/mlflow.rst +++ b/docs/tutorial/mlflow.rst @@ -1,4 +1,4 @@ -Get Started with Charmed MLflow +Get started with Charmed MLflow ================================== +-----------+---------+