posit-dev / posit-dev/connect-extensions

Deprecate usage-metric-dashboard extension

Open
#382 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
R
Stars
10
Forks
8
Avg merge
5d 18h
Merged PRs (30d)
1

Description

We want to deprecate the usage-metric-dashboard extension, although we have not fully landed on how exactly we will do it.

Easier/short-term option: Keep it entirely on the connect-extensions side — add a deprecation note to the README and update the item's description to point to the built-in feature and the Connect version that now includes it (a "carrot" to nudge the upgrade), optionally prefixing the title with [DEPRECATED]. This needs no product change and works on every Connect version.

Harder/long-term option: Product-side mechanism already filed here: https://github.com/posit-dev/connect/issues/40202 – a max_connect_version field so the Gallery automatically flags the item as superseded (pointing to the built-in alternative, and optionally hiding or badging it) once a server is past that version.

We also haven't decided on how long we'll let things stay deprecated before deletion. The leaning is to remove an item once the last Connect version that lacked the built-in feature is out of support, which lines up naturally with #40202's max_connect_version. FYI deletion is safe: anything a customer already deployed from the Gallery keeps working afterward (it's a static copy), and the source stays in the repo's git history. (It would be simpler to let deprecated items linger but stop updating them, but this would clutter the Gallery indefinitely.)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the extension README and the item's description, then read the linked Connect issue #40202. The work is not ready to begin until the project chooses between the short-term documentation approach and the longer-term product-side mechanism, including a deletion timeline.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.