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

fix(docs): improve helm template values docs #3783

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

anna-parker
Copy link
Contributor

@anna-parker anna-parker commented Mar 3, 2025

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

  • All necessary documentation has been adapted.
  • The implemented feature is covered by appropriate, automated tests.
  • Any manual testing that has been done is documented (i.e. what exactly was tested?)

@anna-parker anna-parker added the preview Triggers a deployment to argocd label Mar 3, 2025
@anna-parker anna-parker marked this pull request as ready for review March 3, 2025 09:08
@anna-parker anna-parker changed the title fix values docs fix(docs): improve helm template values docs Mar 3, 2025
Copy link
Contributor

@fhennig fhennig left a 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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Nextclade Preprocessing Pipeline ConfigFile (type)
#### Nextclade Preprocessing Pipeline ConfigFile

Copy link
Contributor Author

@anna-parker anna-parker Mar 3, 2025

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?

Copy link
Contributor

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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### Ingest ConfigFile (type)
#### Ingest ConfigFile

@anna-parker anna-parker requested a review from fhennig March 3, 2025 12:08
@fhennig
Copy link
Contributor

fhennig commented Mar 3, 2025

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 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
preview Triggers a deployment to argocd
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: make it clear which properties are part of the segment_identification object
2 participants