Skip to content

Conversation

@pabel-rh
Copy link
Member

@pabel-rh pabel-rh commented Oct 29, 2025

@rhdh-bot
Copy link
Collaborator

rhdh-bot commented Oct 29, 2025

@pabel-rh pabel-rh added Technical review done ⛅ Any procedure has been succesfully tested and removed Technical review needed 🔩 Test all the procedures labels Oct 30, 2025
@pabel-rh pabel-rh requested a review from deerskindoll October 30, 2025 16:00
Copy link
Member

@jmagak jmagak left a comment

Choose a reason for hiding this comment

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

A few suggestions, @pabel-rh.

Copy link
Contributor

@deerskindoll deerskindoll left a comment

Choose a reason for hiding this comment

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

as discussed, here's my feedback

extraFiles:
mountPath: /my/path
configMaps:
- name: cm1
Copy link
Contributor

Choose a reason for hiding this comment

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

I assume names such as file21.txt are user replaceable values. they need to be formatted as such. these rules are for both for file names and paths: https://redhat-documentation.github.io/supplementary-style-guide/#user-replaced-values

I'm not sure if cm1 etc. is user replaceable or not. I'd double-check with the SME

I'd change the names to something like <first_config_map_name>, <first_secret_name>, and <first_file_name> (followed by second secret name, third configmap name etc.)

`spec.application.secrets.configMaps.containers`:: Injects all keys from secret1
`spec.application.envs.containers`:: Targets only this container.

The following explicit options are supported:
Copy link
Contributor

Choose a reason for hiding this comment

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

this could be an admonition


[cols="1,2,3,2", options="header"]
|===
| Resource | Target type | Path(s) or name(s) | Container(s)
Copy link
Contributor

Choose a reason for hiding this comment

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

this is tricky because the contents are from a specific example. I'd add a title again Example (...)::

I assume /my/path/file11.txt, /my/path/file12.txt etc. are user replaceable values. we have two options, I think: either include the example input from the procedure above (include it as is, with the file names and paths) or format the user replaceable values according to the Red Hat style guide. I suggest you reach out to Gerry or Fabrice for a second opinion.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants