improve FAQ entry about filling up /tmp#306
Merged
mergify[bot] merged 6 commits intoflux-framework:masterfrom Aug 27, 2025
Merged
improve FAQ entry about filling up /tmp#306mergify[bot] merged 6 commits intoflux-framework:masterfrom
/tmp#306mergify[bot] merged 6 commits intoflux-framework:masterfrom
Conversation
Problem: The FAQ entry about filling up `/tmp` uses a different path for `statedir` when creating the directory vs using it in a job. This is confusing for users. Fix the typo.
vsoch
reviewed
Aug 26, 2025
faqs.rst
Outdated
| some situations such as long running, high throughput workflows, Flux may | ||
| use a lot of it. | ||
|
|
||
| When the FLux database fills up the disk, errors like the following may |
Member
There was a problem hiding this comment.
Suggested change
| When the FLux database fills up the disk, errors like the following may | |
| When the Flux database fills up the disk, errors like the following may |
faqs.rst
Outdated
|
|
||
| .. code-block:: console | ||
|
|
||
| content-sqlite.err[0]: store: executing stmt: database or disk is full(13) |
Member
There was a problem hiding this comment.
Nit: can we be consistent with spacing for code blocks? This one has indentation that is much smaller than the others.
Contributor
Author
There was a problem hiding this comment.
Sorry I copied the example right before this code block which has an indent of 1. There are also code blocks in this file with indent of 2, 3, and 4. I'll tack on an extra commit to standardize on 4.
Edit: actually I used 2. 4 seems excessive and most code-blocks were using 2 space indent.
Problem: There are no example errors in the FAQ entry about full `/tmp`, but this may be useful for users searching for errors via a search engine. Add some example errors to the FAQ entry.
Problem: An example in the FAQ uses `flux start -o,-S...`, an outdated usage. Update the example to `flux start -S...`.
Problem: Some code-blocks in faqs.rst use different number of spaces for the indent. Change all the indents to 2 spaces.
Contributor
Author
|
Thanks @vsoch! I addressed your comments. I also noticed an outdated usage of |
vsoch
approved these changes
Aug 26, 2025
Problem: Linkcheck fails in ci for https://mcs.anl.gov/papers, but this link works fine outside of github. Add the paper URL to the list of linkcheck errors to ignore.
Problem: The Spack project install link is broken. Drop the `#install` from the URL.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
@ryanday36 noticed a typo in the FAQ entry on using
statedir. Additionally, it was suggested that adding some example errors would be helpful here.