Skip to content

add a note about some schedulers having limited support #1164

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

Open
wants to merge 2 commits into
base: latest
Choose a base branch
from
Open

add a note about some schedulers having limited support #1164

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31b467a
add a note about some schedulers having limited support
johrstrom Aug 19, 2025
d228490
add a newline here
johrstrom Aug 19, 2025
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
2 changes: 2 additions & 0 deletions source/installation/resource-manager/ccq.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
Cloudy Cluster
==============

.. include:: limited-support.inc

A YAML cluster configuration file for a Cloudy Cluster resource manager on an HPC
cluster looks like:

Expand Down
11 changes: 11 additions & 0 deletions source/installation/resource-manager/limited-support.inc
View file
Open in desktop
Copy link
Contributor

Choose a reason for hiding this comment

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

Any chance we can call this "Limited Support Notice" instead of Note? For more clarity?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I am not sure if I can change the title from Note, though we can use other directives. Note that note is blue while something like warning is yellow, so there are a few we can choose from here.

Though it appears that admonition (grey) is the only one I can re-title.

https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html

Copy link
Contributor

Choose a reason for hiding this comment

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

That's fine then. We can keep Note then. Thanks!

Copy link
Contributor

Choose a reason for hiding this comment

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

Here are two other suggestions:

This resource manager is not actively maintained by the Open OnDemand developers, either because it was community-contributed or we no longer have access to a test system. As a result, bug fixes from the core team may be limited, but community patches are encouraged.

This resource manager has only limited support from the Open OnDemand developers. In most cases, this is because it was contributed by the community or the development team no longer has access to a live system for testing.

As a result, the developers may not be able to troubleshoot or fix bugs that arise.
That said, community contributions and patches are always welcome to help improve support.

Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@

.. note::
This resource manager has limited support from the Open OnDemand
developers. This is because it was either contributed by the
community or the developers no longer have access to a live system
to test against.

Due to this lack of access, the developers may not be able to fix bugs or
issues.

However, community patches are always welcome.
2 changes: 2 additions & 0 deletions source/installation/resource-manager/lsf.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
LSF
===

.. include:: limited-support.inc

A YAML cluster configuration file for an LSF resource manager on an HPC cluster
looks like:

Expand Down
2 changes: 2 additions & 0 deletions source/installation/resource-manager/pbspro.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
PBS Professional
================

.. include:: limited-support.inc

A YAML cluster configuration file for a PBS Professional resource manager on an
HPC cluster looks like:

Expand Down
2 changes: 2 additions & 0 deletions source/installation/resource-manager/sge.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
Grid Engine
===========

.. include:: limited-support.inc

A YAML cluster configuration file for a Grid Engine (Sun Grid Engine, Son of Grid Engine, Univa Grid Engine) resource manager on an HPC
cluster looks like:

Expand Down
2 changes: 2 additions & 0 deletions source/installation/resource-manager/torque.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
Torque
======

.. include:: limited-support.inc

A YAML cluster configuration file for a Torque/PBS resource manager on an HPC
cluster looks like:

Expand Down