search

seqeralabs / tower-cli

Nextflow Tower CLI tool
Apache License 2.0
43 stars 9 forks source link

Remove usage and installation docs, point to new CLI docs on README #453

Open llewellyn-sl opened 2 months ago

llewellyn-sl commented 2 months ago

Strip out documentation content here and link to new CLI docs on docs.seqera.io

llewellyn-sl commented 2 months ago

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

pditommaso commented 2 months ago

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.

pditommaso commented 2 months ago

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)

robnewman commented 2 months ago

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.