docs: generalize documentation, remove OpenNSW-specific references - #12
Merged
Conversation
Argus is a generic audit logging service, not tied to any one platform. Replace OpenNSW-specific naming (namespaces, keys, bucket names, example handlers) across the README, API docs, Helm chart, and client library comments with neutral, generic examples.
infra-staging read as a specific organization's environment name. Use the argus namespace instead, consistent with the rest of the genericized documentation.
A namespace is deployment-specific, so it should read as a placeholder to fill in rather than a concrete default, consistent with the existing <username> convention used elsewhere in the Helm chart docs.
ginaxu1
approved these changes
Aug 31, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Test plan
go build ./...go vet ./...