config.md - mention string or map #5316
Conversation
See #5314 (comment) Signed-off-by: Phil Ewels <phil.ewels@seqera.io>
✅ Deploy Preview for nextflow-docs-staging ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
| @@ -1229,7 +1229,7 @@ The `manifest` scope allows you to define some meta-data information needed when | |||
| The following settings are available: | |||
|
|
|||
| `manifest.author` | |||
| : Project author name (use a comma to separate multiple names). | |||
| : Project author name (String or map). | |||
There was a problem hiding this comment.
| : Project author name (String or map). | |
| : Project author(s). Can be a string of comma-separated values or a list of maps. |
Co-authored-by: Ben Sherman <bentshermann@gmail.com> Signed-off-by: Phil Ewels <phil.ewels@seqera.io>
| @@ -1256,7 +1256,7 @@ The following settings are available: | |||
| : Project main script (default: `main.nf`). | |||
|
|
|||
| `manifest.maintainer` | |||
| : Project maintainer(s) (String or map). | |||
| : Project maintainer(s). Can be a string of comma-separated values or a list of maps. | |||
There was a problem hiding this comment.
Nope, this is declared as a String
We could use comma separate string for more than one author as for maintainer (map becomes a mess to handle on backend side)
There was a problem hiding this comment.
Yup, this is following this comment: #5314 (comment) and originally #4034 (comment)
Essentially for both author and maintainer fields, I'd like to be able to optionally specify a number of fields:
- Name
- Affiliation
- ORCiD
- GitHub
..for multiple authors / maintainers.
Having this info would allow us to roll it into other provenance outputs, like BCO and RO Crate. Which would in turn give rich authorship information in downstream platforms like WorkflowHub, Seqera Pipelines, the nf-core website and more. We could also build automation to fill it from GitHub contribution statistics in @nf-core and other nice stuff.
The string is simple, but not really useful. People put all kinds of things in there in different formats and so it's impossible to use for anything downstream.
There was a problem hiding this comment.
This is an important deviation from what was implemented. Not sure any more all those should the manifest
There was a problem hiding this comment.
It is true the author is declared as a string, so we can't re-use it. We'll have to add a new field like authors and maintainers, maybe deprecate the old ones
But we really do need more detailed fields for the author list so that it can be easily mapped to provenance manifests like BCO
|
Closing in favour of #5322 |
See #5314 (comment)