From a94ba825194d404f974df597aef61c84442f95e6 Mon Sep 17 00:00:00 2001 From: vsoch Date: Tue, 25 Apr 2023 19:02:44 -0600 Subject: [PATCH] expose flux comparison table Problem: the comparison table is highly useful, but hidden under a section of the FAQ and hard to find. Solution: add it as a navigation tab on the top (the rationale that some will come to the docs explicitly looking for it) along with as a link in the first line of the quickstart. Signed-off-by: vsoch --- index.rst | 7 +++++++ quickstart.rst | 4 ++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/index.rst b/index.rst index dcb88b5b..05ee94de 100644 --- a/index.rst +++ b/index.rst @@ -37,6 +37,13 @@ The framework consists of a suite of projects, tools, and libraries which may be projects +.. toctree:: + :maxdepth: 1 + :caption: Comparison Table + + tables/comparison-table + + Contributor Relevant RFCs ------------------------- diff --git a/quickstart.rst b/quickstart.rst index 07c0013e..2ff59c7a 100644 --- a/quickstart.rst +++ b/quickstart.rst @@ -4,8 +4,8 @@ Quick Start ============ -A quick introduction to Flux and flux-core. For reference, the :ref:`Glossary` -contains definitions for a number of terms, Flux-specific concepts, and +A quick introduction to Flux and flux-core. If you are looking to see how Flux compares to your favorite resource manager, see :ref:`comparison-table`. +For reference, the :ref:`Glossary` contains definitions for a number of terms, Flux-specific concepts, and acronyms mentioned in this guide and throughout our documentation site. .. note::