Add decision log and workflow documentation #216
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kba
requested changes
Aug 4, 2022
There was a problem hiding this comment.
So far so good. Some improvements I'd recommend:
- Keep the decision log concise and add a date component. Questions that it should answer about a decision:
- What's the decision about (heading)
- When was the decision made
- What does that decision mean for developers and users?
- How does the decision relate to other decisions (see also...)
- In the nextflow documentation, inline examples would be illustrative
- The answers to my questions around NF are good for a discussion (and that's where this text comes from), but for the actual (boring) technical documentation about it, they should merely serve as inspiration - these are the questions I have, our users/developers might have different question. It's not imperative to have these questions answered directly but rather that the documentation answers them implicitly.
Co-authored-by: Konstantin Baierer <kba@users.noreply.github.com>
lena-hinrichsen
changed the title
kba
reviewed
Aug 12, 2022
api.md
Outdated
| @@ -0,0 +1,4 @@ | |||
| # Web API | |||
There was a problem hiding this comment.
Let's name this web_api.md to not confuse with the python API. What information beyond the current sentence should be in here? At least a reference to the swagger UI, I suppose?
There was a problem hiding this comment.
@tdoan2010 will update this. We can either merge this now or wait for him
There was a problem hiding this comment.
Please don't wait for me. I'll open another PR when I'm finished.
lena-hinrichsen
changed the title
now nextflow.md
replaced by #222
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Provide docu (spec) about the workflow format decision: OCR-D/zenhub#90
Central documentation about crucial changes and decisions: Central documentation about crucial changes and decisions: OCR-D/zenhub#105