Skip to content

docs: add info on profiles/ deployment to workflow_deployment.rst #114

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
dlaehnemann wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: add info on profiles/ deployment to workflow_deployment.rst #114

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
fa4adcb
docs: add info on `profiles/` deployment to workflow_deployment.rst
dlaehnemann Jan 14, 2026
db15af6
docs: add missing space
dlaehnemann Jan 14, 2026
3f80eb3
docs: correct grammar of modified sentence
dlaehnemann Jan 14, 2026
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
4 changes: 2 additions & 2 deletions docs/workflow_users/workflow_deployment.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ For the example above, it will have the following content
use rule * from dna_seq_varlociraptor

utilizing `Snakemake's module system <https://snakemake.readthedocs.io/en/stable/snakefiles/deployment.html#using-and-combining-pre-exising-workflows>`__.
In addition, it will copy over the contents of the ``config`` directory of the given repository into ``/tmp/dest/workflow/Snakefile``.
These should be seen as a template, can be modified according to your needs.
In addition, it will copy over the ``config/`` and ``profiles/`` directories of the given repository (and their contents) into respective directories under ``/tmp/dest/``.
These should be seen as templates, and can be modified according to your needs.
Further, the workflow definition Snakefile can be arbitrarily extended and modified, thereby making any changes to the used workflow transparent (also see the `snakemake module documentation <https://snakemake.readthedocs.io/en/stable/snakefiles/modularization.html#snakefiles-modules>`_).

It is highly advisable to put the deployed workflow into a new (perhaps private) git repository (e.g., see `here <https://docs.github.com/en/github/importing-your-projects-to-github/adding-an-existing-project-to-github-using-the-command-line>`_ for instructions how to do that with Github).
Expand Down