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.

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 general config documentation #1721

Merged
merged 1 commit into from
Nov 14, 2024
Merged

Add general config documentation #1721

merged 1 commit into from
Nov 14, 2024

Conversation

khk-globus
Copy link
Contributor

We have plenty of examples of known working configurations. But what we don't currently have is exhaustive documentation on what the YAML files support. Start to address that oversight.

Reviewer reminder: one can build the docs by invoking docs/autobuild.sh, which also starts a local-only web server to serve them.

Type of change

  • Documentation update

@khk-globus khk-globus added the no-news-is-good-news This change does not require a news file label Nov 14, 2024
khk-globus added a commit that referenced this pull request Nov 14, 2024
We have plenty of examples of known working configurations.  But what we don't
currently have is exhaustive documentation on what the YAML files support.
Start to address that oversight.
@khk-globus khk-globus force-pushed the add_config_documentation branch from ca818ac to 449cced Compare November 14, 2024 20:08
Copy link
Contributor

@chris-janidlo chris-janidlo left a comment

Choose a reason for hiding this comment

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

per Kevin's request, here are my current pending comments. will post again if I run into any more

docs/endpoints/config_reference.rst Outdated Show resolved Hide resolved
docs/endpoints/config_reference.rst Outdated Show resolved Hide resolved
docs/endpoints/config_reference.rst Outdated Show resolved Hide resolved
docs/endpoints/config_reference.rst Outdated Show resolved Hide resolved
docs/endpoints/config_reference.rst Outdated Show resolved Hide resolved
docs/endpoints/config_reference.rst Show resolved Hide resolved
docs/endpoints/config_reference.rst Outdated Show resolved Hide resolved
khk-globus added a commit that referenced this pull request Nov 14, 2024
We have plenty of examples of known working configurations.  But what we don't
currently have is exhaustive documentation on what the YAML files support.
Start to address that oversight.
@khk-globus khk-globus force-pushed the add_config_documentation branch from 449cced to 0f021aa Compare November 14, 2024 21:44
chris-janidlo
chris-janidlo previously approved these changes Nov 14, 2024
Copy link
Contributor

@chris-janidlo chris-janidlo left a comment

Choose a reason for hiding this comment

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

✍️ 🔥

We have plenty of examples of known working configurations.  But what we don't
currently have is exhaustive documentation on what the YAML files support.
Start to address that oversight.
@khk-globus khk-globus merged commit 638f8a6 into main Nov 14, 2024
17 checks passed
@khk-globus khk-globus deleted the add_config_documentation branch November 14, 2024 22:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-news-is-good-news This change does not require a news file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants