Skip to content

Commit a00130e

Browse files
docs: Move config scopes into separate pages (#7417)
Co-authored-by: Christopher Hakkaart <christopher.hakkaart@gmail.com> Signed-off-by: Ben Sherman <bentshermann@gmail.com> Signed-off-by: Christopher Hakkaart <christopher.hakkaart@gmail.com>
1 parent c8800d8 commit a00130e

64 files changed

Lines changed: 2899 additions & 2690 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.docusaurus_site/sidebars.js

Lines changed: 40 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,46 @@ module.exports = {
191191
"reference/cli/view"
192192
]
193193
},
194-
"reference/config",
194+
{
195+
type: "category",
196+
label: "Configuration options",
197+
link: { type: "doc", id: "reference/config" },
198+
items: [
199+
"reference/config/unscoped",
200+
"reference/config/apple-container",
201+
"reference/config/apptainer",
202+
"reference/config/aws",
203+
"reference/config/azure",
204+
"reference/config/charliecloud",
205+
"reference/config/conda",
206+
"reference/config/dag",
207+
"reference/config/docker",
208+
"reference/config/env",
209+
"reference/config/executor",
210+
"reference/config/fusion",
211+
"reference/config/google",
212+
"reference/config/k8s",
213+
"reference/config/lineage",
214+
"reference/config/mail",
215+
"reference/config/manifest",
216+
"reference/config/nextflow",
217+
"reference/config/notification",
218+
"reference/config/podman",
219+
"reference/config/registry",
220+
"reference/config/report",
221+
"reference/config/sarus",
222+
"reference/config/seqera",
223+
"reference/config/shifter",
224+
"reference/config/singularity",
225+
"reference/config/smolvm",
226+
"reference/config/spack",
227+
"reference/config/timeline",
228+
"reference/config/tower",
229+
"reference/config/trace",
230+
"reference/config/wave",
231+
"reference/config/workflow"
232+
]
233+
},
195234
"reference/env-vars"
196235
]
197236
},

docs/amazons3.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,6 @@ aws {
102102
See [AWS configuration][config-aws] for more information about advanced S3 client configuration options.
103103

104104

105-
[config-aws]: ./reference/config#aws
105+
[config-aws]: ./reference/config/aws
106106
[stdlib-types-path]: ./reference/stdlib-types/path
107107
[working-with-files]: ./working-with-files

docs/aws.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@ See [aws][config-aws] to learn more about advanced configuration options.
535535

536536
[awsbatch-executor]: ./executor#aws-batch
537537
[aws-custom-ami]: ./aws#custom-ami
538-
[config-aws]: ./reference/config#aws
538+
[config-aws]: ./reference/config/aws
539539
[config-process-selectors]: ./config#process-selectors
540540
[fusion-page]: ./fusion
541541
[process-container]: ./reference/process#container

docs/azure.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -709,4 +709,4 @@ When using Fusion, `bucketDir` is not needed as all tasks will use the remote wo
709709

710710
See the [azure][config-azure] configuration scope for the list of available configuration options.
711711

712-
[config-azure]: ./reference/config#azure
712+
[config-azure]: ./reference/config/azure

docs/conda.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -219,6 +219,6 @@ The above configuration snippet allows the execution either with Conda or Docker
219219

220220
Conda advanced configuration settings are described in the [conda][config-conda] section on the Nextflow configuration page.
221221

222-
[config-conda]: ./reference/config#conda
222+
[config-conda]: ./reference/config/conda
223223
[config-profiles]: ./config#config-profiles
224224
[process-conda]: ./reference/process#conda

docs/container.mdx

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -772,11 +772,11 @@ See [`smolvm`][config-smolvm] on the Nextflow configuration page for advanced sm
772772

773773
[execution-report-tasks]: ./reports#tasks
774774
[config-page]: ./config
775-
[config-apple-container]: ./reference/config#applecontainer
776-
[config-apptainer]: ./reference/config#apptainer
775+
[config-apple-container]: ./reference/config/apple-container
776+
[config-apptainer]: ./reference/config/apptainer
777777
[config-process]: ./config#process-configuration
778-
[config-charliecloud]: ./reference/config#charliecloud
779-
[config-docker]: ./reference/config#docker
780-
[config-podman]: ./reference/config#podman
781-
[config-singularity]: ./reference/config#singularity
782-
[config-smolvm]: ./reference/config#smolvm
778+
[config-charliecloud]: ./reference/config/charliecloud
779+
[config-docker]: ./reference/config/docker
780+
[config-podman]: ./reference/config/podman
781+
[config-singularity]: ./reference/config/singularity
782+
[config-smolvm]: ./reference/config/smolvm

docs/executor.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -585,8 +585,8 @@ process {
585585

586586
[aws-batch]: ./aws#aws-batch
587587
[azure-batch]: ./azure#azure-batch
588-
[config-executor]: ./reference/config#executor
589-
[config-seqera]: ./reference/config#seqera
588+
[config-executor]: ./reference/config/executor
589+
[config-seqera]: ./reference/config/seqera
590590
[container-docker]: ./container#docker
591591
[container-podman]: ./container#podman
592592
[google-batch]: ./google#cloud-batch

docs/google.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -280,7 +280,7 @@ Nextflow will automatically manage the transfer of input and output files betwee
280280

281281
- Currently, it's not possible to specify a disk type different from the default one assigned by the service depending on the chosen instance type.
282282

283-
[config-google]: ./reference/config#google
283+
[config-google]: ./reference/config/google
284284
[config-process-selectors]: ./config#process-selectors
285285
[fusion-page]: ./fusion
286286
[google-batch-executor]: ./executor#google-cloud-batch

docs/kubernetes.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,7 @@ The `kuberun` command does not allow the execution of local Nextflow scripts. It
130130

131131
See [k8s][config-k8s] and [Kubernetes][k8s-executor] to learn more about advanced configuration options.
132132

133-
[config-k8s]: ./reference/config#k8s
133+
[config-k8s]: ./reference/config/k8s
134134
[fusion-page]: ./fusion
135135
[k8s-executor]: ./executor#kubernetes
136136
[process-container]: ./reference/process#container

docs/migrations/24-04.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,11 @@ The `nf-ga4gh` plugin has since been moved into its own repository, [nextflow-io
137137
- Upgrade to Groovy 4
138138
139139
[aws-fargate]: ../aws#aws-fargate
140-
[config-aws]: ../reference/config#aws
141-
[config-apptainer]: ../reference/config#apptainer
142-
[config-singularity]: ../reference/config#singularity
140+
[config-aws]: ../reference/config/aws
141+
[config-apptainer]: ../reference/config/apptainer
142+
[config-singularity]: ../reference/config/singularity
143143
[channel-topic]: ../reference/channel#topic
144-
[config-workflow]: ../reference/config#workflow
144+
[config-workflow]: ../reference/config/workflow
145145
[dynamic-task-resources]: ../process#dynamic-task-resources
146146
[google-batch-process]: ../google#process-definition
147147
[process-array]: ../reference/process#array

0 commit comments

Comments
 (0)