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

Create separate (standalone) tutorials for certain use cases #90

Open
3 tasks
rcannood opened this issue Jun 27, 2024 · 0 comments
Open
3 tasks

Create separate (standalone) tutorials for certain use cases #90

rcannood opened this issue Jun 27, 2024 · 0 comments

Comments

@rcannood
Copy link
Member

rcannood commented Jun 27, 2024

Right now, our guide documentation is structured for somebody who wants to learn Viash and develop components from scratch.

A more straightforward approach for somebody to get to learn how to use is to have a couple of stand-alone guides for specific use cases, such as:

  • Transforming an existing R, Python, or Bash script into a component (identifying parameters, creating viash code block, creating viash config, adding runners and engines)
    • Todo: also support jupyter notebook?
  • Creating a Viash component for a standalone CLI tool
  • Combining existing components from Viash Hub into a pipeline

I propose we create separate pages for some of the most common use cases and include it as a separate chapter in the guide. We can create separate issues for any of these use cases

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant