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

Feature Request: Create a view that is "list" instead of "map" #120

Closed
momack2 opened this issue Nov 17, 2022 · 13 comments · Fixed by #341
Closed

Feature Request: Create a view that is "list" instead of "map" #120

momack2 opened this issue Nov 17, 2022 · 13 comments · Fixed by #341
Assignees
Labels
effort/days The work in this issue, which should be status/ready, should take less than a week to complete enhancement New feature or request P0 post-MVP status/ready This issue has enough information to be worked on and no technical blockers or pre-reqs

Comments

@momack2
Copy link

momack2 commented Nov 17, 2022

In roadmaps like the FVM roadmap (fvm.filecoin.io) it is useful to see a single webpage where you can view the linear milestones top to bottom (including the description in prose).

  • It would be useful for multiple groups and to be rendered in a tool (vs manually created on websites)
  • It would also be useful to be able to embed that in a website - so that it updates programmatically when the github issues are changed.

CleanShot 2022-11-16 at 19 20 02

@momack2 momack2 changed the title Feature Request: Create a view that is "list" instead if "roadmap" Feature Request: Create a view that is "list" instead of "map" Nov 17, 2022
@SgtPooki SgtPooki added post-MVP status/needs-clarification This issue requires further information prior to becoming ready for work effort/days The work in this issue, which should be status/ready, should take less than a week to complete labels Nov 17, 2022
@juliaxbow
Copy link
Collaborator

juliaxbow commented Jan 3, 2023

Including some rough mockups below for how this could look. Let me know which direction is preferred and we can go from there.

Some addt'l questions:

  • How closely do we want this to match FVM formatting? The alternative is to include in table format
    • I assume we would like all parameters to be the same for this view, e.g. include explicit ETA rather than high-level month/quarter? This makes the FVM-style a bit less neat but shouldn't be a problem
  • Is there any other metadata from GitHub we would like to include?

Alt. 1 High Level List
List View Alt 1 (FVM Style)

Alt. 2 Table View
List View Alt 2 (Table)

@SgtPooki
Copy link
Contributor

ping @momack2

I say we go with the first option for now.. it makes the descriptions much easier to read, and as our only view with descriptions, that's important.

cc @tinytb

@SgtPooki SgtPooki added enhancement New feature or request status/ready This issue has enough information to be worked on and no technical blockers or pre-reqs labels Jan 24, 2023
@SgtPooki SgtPooki added P1 P0 and removed P1 labels Feb 3, 2023
@momack2
Copy link
Author

momack2 commented Feb 9, 2023

I also like option 1 better!

@momack2
Copy link
Author

momack2 commented Feb 9, 2023

I also think working on the list view is a more impactful short term win. we can debug specific css positioning changes after landing this.

@AlexxNica
Copy link
Collaborator

We may have to handle multiple items under the same date. Any ideas on how we would display that?

An idea using the FVM example as inspiration would be to show them under an indented list (like Milestone 2.1 there) and have the date be the header.

@SgtPooki
Copy link
Contributor

An idea using the FVM example as inspiration would be to show them under an indented list (like Milestone 2.1 there) and have the date be the header.

@AlexxNica I like that approach, we can fine-tune as we get feedback, but that sounds more than reasonable for now. Are you working on the list view? You mentioned, via slack, having put some effort toward that. I'm planning to take that on as core work tomorrow and finish within a week or so. lmk

@SgtPooki SgtPooki removed the status/needs-clarification This issue requires further information prior to becoming ready for work label Feb 24, 2023
@SgtPooki SgtPooki self-assigned this Feb 24, 2023
@AlexxNica
Copy link
Collaborator

@SgtPooki I started exploring. I'll add that to a branch in my fork and ping you; hopefully that saves you some time. I can also help review the PR when it comes in. Sounds good?

@SgtPooki
Copy link
Contributor

thanks Alex!

@AlexxNica
Copy link
Collaborator

Here's the template: https://codepen.io/AlexxNica/pen/gOdwxwa

I think the template can be a starting point (that's how I prototyped the list view before), but there are definitely other ways to achieve the same, so feel free to choose whatever method you're most comfortable with!

@SgtPooki let me know if it'd be helpful to pair up for some time next week to do this together. 🙌

@SgtPooki
Copy link
Contributor

Thanks Alexx, that's a great snippet for showing the nesting 👍

got the basic view done for now. working on styling the titles and such before I hop into nesting:

image

just using a simple grid and template areas for the items at this point

      templateAreas={`"date icon title"
                      "empty line description"`}
      gridTemplateRows={'1fr 1fr'}
      gridTemplateColumns={'1fr 0.5fr 8fr'}

@SgtPooki
Copy link
Contributor

SgtPooki commented Mar 4, 2023

I believe the intention with this list view was to render all children, but I don't think that's a great UX, and so the first pass is going to only render the direct children (similar to how overview only shows direct children). This causes a few issues with navigation within the list view.

The initial design doesn't give guidance on communicating to users what links are clickable or not, nor whether to differentiate between linkable children or not, so i've been looking over a number of separate ways to communicate this (because all issue titles are currently Blue and look clickable).

Display all links as blue, clickable or not (in original mockup from Julia)

Pros

  • Looks great
  • Hover state can potentially communicate clickability to users.

Cons

  • Cannot tell at first glance which items are clickable or not

Screenshot

image

Display clickable links as blue, and non-clickable as black.

It's how we do it on overview/detailed view

Pros

  • Convention aligns with other screens
  • Users can immediately see which items are clickable

Cons

  • Doesn't look great on list view.

Screenshot

image

Use underlines

Very common and accessible; but not "pretty." Out of fashion.

Pros

  • Users can immediately see which items are clickable

Cons

  • We don't use underlines for links on starmap.site unconventional and surprising(UX bug)
  • Doesn't look great

Screenshot

image

Use an icon to indicate traversibility

Pros

  • Users can immediately see which items are clickable
  • Looks good and gives flexibility with coloring
  • link icon should be pretty intuitive in this scenario.

Cons

  • Can look odd depending on how we want to position it

Screenshots

Arrow

image

Link Icon (front)

image

Link icon (rear)

image


I'm going to go with the link icon in the front for now, but let me know if others have better ideas, comments, questions, or concerns.

cc @whizzzkid

@SgtPooki
Copy link
Contributor

SgtPooki commented Mar 4, 2023

There is also a discussion in #196 (comment) pertaining to parsing of "description:" content from milestones.

@whizzzkid
Copy link
Collaborator

whizzzkid commented Mar 4, 2023

@SgtPooki I like the link icon at the end, reminds me of Reddit. Using ellipses along with that might not be a bad idea either.

Also the GitHub issue will be linked, so two links will exist side by side, I can understand the rationale with link icon before and why you like it.

Can we also change the link icon from 🔗 to something like this https://icons8.com/icons/set/open-url the former is more related to inserting a link than opening (latter)

@SgtPooki SgtPooki linked a pull request Mar 4, 2023 that will close this issue
@github-project-automation github-project-automation bot moved this from Triage 🩺 to Done ✅ in PLN Planning Tools - High Level Tracker Mar 22, 2023
@github-project-automation github-project-automation bot moved this from Todo to Done in Starmap Mar 22, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
effort/days The work in this issue, which should be status/ready, should take less than a week to complete enhancement New feature or request P0 post-MVP status/ready This issue has enough information to be worked on and no technical blockers or pre-reqs
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

5 participants