Skip to content

docs: review and edit new docs #237

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

Merged
merged 68 commits into from
May 26, 2025
Merged

docs: review and edit new docs #237

Show file tree
Hide file tree
Changes from 37 commits
Commits
Show all changes
68 commits
Select commit Hold shift + click to select a range
ed1beaf
docs: rework contributions section
dlaehnemann Mar 13, 2025
c50d28e
docs: some initial restructuring
dlaehnemann Mar 13, 2025
7c0e434
docs: first step of reworking resource specification
dlaehnemann Mar 14, 2025
d947665
docs: more resource specification cleanup
dlaehnemann Mar 14, 2025
bd3d900
docs: move example to the front (not yet updated, but with TODO)
dlaehnemann Mar 14, 2025
15f7892
docs: move retries to configurations section
dlaehnemann Mar 14, 2025
f61ab7c
Merge branch 'main' into docs/review-new-docs
cmeesters Mar 14, 2025
2861539
Merge branch 'main' into docs/review-new-docs
cmeesters Mar 15, 2025
474ead0
docs: minor re-wording job types
dlaehnemann Mar 17, 2025
6da5674
Merge branch 'docs/review-new-docs' of github.com:snakemake/snakemake…
dlaehnemann Mar 17, 2025
7a51cf9
docs: linkouts and wording in configuration sections (where, dynamic)
dlaehnemann Mar 24, 2025
0a3c17b
docs: slurm_partition linkout and wording
dlaehnemann Mar 24, 2025
9c8ffc0
docs: add gpu to standard resources table
dlaehnemann Mar 24, 2025
8faafba
docs: rework of most slurm-specific resources
dlaehnemann Mar 24, 2025
b78baeb
docs: initial wait times and frequencies changes
dlaehnemann Mar 24, 2025
7f49ee5
Merge branch 'main' into docs/review-new-docs
cmeesters Mar 28, 2025
c53937c
Merge branch 'main' into docs/review-new-docs
cmeesters Mar 31, 2025
b3f80d8
Merge branch 'main' into docs/review-new-docs
cmeesters Apr 4, 2025
9f8ed3e
docs: further clarfiy where to set resources and configurations
dlaehnemann Apr 11, 2025
dba70d8
docs: update wait times and frequencies section (still contains TODOs)
dlaehnemann Apr 11, 2025
d69a0b1
docs: rework "retry failed jobs" section as fas as possible, leaving …
dlaehnemann Apr 11, 2025
be45e7b
docs: remove example and explanation section for resource configurati…
dlaehnemann Apr 11, 2025
bf18d2b
docs: remove explanation of regular SMP jobs, as this does not seem u…
dlaehnemann Apr 11, 2025
8f5de00
docs: big TODO for MPI config
dlaehnemann Apr 11, 2025
bb4c85e
Merge branch 'main' into docs/review-new-docs
cmeesters Apr 11, 2025
bc1f024
fix: corrected description for 'tasks'
cmeesters Apr 28, 2025
8d0f20f
docs: added referal to local rules main docs
cmeesters Apr 28, 2025
9361226
Merge branch 'main' into docs/review-new-docs
cmeesters May 7, 2025
8baba42
Merge branch 'main' into docs/review-new-docs
cmeesters May 22, 2025
92c3531
feat: using the latest announcement bot action version
cmeesters May 22, 2025
8321d29
fix: removing todo item on '--executor slurm', adding the flag to the…
cmeesters May 22, 2025
5c21a1b
fix: capitalizing all nouns in header lines for consistency
cmeesters May 22, 2025
5686272
fix: removed TODO item in the MPI section. Yes, the exectuor is has n…
cmeesters May 22, 2025
8007365
fix: removed TODO items from the requeu section - hopefully a little …
cmeesters May 22, 2025
4cfac88
fix: reduced TODO items from the status check section: see note in th…
cmeesters May 22, 2025
aca969c
fix: removed additional quotes from slurm_extra example - not necessa…
cmeesters May 22, 2025
7cf6c86
feat: added section on interactive jobs
cmeesters May 22, 2025
bfbc3a6
fix: typo, missing line break
cmeesters May 22, 2025
545f00d
fix: added missing colum with the --gpus flag
cmeesters May 22, 2025
1e4a02c
Update docs/further.md
cmeesters May 22, 2025
8260fb9
Update docs/further.md
cmeesters May 22, 2025
8c0bd69
Update docs/further.md
cmeesters May 22, 2025
bb42d39
Update docs/further.md
cmeesters May 22, 2025
6a0cdae
Update docs/further.md
cmeesters May 23, 2025
699cae1
Update docs/further.md
cmeesters May 23, 2025
c8dd040
Update docs/further.md
cmeesters May 23, 2025
e78dd81
Update docs/further.md
cmeesters May 23, 2025
81054e6
fix: grammar
cmeesters May 25, 2025
ece4292
fix: added comma
cmeesters May 25, 2025
f8216d0
fix: clarification on command line example
cmeesters May 25, 2025
4b6ed4b
fix: added link to follow for issues
cmeesters May 25, 2025
09b5cfe
fix: typo
cmeesters May 25, 2025
ea60d6d
fix: added slurm translation for the requeue resource
cmeesters May 25, 2025
ffb5f82
fix: deleted trailing whitespace
cmeesters May 26, 2025
4af9023
fix: spelling chosing -> choosing
cmeesters May 26, 2025
0a7a3f9
fix: less harsh recommendation in the end
cmeesters May 26, 2025
a2434dc
fix: added two missing words
cmeesters May 26, 2025
bec85be
fix: more concise and friedly issue tips
cmeesters May 26, 2025
8f0932b
fix: separation of comments and code snippet
cmeesters May 26, 2025
a7d4ecb
fix: smoother sentence for running within jobs
cmeesters May 26, 2025
e954427
Update docs/further.md
cmeesters May 26, 2025
be1a608
fix: issue link
cmeesters May 26, 2025
764968c
Merge branch 'docs/review-new-docs' of github.com:snakemake/snakemake…
cmeesters May 26, 2025
360071a
Update docs/further.md
cmeesters May 26, 2025
ccf28db
fix: errorousnly added random string - corrected now
cmeesters May 26, 2025
6c992c1
Merge branch 'docs/review-new-docs' of github.com:snakemake/snakemake…
cmeesters May 26, 2025
7eb20e0
Update docs/further.md
cmeesters May 26, 2025
2446388
Merge branch 'docs/review-new-docs' of github.com:snakemake/snakemake…
cmeesters May 26, 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: 1 addition & 1 deletion .github/workflows/announce-release.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Post to Mastodon
uses: snakemake/mastodon-release-post-action@v1.2.3
uses: snakemake/mastodon-release-post-action@v1.4.0
with:
access-token: ${{ secrets.MASTODONBOT }}
pr-title: ${{ github.event.head_commit.message }}
Expand Down
Loading