docs: tweaks to navigation headings (#171)

* Tweaks to navigation headings * typo * minor tweaks * project and community section updates * title update * remove trivial prerequisite
canonical · Sep 6, 2024 · 5f6cc3c · 5f6cc3c
1 parent 737f9a9
commit 5f6cc3c
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 19 deletions.
diff --git 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
@@ -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
@@ -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 <Charmed MLflow_>`_ within your DSS environment.
+Learn how to manage `MLflow <Charmed MLflow_>`_ within your DSS environment:
 
 .. toctree::
    :maxdepth: 1
@@ -37,7 +37,7 @@ Learn how to manage `MLflow <Charmed 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
@@ -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 <https://github.com/canonical/data-science-stack/issues/new/choose>`_.
+* Join the `Discourse forum`_.
+* Talk to us on `Matrix`_.
 
 .. toctree::
    :hidden:
    :maxdepth: 2
 
+   Home <self>
    tutorial/index
-   how-to/index
+   How to <how-to/index>
    explanation/index
diff --git 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 → docs/tutorial/get-started.rst b/docs/tutorial/getting-started.rst → 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 <https://microk8s.io/docs/getting-started>`_ for MicroK8s.
 

diff --git 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
+   Get started <get-started>