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

Documentation Clarity Updates #49

Open
brianjball opened this issue Feb 18, 2025 · 1 comment
Open

Documentation Clarity Updates #49

brianjball opened this issue Feb 18, 2025 · 1 comment

Comments

@brianjball
Copy link

Put the First and Last identifiers in the READMEs in code blocks to help them stand out more, e.g. First and Last.

Clear up the language around Secrets, especially when it comes to updating them. Maybe phrase it like "update secret.yaml".

Move the first "Creating The Secret" section to the end and link each individual section to it as necessary for a better flow.

@jharmison-redhat
Copy link
Collaborator

Additional feedback from a session today:

It would be useful to have a summarized, bulleted breakdown of the automation process, in addition to the diagram, to help SSAs understand the flow of the automation for those who have trouble following the diagram.

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

No branches or pull requests

2 participants