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

Documentation structure proposal #19

Open
DriesSchaumont opened this issue Jan 12, 2023 · 0 comments
Open

Documentation structure proposal #19

DriesSchaumont opened this issue Jan 12, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@DriesSchaumont
Copy link
Member

DriesSchaumont commented Jan 12, 2023

> = subsection
- = menu entry
[] = paragraph
? = need to decide where to put
* = somewhere on page

HOME
	> What is openpipelines
	> View workflows -> link naar workflows
	> Getting started
		[ Installing viash and nextflow
		+  Running full pipeline ]

USER GUIDE
	- Which workflow is right for me? (=usecases)
	- Running a pipeline/component
	  > nf-tower
	  	[sending to nf-tower from cli and adding workflows to nf-tower]
	  > cli
	  	[nextflow]
	- Troubleshooting
	- Data API
		[ Anndata and MuData objects ]
	- Releases


WORKFLOWS -> item for every workflow (but not in menu)
       Structure still to decide, but must contain: 
	* Tag voor de workflows
	* Statistics (download, ...)
	* Link to sourcecode
	> Introduction
	> Example input/output -> from test-data? (hosted on s3?)
	> Input
	> Output
	> RUN from nf-tower
	> RUN from cli
	> Workflow diagram of components + basis input and output information

COMPONENTS -> item voor every component (but not in menu)
       Structure still to decide, but must contain: 
	* Tags voor iedere component
	* Statistics (download, ...)
	* Link to sourcecode
	> Introduction
        > Example input/output -> from test-data? (hosted on s3?)
	> Component input (type, description, )
	> Component output
	> Run from CLI
		[ files on s3 ]
	> RUN from nf-tower
		[ files on s3 ]
	> In which workflows is this component being used?

CONTRIBUTING
	- Getting started
		> Forking and cloning the code
		> Development options ()
		> Project structure
	- Creating a component
		> From script to component
		> Configuring containers
		> Writing tests (viashpy)
	- Creating a workflow
		> Using workflowhelpers/utilities (including params_list)
		> Inputs for multiple files
		> Writing tests
	- Testing
		> Github Actions
		> NF-tower
	- Publishing your changes
	    > Branching stratefgy
		> Creating a pull request
                 > Updating your pull request
	- Code of conduct
	? Creating a new release
	- Code style
	- Debugging workflows
		[intermitend issues --> hyperfine]
	- Design decisions

ABOUT
	- Openpipelines
	- Viash
	- Nextflow
	- Team/Authors
	- Code of conduct
@DriesSchaumont DriesSchaumont added the documentation Improvements or additions to documentation label Jan 16, 2023
@DriesSchaumont DriesSchaumont transferred this issue from openpipelines-bio/openpipeline Mar 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant