feedback icon indicating copy to clipboard operation
feedback copied to clipboard

[Docs Update] "Global Upload Token" refers to two different things

Open matt-codecov opened this issue 1 year ago • 0 comments

Description

In our docs, "Global Upload Token" refers to two unrelated tokens:

  • the "org-level token" that a user can find in the settings page for their org in Codecov
  • the "self-hosted service-wide token" that a self-hosted deployment specifies in, for example, github.global_upload_token in the installation yaml

We should give one (or both) of them a different name and make sure UX is updated accordingly.

The minimal fix would probably be to rename the self-hosted token since the docs and UX mostly are referring to the org-level token. We would want to rename the YAML option and update the docs, but still accept the old name in the YAML so we don't break anybody. We should also update the code because, unlike the docs, "Global Upload Token" in the code generally refers to this self-hosted option.

Page(s)

  • Self-hosted service-wide token: https://docs.codecov.com/docs/configuration#global-upload-tokens
  • Org-level token https://docs.codecov.com/docs/the-codecov-cli#how-to-get-an-upload-token
  • Mentions the org-level token: https://docs.codecov.com/docs/codecov-uploader#upload-token
  • Mentions the org-level token: https://docs.codecov.com/docs/vite-quick-start-vue-sveltekit-remix-solidjs-etc#step-2-configure-the-bundler-plugin
  • Mentions the org-level token: https://docs.codecov.com/docs/webpack-quick-start-nextjs-craco#step-2-configure-the-bundler-plugin
  • Mentions the org-level token: https://docs.codecov.com/docs/rollup-quick-start#step-2-configure-the-bundler-plugin

Maybe more?

Current State

[] Broken Link [x] Unclear Language [] Inconsistent Formatting [] Missing Information [] Missing Updates for New Features [] Deprecated Features

matt-codecov avatar May 30 '24 17:05 matt-codecov