From 5f6cc3c18aa3e59c35e751b52ec0c23d3af2b511 Mon Sep 17 00:00:00 2001 From: Angel Fernandez <103958447+afgambin@users.noreply.github.com> Date: Fri, 6 Sep 2024 14:19:00 +0100 Subject: [PATCH] docs: tweaks to navigation headings (#171) * Tweaks to navigation headings * typo * minor tweaks * project and community section updates * title update * remove trivial prerequisite --- docs/custom_conf.py | 2 +- docs/explanation/index.rst | 2 +- docs/how-to/index.rst | 8 ++++---- docs/index.rst | 15 ++++++++------- docs/reuse/links.txt | 2 +- .../{getting-started.rst => get-started.rst} | 5 ++--- docs/tutorial/index.rst | 4 ++-- 7 files changed, 19 insertions(+), 19 deletions(-) rename docs/tutorial/{getting-started.rst => get-started.rst} (98%) diff --git a/docs/custom_conf.py b/docs/custom_conf.py index d522ede..2e195e5 100644 --- a/docs/custom_conf.py +++ b/docs/custom_conf.py @@ -25,7 +25,7 @@ # The title you want to display for the documentation in the sidebar. # You might want to include a version number here. # To not display any title, set this option to an empty string. -html_title = project + ' documentation' +html_title = '' # The default value uses the current year as the copyright year. # diff --git a/docs/explanation/index.rst b/docs/explanation/index.rst index ab496db..b9d7682 100644 --- a/docs/explanation/index.rst +++ b/docs/explanation/index.rst @@ -6,7 +6,7 @@ The following guides cover key concepts and features of Data Science Stack (DSS) Architecture overview --------------------- -Understand the underlying architecture of DSS, its components and interactions. +Understand the underlying architecture of DSS, its components and interactions: .. toctree:: :maxdepth: 1 diff --git a/docs/how-to/index.rst b/docs/how-to/index.rst index fdebf0f..021cd36 100644 --- a/docs/how-to/index.rst +++ b/docs/how-to/index.rst @@ -7,7 +7,7 @@ Specifically, they demonstrate how to perform common tasks for managing DSS comp DSS basics ---------- -Learn basic operations to interact with DSS, including installation and the Command Line Interface (CLI) commands. +Learn basic operations to interact with DSS, including installation and the Command Line Interface (CLI) commands: .. toctree:: :maxdepth: 1 @@ -17,7 +17,7 @@ Learn basic operations to interact with DSS, including installation and the Comm Jupyter Notebooks within DSS ---------------------------- -Learn how to manage `Jupyter Notebooks`_ within your DSS environment. +Learn how to manage `Jupyter Notebooks`_ within your DSS environment: .. toctree:: :maxdepth: 1 @@ -27,7 +27,7 @@ Learn how to manage `Jupyter Notebooks`_ within your DSS environment. MLflow within DSS ----------------- -Learn how to manage `MLflow `_ within your DSS environment. +Learn how to manage `MLflow `_ within your DSS environment: .. toctree:: :maxdepth: 1 @@ -37,7 +37,7 @@ Learn how to manage `MLflow `_ within your DSS environment. Enable GPUs -------------------- -Learn how to configure DSS to leverage your GPUs. +Learn how to configure DSS to leverage your GPUs: .. toctree:: :maxdepth: 1 diff --git a/docs/index.rst b/docs/index.rst index d73ae6e..2fe9dbb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -1,8 +1,8 @@ .. _home: -Data Science Stack -================== +Data Science Stack documentation +================================ Data science stack (DSS) is a ready-to-run environment for machine learning and data science. It's built on open-source tooling (including MicroK8s, JupyterLab and MLflow) and usable on any Ubuntu/Snap-enabled workstation. @@ -44,15 +44,16 @@ Project and community Data Science Stack 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`_ -* `Discourse Forum`_ +* Read our `Code of conduct`_. +* `Contribute`_ and `report bugs `_. +* Join the `Discourse forum`_. +* Talk to us on `Matrix`_. .. toctree:: :hidden: :maxdepth: 2 + Home tutorial/index - how-to/index + How to explanation/index diff --git a/docs/reuse/links.txt b/docs/reuse/links.txt index 0d47b0c..3ec6932 100644 --- a/docs/reuse/links.txt +++ b/docs/reuse/links.txt @@ -7,8 +7,8 @@ .. _Code of conduct: https://ubuntu.com/community/ethos/code-of-conduct .. _Contribute: https://github.com/canonical/data-science-stack/blob/main/CONTRIBUTING.md .. _Discourse Forum: https://discourse.charmhub.io/tag/data-science-stack -.. _Join our online chat: https://matrix.to/#/#dss:ubuntu.com .. _Jupyter Notebooks: https://jupyter.org/ +.. _Matrix: https://matrix.to/#/#dss:ubuntu.com .. _MicroK8s: https://microk8s.io/ .. _Microk8s hostpath docs: https://microk8s.io/docs/addon-hostpath-storage .. _MicroK8s requirements: https://microk8s.io/docs/getting-started diff --git a/docs/tutorial/getting-started.rst b/docs/tutorial/get-started.rst similarity index 98% rename from docs/tutorial/getting-started.rst rename to docs/tutorial/get-started.rst index 6c9abb0..3164446 100644 --- a/docs/tutorial/getting-started.rst +++ b/docs/tutorial/get-started.rst @@ -1,7 +1,7 @@ .. _tutorial: -Getting Started -=============== +Get started with DSS +==================== This guide describes how you can get started with Data Science Stack (DSS). From setting up MicroK8s in your host environment, all the way to running your first notebook. @@ -13,7 +13,6 @@ Prerequisites ------------- * Ubuntu 22.04 LTS. -* An Internet connection. * `Snap`_ installed. * 50GB of disk space is recommended. This includes the `requirements `_ for MicroK8s. diff --git a/docs/tutorial/index.rst b/docs/tutorial/index.rst index 0a716c5..8d3039c 100644 --- a/docs/tutorial/index.rst +++ b/docs/tutorial/index.rst @@ -2,9 +2,9 @@ Tutorial ======== This section of our documentation contains a step-by-step tutorial to get you started with Data Science Stack (DSS). -It is the entry point to start learning about DSS, how it works, how to customise your setup and explore what you can do with it. +You will learn how it works, how to customise your setup and explore what you can do with it: .. toctree:: :maxdepth: 1 - getting-started \ No newline at end of file + Get started \ No newline at end of file