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	`c798662`
🔍 Latest deploy log	https://app.netlify.com/sites/seqera-docs/deploys/6746eb448218470008e2df6d
😎 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

ejseqera · 2024-11-25T21:30:02Z

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.


Is it worth providing the list of possible resource names to be created via YAML config? I've been meaning to add this to the main README as well.

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 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.

Supported resource names include:

- actions

- compute-envs

- credentials

- datasets

- labels

- launch

- members

- organizations

- participants

- pipelines

- secrets

- teams

- workspaces

ejseqera · 2024-11-25T21:30:29Z

platform_versioned_docs/version-24.1/seqerakit/commands.mdx

+seqerakit test.yml --targets pipelines
+```
+
+This will process only the pipelines block from the YAML file and ignore `workspaces` and `compute-envs`.


Suggested change

This will process only the pipelines block from the YAML file and ignore `workspaces` and `compute-envs`.

This will process only the pipelines block from the YAML file and ignore creation of `workspaces` and `compute-envs`.

ejseqera · 2024-11-25T21:45:28Z

platform_versioned_docs/version-24.1/seqerakit/installation.mdx

+
+Seqerakit has three dependencies:
+
+1. [Seqera Platform CLI (`>=0.9.2`)](https://github.com/seqeralabs/tower-cli/releases)


Wondering if we should bump the minimum version to v0.10.1 here and in the main docs to avoid issues with pipeline name matching and reflection config errors reported by java, amongst other things.

ejseqera · 2024-11-25T21:47:24Z

platform_versioned_docs/version-24.1/seqerakit/installation.mdx

+
+### Configuration
+
+Create a [Seqera](https://cloud.seqera.io/) access token via **Your Tokens** in the user menu.


Suggested change

Create a [Seqera](https://cloud.seqera.io/) access token via **Your Tokens** in the user menu.

Create a [Seqera Platform](https://cloud.seqera.io/tokens) access token via **Your Tokens** in the user menu.

ejseqera · 2024-11-25T21:51:13Z

platform_versioned_docs/version-24.1/seqerakit/commands.mdx

+- Using file path:
+
+    ```shell-session
+    seqerakit /path/to/file.yaml


Don't want to be overly pedantic as us SciDev's are guilty of this as well but should we decide on whether we want to use .yaml or .yml? Seems like we should standardize on .yaml.

ejseqera · 2024-11-25T21:51:38Z

platform_versioned_docs/version-24.1/seqerakit/templates.mdx

+Customize YAML configuration templates to use in `seqerakit` commands to create, update, or delete Seqera resources. Create or delete multiple resources with a single command by combining them into a single configuration file.
+
+To use the templates on this page:
+1. Copy the template text or download the YML files you need. 


Suggested change

1. Copy the template text or download the YML files you need.

1. Copy the template text or download the YAML files you need.

See comment above.

ejseqera · 2024-11-25T21:54:09Z

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

+
+For every entity defined in your YAML file, specify `overwrite: True` to overwrite any existing Seqera entities of the same name.
+
+Seqerakit will first check to see if the name of the entity exists. If so, it will invoke a `tw <subcommand> delete` command before attempting to create it based on the options defined in the YAML file.


Suggested change

Seqerakit will first check to see if the name of the entity exists. If so, it will invoke a `tw <subcommand> delete` command before attempting to create it based on the options defined in the YAML file.

Seqerakit will first check to see if the name of the entity exists. If so, it will invoke a `tw <entity> delete` command before attempting to create it based on the options defined in the YAML file.

I've found that users got quite confused when referring to the CLI calls made under the hood with <subcommand> versus <resource> or <entity>.

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 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

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

ejseqera Nov 25, 2024

ejseqera Nov 25, 2024

ejseqera Nov 25, 2024

ejseqera Nov 25, 2024

ejseqera Nov 25, 2024

ejseqera Nov 25, 2024

ejseqera Nov 25, 2024

ejseqera Nov 25, 2024

ejseqera Nov 27, 2024


		### 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.

	This will process only the pipelines block from the YAML file and ignore `workspaces` and `compute-envs`.
	This will process only the pipelines block from the YAML file and ignore creation of `workspaces` and `compute-envs`.


		Seqerakit has three dependencies:

		1. [Seqera Platform CLI (`>=0.9.2`)](https://github.com/seqeralabs/tower-cli/releases)


		### Configuration

		Create a [Seqera](https://cloud.seqera.io/) access token via Your Tokens in the user menu.

	Create a [Seqera](https://cloud.seqera.io/) access token via Your Tokens in the user menu.
	Create a [Seqera Platform](https://cloud.seqera.io/tokens) access token via Your Tokens in the user menu.

	1. Copy the template text or download the YML files you need.
	1. Copy the template text or download the YAML files you need.


		For every entity defined in your YAML file, specify `overwrite: True` to overwrite any existing Seqera entities of the same name.

		Seqerakit will first check to see if the name of the entity exists. If so, it will invoke a `tw <subcommand> delete` command before attempting to create it based on the options defined in the YAML file.

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

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

llewellyn-sl commented Nov 11, 2024 •

edited

Loading

netlify bot commented Nov 11, 2024 •

edited

Loading

christopher-hakkaart commented Nov 22, 2024 •

edited

Loading