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.

Sign up for GitHub

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

Add flux components slides #267

Merged
merged 5 commits into from
Apr 4, 2024
Merged

Add flux components slides #267

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
94be8fa
fix: issues with make html build
vsoch Mar 28, 2024
999ca84
feat: add flux abstractions (architecture) page
vsoch Mar 28, 2024
bf12ccf
ci: test python 3.11 for readthedocs
vsoch Mar 28, 2024
a13a036
assets: flux-bird images
vsoch Apr 4, 2024
4887f9e
guide: rename architecture to components
vsoch Apr 4, 2024
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
18 changes: 18 additions & 0 deletions guides/architecture.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
.. _flux-architecture:

#################
Flux Architecture
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is "architecture" the correct term here? This seems to be describing a high level overview of Flux Framework and many of the current components that are currently project under that umbrella. It could just be me, but when I see "Flux Architecture", I would expect to see something more along the lines of what's described here

Maybe this document should be called "Flux Framework Overview and 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>
2 changes: 1 addition & 1 deletion index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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-architecture` page.

.. toctree::
:maxdepth: 2
Expand Down
4 changes: 1 addition & 3 deletions requirements.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ sphinx-copybutton
docutils
Jinja2<3.1
markupsafe==2.0.1
# waiting on dark mode
# sphinx_material
sphinx_immaterial==0.11.11
sphinx_immaterial
pydantic
recommonmark
sphinx_markdown_tables
Expand Down
Loading