This repository has been archived by the owner on May 10, 2023. It is now read-only.
Fix out of date documentation #89
Open
Conversation
This file contains 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
Problem: README files have some trailing whitespace. Remove it.
Problem: Documentation recommends user use `flux job info` to get job information, such as the resource R. This is no longer recommended. Solution: Remove documentation about using `flux job info`. User should just use `flux jobs`.
Problem: An out of date comment says that jobs should be listed in the KVS. Remove it, just say to list running jobs via flux jobs.
Problem: The flux jobs output in the job-submit-cli README is out of date. Update it.
Problem: The example uses an old command line option for "flux job id" Update the command usage.
Problem: The example output is out of date. Update it.
Problem: The default job id output example is using the old decimal output. Update output to newer f58 format.
Problem: The usage of "flux job id" was output of date. Update it and the resulting output.
Problem: The example did not compile because of API changes. Fix it.
Problem: The default job id output example is using the old decimal output. Update output to newer f58 format.
Problem: Several example scripts were not executable by default. Update perms.
Problem: Several README files document the old "flux submit". Update to "flux mini submit".
Problem: For some reason in some README files, tcsh environment instructions are given in some sections but not others. Make sure tcsh environment instructions are listed along with bash/zsh.
Problem: For some reason in a number of README files, the two steps to start a Flux instance via slurm are not grouped together. i.e. Step 1: `salloc -N3 -ppdebug` Step # > 2: `srun --pty --mpi=none -N3 flux start -o,-S,log-filename=out` Solution: Put the slurm steps together and renumber accordingly.
Problem: A lot of documentation only lists how to launch Flux under Slurm. Add documentation on how to get resources via Flux.
|
I do think it would be worth updating the examples here, even if we ultimately intend to do them over in the docs! I for one would need to use them as a guide (and try / learn as I go) to write new ones. |
|
per discussion in #90 we will be archiving this repo, moving everything over to |
|
Well I didn't see this PR at first @chu11. We might as well merge what you've done already, then archive this repo, with a TODO to move motivating examples into flux-docs. (If it makes more work for you though to merge what you had, then I'd say skip it.) |
|
i guess at this point it would just manual merges, i'm fine with it either way :-) |
|
Agree we should merge! It's not worth losing that hard work that improves the current state of the repo. |
|
ok re-opened |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
What was meant to be a tiny fix b/c of something I noticed ended up into this ridiculous exercise which I'm not entirely convinced was worth it. But I figure, its better than what was there before :-) And we may want to eventually use this as a beginning "template" for writing tutorials in flux-docs.
Did not review if the code is actually any good anymore. This is mostly documentation updates. When I fixed example code, its b/c I wanted new example output and then found something wrong along the way. Didn't run every example, maybe I'll do that as a follow up. I know atleast one (
data-conduit) outright doesn't work (But it compiles! so we're further along than before).Side note regarding my fix:
Re-order slurm setup steps, I didn't run every example, but I don't believe the re-order matters in any of them. i.e. we don't need to set an environment variable before launching flux, its ok to do it afterwards.