Remove usage and installation docs, point to new CLI docs on README #453
Conversation
pditommaso
left a comment
pditommaso
left a comment
There was a problem hiding this comment.
Keep the usage here in the GH repo please
|
@pditommaso usage.md is outdated compared to the Commands page in the docs. Keeping both pages updated is an additional maintenance burden. The Platform docs page contains everything the usage page here had, with more examples and all of the missing commands. Do we need to keep this page simply for posterity? |
|
Full usage I agree, however as OSS user/developer I expect to find the most important into here. The "Get started", "Installation" and basic commands should be reported in the *README.md* file. |
llewellyn-sl
dismissed
pditommaso’s stale review
Requested changes addressed.
|
|
||
| `tw` is [Seqera Platform](https://cloud.seqera.io/) on the command line. It brings Seqera concepts like pipelines, actions, and compute environments to the terminal. | ||
|
|
||
| Seqera Platform is a full-stack application for the management of data pipelines and compute resources. It enables collaborative data analysis at scale, on-premises or in any cloud. |
There was a problem hiding this comment.
| Seqera Platform is a full-stack application for the management of data pipelines and compute resources. It enables collaborative data analysis at scale, on-premises or in any cloud. | |
| Seqera Platform is a full-stack application for the management of data pipelines, compute resources and tertiary analysis. It enables collaborative data analysis at scale, on-premises or in any cloud. |
|  | ||
|
|
||
| The key features are: | ||
| See the [Platform CLI documentation](https://docs.seqera.io/platform/24.1/cli/overview). |
There was a problem hiding this comment.
| See the [Platform CLI documentation](https://docs.seqera.io/platform/24.1/cli/overview). | |
| See the [Platform CLI documentation](https://docs.seqera.io/platform/24.1/cli/overview) for complete functionality. |
| See the [Platform CLI documentation](https://docs.seqera.io/platform/24.1/cli/overview). | ||
|
|
||
| - **A Nextflow-like experience**: tw CLI provides a developer-friendly environment. Pipelines can be launched with the CLI similarly to Nextflow but with the Seqera benefits of monitoring, logging, resource provisioning, dataset management, and collaborative sharing. | ||
| ### Installation |
There was a problem hiding this comment.
| ### Installation | |
| ## Quick-start Guide | |
| ### Installation |
There was a problem hiding this comment.
I think this change will also resolve the linting errors.
|
We should make in case the README self-contained and allow the user to get start without the need to go in the docs. Therefore (core) installation info should stay here (same for all OSS projects) |
I believe the core installation instructions remain in this updated PR, but agree that basic usage would be helpful. |
Strip out documentation content here and link to new CLI docs on docs.seqera.io