From b05f7814fd93f6296aaf9086ee7575aa5280c9ac Mon Sep 17 00:00:00 2001 From: Marcel Ribeiro-Dantas Date: Mon, 11 Mar 2024 09:26:45 -0300 Subject: [PATCH] Improve writing in the docs Signed-off-by: Marcel Ribeiro-Dantas --- src/docs/asciidoc/parts/development.adoc | 4 ++-- src/docs/asciidoc/parts/intro.adoc | 6 +++--- src/docs/asciidoc/parts/usage.adoc | 8 +++++--- 3 files changed, 10 insertions(+), 8 deletions(-) diff --git a/src/docs/asciidoc/parts/development.adoc b/src/docs/asciidoc/parts/development.adoc index 5a9b7e1..bfbdc87 100644 --- a/src/docs/asciidoc/parts/development.adoc +++ b/src/docs/asciidoc/parts/development.adoc @@ -4,13 +4,13 @@ Firstly you need a `nomad` cluster. See https://developer.hashicorp.com/nomad/in In this setup, we have made the following assumptions -- You want to create a minimal `Nomad cluster` for evaluation purpose +- You want to create a minimal `Nomad cluster` for evaluation purposes - You have access to an AWS S3-compatible storage or GCP Storage - Your linux instance already has `docker` installed ==== Setup local nomad dev cluster with FusionFS -Here's a sample Nomad client configuration, please refer the official https://developer.hashicorp.com/nomad/docs/install[installation ] instructions and https://developer.hashicorp.com/nomad/tutorials/get-started/gs-start-a-cluster[dev cluster] instructions for customizing this for your own linux machine. +Here's a sample Nomad client configuration. Please refer to the official https://developer.hashicorp.com/nomad/docs/install[installation] and https://developer.hashicorp.com/nomad/tutorials/get-started/gs-start-a-cluster[dev cluster] instructions for customizing this for your own linux machine. .nomad.hcl [source,hcl] diff --git a/src/docs/asciidoc/parts/intro.adoc b/src/docs/asciidoc/parts/intro.adoc index 9fb7b31..fbda997 100644 --- a/src/docs/asciidoc/parts/intro.adoc +++ b/src/docs/asciidoc/parts/intro.adoc @@ -2,15 +2,15 @@ The aim of this plugin is to integrate `Nextflow` and Hashicorp `Nomad` executor for batch processing of jobs. -The plugin itself, is similar in design and scrope to other executor integrations such as `nf-azure` and `k8s` integration, however as `Nomad` (arguably) offers a simpler setup, we aimed to address the usability of a Nomad cluster within the Nextflow ecosystem. +The plugin itself is similar in design and scope to other executor integrations such as `nf-azure` and `k8s`, however as `Nomad` (arguably) offers a simpler setup, we aimed to address the usability of a Nomad cluster within the Nextflow ecosystem. -Hope you enjoy using the plugin and please participate in the development/feedback of the plugin in `platform-nomad` channel on Nextflow Slack instance. We would love to hear your feedback! +Hope you enjoy using the plugin and please participate in the development/feedback of the plugin in the `platform-nomad` channel on the Nextflow Slack instance. We would love to hear your feedback! ==== Some resources for familiarizing yourself with Nomad: -- https://developer.hashicorp.com/nomad/docs?product_intent=nomad[Hashicorp Documentation website for Nomad] +- https://developer.hashicorp.com/nomad/docs?product_intent=nomad[Hashicorp Documentation website for Nomad] - https://developer.hashicorp.com/nomad/docs/configuration[Nomad Client/Server Configuration] diff --git a/src/docs/asciidoc/parts/usage.adoc b/src/docs/asciidoc/parts/usage.adoc index 4f5fb5c..812619c 100644 --- a/src/docs/asciidoc/parts/usage.adoc +++ b/src/docs/asciidoc/parts/usage.adoc @@ -1,8 +1,8 @@ == Usage -Using the `nf-nomad` plugin is relatively straigtforward, once you have access to a development or production `nomad cluster`. Refer development.adoc for creating a local development cluster on a linux machine. +Using the `nf-nomad` plugin is relatively straightforward, once you have access to a development or production `nomad cluster`. Refer to development.adoc for creating a local development cluster on a linux machine. -Assuming that you have access to a minimal `Nomad cluster` and would like to evaluate the `nomad` executor and the `nf-nomad` plugin, you can rely upon Seqera Labs innovative Fusion FileSystem with a +Assuming that you have access to a minimal `Nomad cluster` and would like to evaluate the `nomad` executor and the `nf-nomad` plugin, you can rely upon Seqera innovative Fusion FileSystem with a .nextflow.config [source,groovy] @@ -45,12 +45,14 @@ nomad{ [source,groovy] ---- process sayHello { - container 'ubuntu:20.04' + container 'ubuntu:20.04' input: val x + output: stdout + script: """ echo '$x world!'