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

Improve the Operating guidance #199

Merged
merged 3 commits into from
Dec 12, 2024
Merged

Conversation

adrianclay
Copy link
Collaborator

What

  • Move the Environment Variables documentation to Operating
  • Add section to MHS README explaining SDS lookup methods

Why

Improve documentation, and reduce the number of support queries we get.

Type of change

Internal change (non-breaking change with no effect on the functionality affecting end users)

Checklist:

  • I have performed a self-review of my code
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the Changelog with details of my change in the UNRELEASED section if this change will affect end users

This information is relevant to both users of the adaptor and developers
of the adaptor.

Move it into the Operating guidance, so that users of the adaptor don't
have to delve into the developer notes.
The documentation didn't previously explain this very well.
@adrianclay adrianclay enabled auto-merge (squash) December 12, 2024 11:05
@adrianclay adrianclay merged commit 8079d2b into main Dec 12, 2024
1 check passed
@adrianclay adrianclay deleted the clarify-environment-variables branch December 12, 2024 11:39
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