readthedocs / readthedocs/ext-theme

Integrations: add more integration metadata

Open
#618 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Needed: design decision
Dominant language
HTML
Stars
12
Forks
6
Avg merge
13h 25m
Merged PRs (30d)
1

Description

In #617 I left some notes for next additions to the integration listing, for both GHA integration and the other existing integrations:

  • GHA integration could show "{number} exchanges" as well if there is a way we can get this data.
  • Or if we can't do that, "Last update 10 minutes ago" would be great still. This seems more likely.
  • With the GHA integration showing disconnection status, the other integrations could show a disconnected state too. We'd need a way to figure out how to actually detect that first though.
  • We should consider storing the GHA installation data on the Integration model and using that for the GHA edit/config URL. This is so we can link to the GHA installation previously used if someone removes the repository permission from the installation. [^1]

[^1]: Noted here https://github.com/readthedocs/readthedocs.org/blob/fc41cd2fb2f3ad4696d7bd3469614288466f1f80/readthedocs/integrations/models.py#L370-L374

Contributor guide

No contributing guide indexed for this repository

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

Read issue #617 and integrations/models.py around lines 370-374 first, then trace the integration listing and existing GHA integration in ext-theme. Clarify which of the four metadata, disconnection, or storage options is in scope; done should be defined by the selected behavior and its corresponding listing or configuration coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions
Domain
backend, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.