Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: backport changes introduced in #264 #275

Merged
merged 3 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 14 additions & 18 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---------

Expand All @@ -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 <reference/index>`

**Technical information** - specifications, APIs, architecture of Charmed MLflow

.. grid-item:: :doc:`Explanation <explanation/index>`

Expand All @@ -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 <https://github.com/canonical/mlflow-operator/issues/new/choose>`_.
* Join the `Discourse forum`_.
* `Talk to us`_.
* Learn more about the `upstream project`_.

.. toctree::
:hidden:
:maxdepth: 2

Home <self>
tutorial/index
how-to/index
reference/index
How to <how-to/index>
explanation/index
contributing
Contribute <contributing>
4 changes: 0 additions & 4 deletions docs/reference/index.rst

This file was deleted.

10 changes: 6 additions & 4 deletions docs/reuse/links.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
.. _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/
4 changes: 2 additions & 2 deletions docs/tutorial/mlflow-kubeflow.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
Getting Started with Charmed MLflow and Kubeflow
================================================
Get started with Charmed MLflow and Kubeflow
============================================

+-----------+---------+
| Component | Version |
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/mlflow.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Get Started with Charmed MLflow
Get started with Charmed MLflow
==================================

+-----------+---------+
Expand Down
Loading