-
Notifications
You must be signed in to change notification settings - Fork 2
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
fix(docs): improve helm template values docs #3783
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just two minor things, but LGTM otherwise!
@@ -76,19 +76,25 @@ Definition of metadata fields for sequence entries of an organism, for example t | |||
<SchemaDocs group='preprocessing' fieldColumnClass='w-28' /> | |||
|
|||
The values for `args` and `configFile` depend on the used preprocessing pipeline. | |||
For the Nextclade preprocessing pipeline, please see | |||
|
|||
#### Nextclade Preprocessing Pipeline ConfigFile (type) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#### Nextclade Preprocessing Pipeline ConfigFile (type) | |
#### Nextclade Preprocessing Pipeline ConfigFile |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can remove this but now Im wondering - why do you put (type) in parenthesis for the other config components?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
the things that are types repeat in that same structure across the config (mostly). the section you added is a subsection of the properties of the type (you already used a subheading as well!) so it's not its own type IMO. That's how interpreted it! Also these type thingies are referenced in other parts of the table as "Types" (where it is just an object
)
it requires a list of segment names (nucleotide_sequences) and the nextclade_dataset that | ||
can be used for segment identification and alignment. | ||
|
||
#### Ingest ConfigFile (type) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
#### Ingest ConfigFile (type) | |
#### Ingest ConfigFile |
You re-requested a review but I think you didn't change anything, maybe you forgot to push? If you were still waiting for my reply, diregard this comment 😄 |
resolves #3782
preview URL: https://docs-fix-values-docs.loculus.org/reference/helm-chart-config
Summary
Clean up the helm template docs
Screenshot
PR Checklist