readthedocs / readthedocs/ext-theme

Organizations: project listing page additions

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

Nobody has claimed this yet.

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

Description

The project listing page will need to have organizations factored into the project listings. Below are a few additions for this listing page, however it's important to consider the problems and design considerations:

  • Almost all users only have a singular organization, so redundantly listing the name of the organization in the project name or inside the project listing is a lot of wasted real estate.
  • Almost more important to this view would be the organization team, instead of just the organization. However, teams don't own projects, so this isn't a clear case of listing the projects sorted by team.
  • We can filter on teams though.

Some solutions to the above notes:

  • Only show the organization in the listing if the user belongs to more than one organization. Is this even worth it? Check the number of users this applies to, it very well might be essentially just the core team.
  • Having an organization filter might be most useful, instead of working the organization in the listing display. This is an okay middle ground.
  • Or, skip organization filtering and instead rely on team filtering to imply the organization? Or have a separate "All Foo organization teams"? Or a multi select filter instead? Again, the number of users here would be important.

So, a few feature additions to this page:

  • Maybe an organization metadata in the project listing items
  • Maybe an organization or team filter in the project listing
  • Maybe organization sidebar content? We currently have some links

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

Start at the project listing page and review how project listing items, filters, sidebar links, organizations, and teams are currently represented. First determine how many users belong to multiple organizations, then clarify which organization metadata or filtering behavior is wanted. Done means the chosen organization or team experience is implemented consistently on the listing page.

Written by the indexing model from the issue text.

Assessment

Tech stack
html
Domain
frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.