search

HumanCellAtlas / data-portal-content

Markdown, images, PDFs, and similar content for HCA Data Portal
https://prod.data.humancellatlas.org/
Apache License 2.0
3 stars 5 forks source link

Rename "Community Pipelines" to "Develop Pipelines" #274

Closed jodihir closed 5 years ago

jodihir commented 5 years ago

The docs in this section are not really about community pipelines, and Tim and Kylee requested that we not use that title. They would prefer we name the section Pipeline Development (or Develop Pipelines, Developing Pipelines - whatever fits best with our current naming style). Can you make that change soon please? Thanks!

NoopDog commented 5 years ago

Sure I thought the pipelines developed outside of HCA were called "Community Pipelines". We can quickly change to Developing Pipelines and If it makes sense change it again soon to "Developing Community Pipelines" or "Developing your own Pipeline".

I guess I am unclear about who would read this section and what they would be trying to do. What wold the user goal be for the person reading these docs?

The section starts out with:

We provide pipeline development guides, described briefly below, to help you design and build your own single cell data processing pipelines. When your pipeline is working, please consider submitting it to the DCP to help process data from the community. Email us at data-help@humancellatlas.org.

So it seems that this is for someone to create a pipeline and have this submitted to the HCA and run over all appropriate HCA data?

NoopDog commented 5 years ago

From slack conversation with @TimothyTickle let's:

  1. Rename to "Pipeline Development"

  2. Have pipeline developer evaluate for feedback

  3. If they say it can be improved we will, if they say to drop it we can stash it until we have users interested.

NoopDog commented 5 years ago

@frano-m can you rename the heading and then fix the paths to the sub docs please? Thanks!

NoopDog commented 5 years ago

@TimothyTickle @jodihir @kbergin This is on dev for your review: https://dev.data.humancellatlas.org/pipelines/pipeline-development/processing-pipelines/pipeline-processing-development-guides

The heading and the URL of all the sub documents are updated. Thanks @frano-m

Cheers, Dave

jodihir commented 5 years ago

Looks good to me! Thanks @NoopDog

kbergin commented 5 years ago

Thanks, and to clarify the Q above, we are working on an RFC about enabling community members to do "contributed pipelines" but we don't want to suggest that that's an option to users until we have agreement on the process and requirements. I still think the section has value, given many users in the closed beta interviews weren't aware we were analyzing data with our own pipelines, they may be curious how we develop them.

It's possible more of this section should be reworded but for now it's probably fine. Thanks for changing the heading!