Seqerakit docs port #296

llewellyn-sl · 2024-11-11T14:04:21Z

@netlify /platform/24.1/seqerakit/installation

Ports and simplifies the Seqerakit docs into Platform Developer Tools.

TODO:

Port final pages to 24.2, 23.4, and 23.3
Clean up seqerakit repo

netlify · 2024-11-11T14:04:36Z

✅ Deploy Preview for seqera-docs ready!

Name	Link
🔨 Latest commit	`e3c3b73`
🔍 Latest deploy log	https://app.netlify.com/sites/seqera-docs/deploys/6748497e87c64200087e26a3
😎 Deploy Preview	https://deploy-preview-296--seqera-docs.netlify.app/platform/24.1/seqerakit/installation
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

Signed-off-by: Llewellyn vd Berg <[email protected]>

into seqerakit-docs-port

justinegeffen

Some feedback about formatting which we'll apply across other developer docs if we're all in agreement.

platform_versioned_docs/version-24.1/seqerakit/overview.mdx

platform_versioned_docs/version-24.1/seqerakit/quickstart.mdx

platform_versioned_docs/version-24.1/seqerakit/yaml-configuration.mdx

platform_versioned_docs/version-24.1/seqerakit/installation.mdx

…ion.mdx Co-authored-by: Justine Geffen <[email protected]> Signed-off-by: Llewellyn vd Berg <[email protected]>

justinegeffen

Awesome work, thank you so much!

platform_versioned_docs/version-24.1/seqerakit/commands.mdx

christopher-hakkaart · 2024-11-22T06:24:04Z

I've added two small comments. I wouldn't consider either of these blocking.

jason-seqera · 2024-11-22T15:51:09Z

@llewellyn-sl, the recognized terminal highlight styles are in docusaurus.config.js. We don't have a console, but shell-session ought to be similar. Anything not listed is just ignored. (Using any random value is actually required to get title= to work though which is weird.)

          "bash",
          "docker",
          "groovy",
          "ini",
          "java",
          "json",
          "nginx",
          "python",
          "r",
          "shell-session",
          "sql",
          "typescript",
          "yaml"

into seqerakit-docs-port

platform_versioned_docs/version-24.1/seqerakit/commands.mdx

platform_versioned_docs/version-24.1/seqerakit/installation.mdx

platform_versioned_docs/version-24.1/seqerakit/commands.mdx

platform_versioned_docs/version-24.1/seqerakit/templates.mdx

platform_versioned_docs/version-24.1/seqerakit/yaml-configuration.mdx

Co-authored-by: Esha Joshi <[email protected]> Signed-off-by: Llewellyn vd Berg <[email protected]>

into seqerakit-docs-port

christopher-hakkaart

Looks awesome!

Minor suggestions:

I think Seqerakit in the descriptions qualifies as the product name and should be capitalized
--help is an option not a parameter
Flags are boolean options (please correct me if I'm wrong)

christopher-hakkaart · 2024-11-29T13:45:07Z

platform_versioned_docs/version-24.1/seqerakit/commands.mdx

@@ -0,0 +1,126 @@
+---
+title: "Commands"
+description: "seqerakit command options"


Suggested change

description: "seqerakit command options"

description: "Seqerakit command options"

Thoughts?

christopher-hakkaart · 2024-11-29T13:48:44Z

platform_versioned_docs/version-24.1/seqerakit/commands.mdx

+tags: [seqerakit, cli, automation, commands]
+---
+
+Use the `--help` or `-h` parameter to list available commands and options:


Suggested change

Use the `--help` or `-h` parameter to list available commands and options:

Use the `--help` or `-h` option to list available commands and options:

Seqerakit: Python wrapper for the Seqera Platform CLI
options:
-h, --help show this help message and exit

christopher-hakkaart · 2024-11-29T13:54:30Z

platform_versioned_docs/version-24.1/seqerakit/commands.mdx

+
+### Specify targets
+
+When using a YAML file as input that defines multiple resources, use the `--targets` flag to specify which resources to create. This flag accepts a comma-separated list of resource names. 


Suggested change

When using a YAML file as input that defines multiple resources, use the `--targets` flag to specify which resources to create. This flag accepts a comma-separated list of resource names.

When using a YAML file as an input that defines multiple resources, use the `--targets` flag to specify which resources to create. This flag accepts a comma-separated list of resource names.

christopher-hakkaart · 2024-11-29T13:55:16Z

platform_versioned_docs/version-24.1/seqerakit/commands.mdx

+pipelines:
+  - name: "hello-world"
+    url: "https://github.com/nextflow-io/hello"
+    workspace: 'seqerakit/workspace-1'
+    compute-env: "compute-env"
+...


Single vs double quotes. I'm not sure if this is important.

I'd say we should go with single to match all the values in the templates.

christopher-hakkaart · 2024-11-29T14:03:35Z

platform_versioned_docs/version-24.1/seqerakit/commands.mdx

+
+The Platform CLI expects to connect to a Seqera instance that is secured by a TLS certificate. If your Seqera Enterprise instance does not present a certificate, you must run your `tw` commands with the `--insecure` flag.
+
+To use `tw`-specific CLI options such as `--insecure`, use the `--cli=` flag, followed by the options to use enclosed in double quotes:


Suggested change

To use `tw`-specific CLI options such as `--insecure`, use the `--cli=` flag, followed by the options to use enclosed in double quotes:

To use `tw`-specific CLI options such as `--insecure`, use the `--cli=` option, followed by the options to use enclosed in double quotes:

For me, flag is a type of option that is reserved for booleans.

christopher-hakkaart · 2024-11-29T14:09:35Z

platform_versioned_docs/version-24.1/seqerakit/installation.mdx

+seqerakit --version
+```
+
+Use the `--help` or `-h` parameter to list the available commands and their associated options:


Suggested change

Use the `--help` or `-h` parameter to list the available commands and their associated options:

Use the `--help` or `-h` option to list the available commands and their associated options:

christopher-hakkaart · 2024-11-29T14:11:03Z

platform_versioned_docs/version-24.1/seqerakit/installation.mdx

@@ -0,0 +1,117 @@
+---
+title: "Installation"
+description: "seqerakit installation options"


Suggested change

description: "seqerakit installation options"

description: "Seqerakit installation options"

christopher-hakkaart · 2024-11-29T14:11:18Z

platform_versioned_docs/version-24.1/seqerakit/templates.mdx

@@ -0,0 +1,200 @@
+---
+title: "Templates"
+description: "seqerakit YAML configuration file templates and instructions"


Suggested change

description: "seqerakit YAML configuration file templates and instructions"

description: "Seqerakit YAML configuration file templates and instructions"

justinegeffen

This is looking great! Minor feedback.

justinegeffen · 2024-11-29T18:19:49Z

platform_versioned_docs/version-24.1/seqerakit/templates.mdx

+
+To use the templates on this page:
+1. Copy the template text or download the YAML files you need. 
+1. Edit the values to specify your resource details, and save as a YML file.


Suggested change

1. Edit the values to specify your resource details, and save as a YML file.

1. Edit the values to specify your resource details, and save as a `.yaml` file.

justinegeffen · 2024-11-29T18:20:03Z

platform_versioned_docs/version-24.1/seqerakit/templates.mdx

+To use the templates on this page:
+1. Copy the template text or download the YAML files you need. 
+1. Edit the values to specify your resource details, and save as a YML file.
+1. Specify the YML template file in your `seqerakit` commands: 


Suggested change

1. Specify the YML template file in your `seqerakit` commands:

1. Specify the YAML template file in your `seqerakit` commands:

justinegeffen · 2024-11-29T18:38:14Z

platform_versioned_docs/version-24.1/seqerakit/commands.mdx

+pipelines:
+  - name: "hello-world"
+    url: "https://github.com/nextflow-io/hello"
+    workspace: 'seqerakit/workspace-1'
+    compute-env: "compute-env"
+...


I'd say we should go with single to match all the values in the templates.

llewellyn-sl and others added 3 commits September 16, 2024 21:24

1st commit

17fea83

Create overview, install, commands pages

e16db95

Add quickstart and YML pages

70d9dcf

llewellyn-sl added 4 commits November 11, 2024 16:05

Merge branch 'master' into seqerakit-docs-port

9782642

Signed-off-by: Llewellyn vd Berg <[email protected]>

Updates WIP

8ccc850

Merge branch 'seqerakit-docs-port' of https://github.com/seqeralabs/docs

0af8b1e

into seqerakit-docs-port

Templates updates

4ad8624

llewellyn-sl requested a review from justinegeffen November 15, 2024 12:25

llewellyn-sl self-assigned this Nov 15, 2024

llewellyn-sl added 4 commits November 15, 2024 14:27

Merge branch 'master' into seqerakit-docs-port

192122a

Clean YAML page, add e2e template

71965f9

Update yaml-configuration.mdx

199f110

Merge branch 'master' into seqerakit-docs-port

31523f2

llewellyn-sl marked this pull request as ready for review November 17, 2024 20:00

llewellyn-sl requested review from christopher-hakkaart, jason-seqera and andrew-dawson-seqera November 17, 2024 20:01

Remove old pages

26a4b2f

justinegeffen reviewed Nov 19, 2024

View reviewed changes

llewellyn-sl and others added 3 commits November 20, 2024 12:04

Merge branch 'master' into seqerakit-docs-port

8f8da47

Update platform_versioned_docs/version-24.1/seqerakit/yaml-configurat…

be69c8d

…ion.mdx Co-authored-by: Justine Geffen <[email protected]> Signed-off-by: Llewellyn vd Berg <[email protected]>

Seqerakit vs seqerakit

8fd5458

justinegeffen approved these changes Nov 21, 2024

View reviewed changes

justinegeffen added 1. Editor review Needs a language review 2. Dev/PM review Needs a review by a Dev or PM and removed 1. Editor review Needs a language review labels Nov 21, 2024

christopher-hakkaart reviewed Nov 22, 2024

View reviewed changes

platform_versioned_docs/version-24.1/seqerakit/commands.mdx Outdated Show resolved Hide resolved

christopher-hakkaart reviewed Nov 22, 2024

View reviewed changes

platform_versioned_docs/version-24.1/seqerakit/commands.mdx Outdated Show resolved Hide resolved

llewellyn-sl added 5 commits November 25, 2024 14:01

Merge branch 'master' into seqerakit-docs-port

99dacc7

Merge branch 'master' into seqerakit-docs-port

e765c9b

Formatting, review suggestions

bfbf602

Merge branch 'seqerakit-docs-port' of https://github.com/seqeralabs/docs

e6a5c1c

into seqerakit-docs-port

Merge branch 'master' into seqerakit-docs-port

c798662

ejseqera reviewed Nov 27, 2024

View reviewed changes

llewellyn-sl and others added 5 commits November 28, 2024 11:18

Update platform_versioned_docs/version-24.1/seqerakit/commands.mdx

c462d56

Co-authored-by: Esha Joshi <[email protected]> Signed-off-by: Llewellyn vd Berg <[email protected]>

Update platform_versioned_docs/version-24.1/seqerakit/templates.mdx

3ff8439

Co-authored-by: Esha Joshi <[email protected]> Signed-off-by: Llewellyn vd Berg <[email protected]>

Tech review suggestions

8752874

Merge branch 'seqerakit-docs-port' of https://github.com/seqeralabs/docs

2c761c9

into seqerakit-docs-port

Add resource names list

e3c3b73

christopher-hakkaart approved these changes Nov 29, 2024

View reviewed changes

ejseqera approved these changes Nov 29, 2024

View reviewed changes

justinegeffen approved these changes Nov 29, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Seqerakit docs port #296

Seqerakit docs port #296

llewellyn-sl commented Nov 11, 2024 •

edited

Loading

netlify bot commented Nov 11, 2024 •

edited

Loading

justinegeffen left a comment

justinegeffen left a comment

christopher-hakkaart commented Nov 22, 2024 •

edited

Loading

jason-seqera commented Nov 22, 2024

christopher-hakkaart left a comment

christopher-hakkaart Nov 29, 2024

christopher-hakkaart Nov 29, 2024

christopher-hakkaart Nov 29, 2024

christopher-hakkaart Nov 29, 2024

justinegeffen Nov 29, 2024

christopher-hakkaart Nov 29, 2024

christopher-hakkaart Nov 29, 2024

christopher-hakkaart Nov 29, 2024

christopher-hakkaart Nov 29, 2024

justinegeffen left a comment

justinegeffen Nov 29, 2024

justinegeffen Nov 29, 2024

justinegeffen Nov 29, 2024

	description: "seqerakit command options"
	description: "Seqerakit command options"

	Use the `--help` or `-h` parameter to list available commands and options:
	Use the `--help` or `-h` option to list available commands and options:


		### Specify targets

		When using a YAML file as input that defines multiple resources, use the `--targets` flag to specify which resources to create. This flag accepts a comma-separated list of resource names.

	When using a YAML file as input that defines multiple resources, use the `--targets` flag to specify which resources to create. This flag accepts a comma-separated list of resource names.
	When using a YAML file as an input that defines multiple resources, use the `--targets` flag to specify which resources to create. This flag accepts a comma-separated list of resource names.


		The Platform CLI expects to connect to a Seqera instance that is secured by a TLS certificate. If your Seqera Enterprise instance does not present a certificate, you must run your `tw` commands with the `--insecure` flag.

		To use `tw`-specific CLI options such as `--insecure`, use the `--cli=` flag, followed by the options to use enclosed in double quotes:

	description: "seqerakit installation options"
	description: "Seqerakit installation options"

	description: "seqerakit YAML configuration file templates and instructions"
	description: "Seqerakit YAML configuration file templates and instructions"

	1. Edit the values to specify your resource details, and save as a YML file.
	1. Edit the values to specify your resource details, and save as a `.yaml` file.

	1. Specify the YML template file in your `seqerakit` commands:
	1. Specify the YAML template file in your `seqerakit` commands:

Seqerakit docs port #296

Are you sure you want to change the base?

Seqerakit docs port #296

Conversation

llewellyn-sl commented Nov 11, 2024 • edited Loading

netlify bot commented Nov 11, 2024 • edited Loading

✅ Deploy Preview for seqera-docs ready!

justinegeffen left a comment

Choose a reason for hiding this comment

justinegeffen left a comment

Choose a reason for hiding this comment

christopher-hakkaart commented Nov 22, 2024 • edited Loading

jason-seqera commented Nov 22, 2024

christopher-hakkaart left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

justinegeffen left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

llewellyn-sl commented Nov 11, 2024 •

edited

Loading

netlify bot commented Nov 11, 2024 •

edited

Loading

christopher-hakkaart commented Nov 22, 2024 •

edited

Loading