Skip to content
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.

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

Improve writing in the docs #28

Merged
merged 1 commit into from
Mar 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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 src/docs/asciidoc/parts/development.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
6 changes: 3 additions & 3 deletions src/docs/asciidoc/parts/intro.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -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]

Expand Down
8 changes: 5 additions & 3 deletions src/docs/asciidoc/parts/usage.adoc
Original file line number Diff line number Diff line change
@@ -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]
Expand Down Expand Up @@ -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!'
Expand Down
Loading