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

Remove potentially misleading part of automated reporting docs #29297

Merged

Conversation

VioletHynes
Copy link
Contributor

@VioletHynes VioletHynes commented Jan 6, 2025

Description

This section of the docs implies a way for customers to use and ingest the automated reporting, which has confused customers. I think it's clearer if we simply remove it.

TODO only if you're a HashiCorp employee

  • Backport Labels: If this fix needs to be backported, use the appropriate backport/ label that matches the desired release branch. Note that in the CE repo, the latest release branch will look like backport/x.x.x, but older release branches will be backport/ent/x.x.x+ent.
    • LTS: If this fixes a critical security vulnerability or severity 1 bug, it will also need to be backported to the current LTS versions of Vault. To ensure this, use all available enterprise labels.
  • ENT Breakage: If this PR either 1) removes a public function OR 2) changes the signature
    of a public function, even if that change is in a CE file, double check that
    applying the patch for this PR to the ENT repo and running tests doesn't
    break any tests. Sometimes ENT only tests rely on public functions in CE
    files.
  • Jira: If this change has an associated Jira, it's referenced either
    in the PR description, commit message, or branch name.
  • RFC: If this change has an associated RFC, please link it in the description.
  • ENT PR: If this change has an associated ENT PR, please link it in the
    description. Also, make sure the changelog is in this PR, not in your ENT PR.

@VioletHynes VioletHynes requested a review from a team as a code owner January 6, 2025 19:10
@github-actions github-actions bot added the hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed label Jan 6, 2025
Copy link

github-actions bot commented Jan 6, 2025

CI Results:
All Go tests succeeded! ✅

Copy link

github-actions bot commented Jan 6, 2025

Build Results:
All builds succeeded! ✅

@judithpatudith
Copy link
Contributor

Hello, and thank you for the feedback!! Just so I understand the issue and know what to ask about, are we saying that it isn't possible for customers to ingest the automated reporting data?

These docs are standardized across all the products and went through a kind of extensive vetting process, so I'd like to run the proposed change past those stakeholders to make sure that we're ok removing this line for all the products. Sorry to add a little bit or red tape, and thanks for your patience!

@VioletHynes
Copy link
Contributor Author

It's possible to ingest license utilization data (e.g. https://developer.hashicorp.com/vault/api-docs/system/internal-counters) but that's not tied to automated reporting. This section has been misleading and has confused customers in the field. Automated reporting turns on reporting Census data to HashiCorp, not other reporting solutions --- and it's not intended to be customer facing (this is the main thing that has confused customers).

@VioletHynes VioletHynes merged commit 539a7b7 into main Jan 6, 2025
42 of 45 checks passed
@VioletHynes VioletHynes deleted the violethynes/remove-misleading-sentence-automated-reporting branch January 6, 2025 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
hashicorp-contributed-pr If the PR is HashiCorp (i.e. not-community) contributed pr/no-changelog pr/no-milestone
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants