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

ENH: prompt user to update deployment docs, providing the necessary info to do so #20

Merged
merged 1 commit into from
Mar 26, 2024

Conversation

ZLLentz
Copy link
Member

@ZLLentz ZLLentz commented Mar 26, 2024

Description

After running the ansible script, prompt the user to update the deployment documentation.

If you made changes, please update the deployment docs (https://confluence.slac.stanford.edu/x/0IsFGg)
TcBSD Ansible Version: v0.1.0-54-g24b4a11
Link commit URL: https://github.com/pcdshub/twincat-bsd-ansible/tree/v0.1.0-54-g24b4a11
PLC Updated on: Mar 26, 2024

Motivation and Context

I'd like to keep the current deployments docs page as up-to-date as possible to keep track of our deployments. Doing this as we go is more likely to succeed than trying to run after the information later. Providing all the info needed so the engineer doesn't need to go digging for anything should get us to a point of minimum barrier of entry.

How Has This Been Tested?

Interactively only

Where Has This Been Documented?

This is mentioned on the plc setup page, the ansible workflows page, and on the current deployments docs page (all on confluence)

Pre-merge checklist

@ZLLentz ZLLentz requested review from ghalym and nrwslac March 26, 2024 17:22
@ZLLentz
Copy link
Member Author

ZLLentz commented Mar 26, 2024

I'd like Maggie's opinion on the specifics of the output and documentation here but I'm going to merge it because it's much better than not merging it.

@ZLLentz ZLLentz merged commit 780ccb9 into pcdshub:master Mar 26, 2024
1 check passed
@ZLLentz ZLLentz deleted the enh_version_info branch March 26, 2024 20:09
@ZLLentz ZLLentz mentioned this pull request Mar 28, 2024
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

Successfully merging this pull request may close these issues.

2 participants