Merge pull request #267 from flux-framework/add-architecture-slides

Add flux components slides
flux-framework · Apr 4, 2024 · 07bf155 · 07bf155
2 parents 1afa52b + 4887f9e
commit 07bf155
Show file tree

Hide file tree

Showing 10 changed files with 26 additions and 9 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -8,7 +8,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.7"
+    python: "3.11"
     # You can also specify other tool versions:
     # nodejs: "16"
 

diff --git a/conf.py b/conf.py
@@ -221,7 +221,6 @@
     "site_url": "http://flux-framework.github.io/flux-docs/",
     "repo_url": "https://github.com/flux-framework/flux-docs/",
     "repo_name": "Flux Framework",
-    "repo_type": "github",
     "edit_uri": "blob/main",
     "globaltoc_collapse": True,
     "features": [

diff --git a/guides/components.rst b/guides/components.rst
@@ -0,0 +1,18 @@
+.. _flux-components:
+
+###############
+Flux Components
+###############
+
+.. note::
+    Flux is a Framework because we assemble several components together
+    to manifest in the workload manager known as Flux. The slides below
+    review some of the projects and terminology. If there is a component
+    or abstraction that you don't see here (and would like to) please let
+    us know by `opening an issue <https://github.com/flux-framework/flux-docs/issues>`_
+    on our issue board. 
+
+
+.. raw:: html
+
+    <iframe src="https://docs.google.com/presentation/d/e/2PACX-1vR-Q6HGJxTpCoHR7lfI1kCSwYJ7zLkP4egHUMLDK4QTR3Ua305_oXJ0ksoKDchTlLFRQxXjX2MbLJId/embed?start=false&loop=false&delayms=60000" frameborder="0" width="960" height="569" allowfullscreen="true" mozallowfullscreen="true" webkitallowfullscreen="true"></iframe>
diff --git a/guides/index.rst b/guides/index.rst
@@ -10,6 +10,7 @@ Do you have a question? `let us know <https://github.com/flux-framework/flux-doc
    :maxdepth: 1
    :caption: Guides
 
+   components
    Flux Administrator's Guide <https://flux-framework.readthedocs.io/projects/flux-core/en/latest/guide/admin.html>
    accounting-guide
    learning_guide

diff --git a/guides/learning_guide.rst b/guides/learning_guide.rst
@@ -676,7 +676,7 @@ distribution of these institutions.
    :alt: Users are collaborators of Flux are quickly expanding around the world.
    :align: center
 
-    Figure 8: Users are collaborators of Flux are quickly expanding around the world.
+   Figure 8: Users are collaborators of Flux are quickly expanding around the world.
 
 
 *******************

diff --git a/images/flux-bird/flux-bird.png b/images/flux-bird/flux-bird.png
diff --git a/images/flux-bird/flux-bird.xcf b/images/flux-bird/flux-bird.xcf
diff --git a/index.rst b/index.rst
@@ -19,7 +19,7 @@ Welcome to Flux's documentation!
 Flux is a flexible framework for resource management, built for your site.
 The framework consists of a suite of projects, tools, and libraries which may be used to build site-custom resource managers for High Performance Computing centers.
 Unlike traditional resource managers, Flux can run as a parallel job under most launchers that support MPI, including under Flux itself. This not only makes batch scripts and workflows for Flux portable to other resource managers (just launch Flux as a job), but it also means that batch jobs have all the features of a full resource manager at their disposal, as if they have an entire cluster to themselves.
-If you are interested in a high level comparison of Flux to other resource managers, see :ref:`comparison-table`.
+If you are interested in a high level comparison of Flux to other resource managers, see :ref:`comparison-table`. If you want to get a high level overview of Flux projects or components, take a look at our :ref:`flux-components` page.
 
 .. toctree::
    :maxdepth: 2

diff --git a/requirements.txt b/requirements.txt
@@ -6,10 +6,8 @@ sphinx-copybutton
 docutils
 Jinja2<3.1
 markupsafe==2.0.1
-# waiting on dark mode
-# sphinx_material
-sphinx-immaterial
-pydantic==1.10.8
+sphinx_immaterial
+pydantic
 recommonmark
 sphinx_markdown_tables
 myst-parser

diff --git a/tutorials/commands/flux-jobs.rst b/tutorials/commands/flux-jobs.rst
@@ -302,6 +302,7 @@ By default, ``flux jobs`` will not list jobs that are running under subinstances
 this with an example.  Submit the following script to ``flux batch``.
 
 .. code-block:: sh
+
     #!/bin/sh
     # filename: batchjob.sh
 
@@ -310,7 +311,7 @@ this with an example.  Submit the following script to ``flux batch``.
     flux queue drain
 
 All we're doing is running two ``sleep`` jobs for infinity, and then calling ``flux queue drain`` to wait for those
-jobs to complete.  (See :ref:`Waiting for jobs<waiting-for-jobs>` tutorial for info on using ``flux queue drain`` to wait for jobs to complete.)
+jobs to complete.  Note that you can use ``flux queue drain`` to wait for jobs to complete.
 
 Let's run this via ``flux batch``