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

notifications not visible if folks first experience is starting out on an api docs page #1356

Closed
susanev opened this issue Jan 12, 2022 · 12 comments

Comments

@susanev
Copy link
Contributor

susanev commented Jan 12, 2022

overview

updated description

some of our packages have important notifications on the overview pages, but we know most users come in via the API docs pages, so they totally miss this important information. we have the header that is visible on every page, lets figure out how to put important notifications in that area so its accessible from every package page.

original description

if folks first start out on an API docs page they may never see the note on the overview page that gives information about the native provider. we may want to consider having access to this information in the header so no matter what page of the package they are on they have access to this info.

original report from a user:
#547 (comment)

@susanev susanev added customer/feedback kind/enhancement Improvements or new features labels Jan 12, 2022
@susanev susanev changed the title not clear that we have a classic and native providers if folks first experience is starting out on an api docs page not clear that we have classic and native providers if folks first experience is starting out on an api docs page Jan 12, 2022
@jonelleb jonelleb self-assigned this Mar 11, 2022
@jonelleb
Copy link

Design Goals

Users may be starting out on the API Docs page and miss the Azure Native provider info. banner that's currently located on the Overview page only. We want to design a way that the user sees this message no matter what page they are on.

@susanev
Copy link
Contributor Author

susanev commented Mar 16, 2022

@jonelleb what would you think of possibly leaving the notes on the pages as is, and then having a much shorter message in the top section, possibly with new styles instead of the note styles? im asking because there has been previous feedback on the height of our header and i worry a bit about this increasing the height even more. this is partly an eng constraint because every time someone takes an action we totally reload the page. happy to chat more over zoom sometime if it would be helpful to you!

@jonelleb
Copy link

@susanev - I definitely think having the message shorter would help and I can update the style of banner- the only reason I didn't make any changes to the styling is I thought this issue was just a minimal effort change and didn't think changing the look of the actual banner was part of it.

@susanev
Copy link
Contributor Author

susanev commented Mar 16, 2022

ah yah, sry about that. i think this work should possibly be about how we can add some kind of general-purpose notification into the top of package pages (with the first application being this particular use case). ill do better at describing these kinds of things in issues going forward.

@jonelleb
Copy link

No problem. I'll move this back to UX design and work on an updated design.

@jonelleb jonelleb removed the size/XS label Mar 16, 2022
@jonelleb
Copy link

jonelleb commented Mar 21, 2022

Figma File

Overview tab

Screen Shot 2022-03-21 at 11 14 36 AM

Design Changes

Screen Shot 2022-03-21 at 11 18 21 AM

Installation & Configuration tab

Screen Shot 2022-03-21 at 11 15 01 AM

API Docs tab

Screen Shot 2022-03-21 at 11 15 21 AM

How-to-Guides tab

Screen Shot 2022-03-21 at 11 17 03 AM

@jonelleb
Copy link

Additional Changes

  • On all of the tabs, Pulumi Official graphic has been moved next to 'Azure Classic' header

Engineer Notes

  • Comments have been added in Figma but please feel free to reach out with any questions or concerns.

Thanks!

@susanev
Copy link
Contributor Author

susanev commented Apr 10, 2022

@anita-trimbur can you take a look at the adjustment to the official label and let us know what you think?

@jonelleb im still worried about the increase in height of this header, lets chat more about this in our 1-1 this week.

@susanev susanev self-assigned this Apr 10, 2022
@anita-trimbur
Copy link

I think this label position is great. Kimberley and I weren't able to position it exactly where it was initially designed anyway, so I absolutely support this change.

@susanev susanev removed their assignment Apr 25, 2022
@susanev susanev transferred this issue from pulumi/pulumi-hugo Aug 16, 2022
@jkodroff
Copy link
Member

Is it possible to tighten up the layout vertically by putting the logo on the same line as "Azure Classic"?

@susanev susanev changed the title not clear that we have classic and native providers if folks first experience is starting out on an api docs page notifications not visible if folks first experience is starting out on an api docs page Sep 20, 2022
@susanev
Copy link
Contributor Author

susanev commented Sep 20, 2022

ive updated this issue to be more generic as we are now running into this issue with other packages, including awsx

@anita-trimbur
Copy link

closing this issue as fixed via #1797

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Archived in project
Development

No branches or pull requests

4 participants