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

[DRAFT] UI redesign #9428

Merged
merged 349 commits into from
May 7, 2024
Merged

[DRAFT] UI redesign #9428

merged 349 commits into from
May 7, 2024

Conversation

a-hariti
Copy link
Collaborator

@a-hariti a-hariti commented Mar 12, 2024

Pre-merge checklist

If you work at Sentry, you're able to merge your own PR without review, but please don't unless there's a good reason.

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs
  • PR was reviewed and approved by a member of the Sentry docs team

Description of changes

a wip branch to implement the new design

closes #9369
closes #9694
closes #9656
closes #9423
closes #9223
closes #9220
closes #7437

Copy link

vercel bot commented Mar 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 7, 2024 1:27pm

@lizokm
Copy link
Contributor

lizokm commented Mar 13, 2024

@a-hariti this is a good first step!

Here are some changes we'd need to make in order of priority:

  • we would like to see an option of the platform dropdown that has both the languages and the frameworks as in this image:
Screenshot 2024-03-13 at 12 40 25 PM
  • we want to get rid of the separate product nav and move it so that it lives persistently even when users choose their SDK. (As a next step we'll need to reorganize the folder structure of the product docs, but we can do that a bit later.)
Screenshot 2024-03-13 at 12 55 58 PM
  • Python frameworks currently live in the "integration" section of docs, we'd need to make sure they are also visible in the dropdown.
Screenshot 2024-03-13 at 12 58 51 PM
  • Would like to see an option where there are 2 dropdown selectors, one for language and another for framework:
Screenshot 2024-03-13 at 1 04 29 PM
  • We don't need to worry about this right now, but of course we'd also need to update the colors/font styles etc. to reflect the new design:
Screenshot 2024-03-13 at 1 17 39 PM

@a-hariti
Copy link
Collaborator Author

Can the nested dropdown and two drop downs (for platforms & guides) coexist @lizokm ?

@lizokm
Copy link
Contributor

lizokm commented Mar 14, 2024

@a-hariti I don't think it makes sense for the nested dropdown and the two drop downs (for platforms & guides) to coexist. It should be one or the other.

Also, I resolved a conflict that may have led to more conflicts in the sidenav. Are you able to see the previews?

@a-hariti
Copy link
Collaborator Author

Yes, I can see the previews.

Thank you. I think you accidentally left a foreign string during the conflict resolution 🙊, I'll take care of it

Copy link

codecov bot commented Mar 15, 2024

Bundle Report

Changes will increase total bundle size by 629.32kB ⬆️

Bundle name Size Change
sentry-docs-server 7.42MB 259.74kB ⬆️
sentry-docs-edge-server 456.19kB 13.27kB ⬆️
sentry-docs-client 6.2MB 356.32kB ⬆️

@a-hariti
Copy link
Collaborator Author

@lizokm should the python integrations be converted to guides in the docs or should we just change to the way they are represented in the UI?

The second option will add some hardcoded logic for python in the code base

@lizokm
Copy link
Contributor

lizokm commented Mar 21, 2024

@stephanie-anderson @antonpirker would love your thoughts here: should the python integrations be converted to guides in the docs or should we just change to the way they are represented in the UI?

The second option will add some hardcoded logic for python in the code base

* update integration platform descsriptions

* Update docs/organization/integrations/integration-platform/index.mdx
This reverts commit c9b0171.

I still have no idea how is this related, but sigh!!
Copy link
Contributor

@stephanie-anderson stephanie-anderson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's do it

@stephanie-anderson stephanie-anderson merged commit 7be98c8 into master May 7, 2024
8 checks passed
@stephanie-anderson stephanie-anderson deleted the ui-redesign branch May 7, 2024 13:31
antonpirker pushed a commit that referenced this pull request May 14, 2024
* get rid of page grid CSS

* get rid of unused global styles

* use plain CSS instead of CSS modules for alert component

* migrate codeBlock to CSS modules

* scope externalLink styles

* scope expandable CSS styles

* feat: mobile layout + typography

* delete unused css files

* migrate some variables to CSS variables

* migrate search logo loader to SCSS modules

* move global :target styles to type.scss

* nuke bootstrap 🔥

* fix missing @popperjs/core dep

* fix breadcrumbs wrapping

* fix mobile nav dimensions

* refactor Header component

* fix 404 page

* fix typo

* split /pricing from /product/accounts/pricing

* remove unused CSS files

* publish header height as a CSS variable

* fix layout overflow

* [getsentry/action-github-commit] Auto commit

* set the correct monospcae font for tailwind CSS

* add missing comma

* handle static redirects in middleware instead of vercel.json

* remove extra comma 🙊

* remove obvious duplicate static redirects

* gather duplicate redirects that need discussion to the top

* refactor Redirect type definition

* add missing leading slash to redirectpath

* fix sidebar trigger pointer

* adjust mobile menu items padding & font size

* api page styles

* fix header font weight

* refactor: use a friendlier predicate for Typescript on Array.filter()

* center main page content and page toc on doc page

* adjust heading anchor icon size

* slightly thinner  borders

* adjust search results border color

* make box shadows consistent

* get rid of unused #sidebar and associated styles

* give search results a box shadow instead of a border

* give search input more width on focus

* make page toc fade in nicely

* fix jumping on platformSelector

* set img display to inline insde links

* fix sidebar scrolling behavior

* make page toc fixed width to avoid layout shift

* fix active sidebar item scrollIntoView scrolling main page a bit

* refactor: simplify serverSidebar serverSidebar logic

* refactor: remove unecessary condition

* refactor: move ProductSidebar and ApiSidebar to serverSidebar

* refactor: move PlatformSidebar into serverSidebar

* refactor: render contributing docs using DynamicNav

* refactor: move default sidebar to serverSidebar and make it a server
component

* refactor: remove non exisiting entry for `_debug` from serverSidebar

* fix platformGrid margin bottom

* refactor: delete uncessary useEffect

* refactor: rename serverSidebar to just sidebar

* refactor: remove unused style

* split sidebar and TOC styles

* refactor: move all sidebar bits to sidebar component + use CSS modules

* fix page TOC scrolling behavior

* refactor mobile sidebar toggle logic

* fix main page content margin on tablets when sidebar is open

* refactor: no need for a global id for sidebar toggle

* fix: forward sidebar header item styles to dynamicNav

* aktually

* Split concepts and references into separate section (#9681)

* [getsentry/action-github-commit] Auto commit

* refactor: remove unused highlight styles

* remove unused class name from type.scss

* refactor: move typography styles next to DocPage

* fix missing sidebar close button on api page

* fix: insert some space between api page columns

* refactor: condense paramTable styles

* refactor: move api page styles closer to consumeing module

* refactor: end of the monolithic screen.scss file 🥳

* feat: keep selected item at the top on platformSelector.

* do I have proper access??

* refactor: merge home components into one

* resolve confilicting redirects

* Remove headline above platform selector

* Change breadcrumb separator

* collapse product sidebar on `/platforms/(.*)`

* Fix some styles

* fix type error

* Change placeholder text and additional sidebar links

* Add quick improvements to sidebar

* align search field to the left edge of the main text on desktop

* fix: get rid of unused collapseAll flag

* make tailwind forms plugin opt in

* feat: paltform filter on home page

* fix: add default value for --sidebar-width

* refactor: leaner styles on home page (after bootsrap migration)

* delete empty class

* make nav items uppercase

* feat: add separator between search field and ask a bot button

* hide search separator button on mobile

* fix loading logo size

* fix search results alignment

* Update support helpdesk URL

* [getsentry/action-github-commit] Auto commit

* Display page description on page

* Update page descriptions

* Relocate SDK details; make it less prominent

* feat: platformSelector guide nesting

* fix: hide scorllbar on platformSelector

* fix missing tokens on mobileMenu

* fix search results width on phones

* Hide troubleshooting items in Expandable component

* feat: nest guides under platforms on home page sdk search

* refactor: migrate platformGrid to CSS modules

* refactor: Alert doesn't need to be a client component

* refactor: migrate relayMetrics to CSS modules

* refactor: move platformSdkDetail to CSS modules

* refactor: migrate jsBundleList to CSS modules

* fix: add missing </Expandable> tag

* refactor: migrate cliChecksumTable to CSS modules

* Add/update some page descriptions

* Split out docs about account and organization management

* fix: formatting noise

* split security legal & pii section (#9722)

* split security legal & pii section

* formatting error

* adjust PII field color

* adjust piiFields styles and make it a server component

* add redirects

* fix: remove unecessary node pii files

* fix platform titles with periods handling

* fix: relax platformSelector select height for wrapped elements

* refactor: scroll active platform to the top of platformSelector
instead of selected guide

* refactor: simplify prop names

---------

Co-authored-by: Abdellah Hariti <haritiabdellah@gmail.com>

* fix: remove | behind or separator

* fix: reword platformSelector placeholder

* Fix codecovs page description

* fix header overscroll behavior

* fix header scroll margin

* feat: remember selected platform on non platform pages

* fix: delte frgotten `console.log`s

* Remove EA banner (#9761)

GA

* update configure your org/configure your account names and descriptions.

* adjust landing page hero spacing

* refactor: unify API sidebar with product sidebar

* refactor: DRY product sidebar items generation

* refactor: additonal resources can never be active and don't need path

* refactor: simplify platform sidebar logic

* formatting noise

* fix focus lost on platformSelector on /platforms/

* refactor: move sidebar trigger to the left of the header logo

* fix platformSelector bug upon switching platforms

* Extract integrations documentation

* fix: highlight sidebar items title on corresponding index pages

* refactor: different highlighting for sidebar title vs links

* Fix small styles and nav items

* Revert "refactor: different highlighting for sidebar title vs links"

This reverts commit 3390dd1.

* get rid of "Getting Started" on platform index page

* fix: remember current platform when choosing a platform from landing page

* fix: don't save Tabgroup to localStorage when there's only one tab in CodeTabs

* fix: don't show sidebar hamburger trigger on home page

* fix Security-Legal link on home page

* fix: make header logo smaller

* refactor: more consistent padding on home page

* fix data scrubbing redirects (#9792)

* feat: get a hit on python when searching for python web frameworks on
home page

* feat: improve deeplinking to platform guides on platform selector

* take keywords into consideration during search on platformSelector

* fix: improve sidebar on platform redirect page

* refactor: make Breadcrumbs component unaware of serverContext

* forward request pathname as a special header: `x-pathname`

* refactor: make Sidebar component unaware of serverContext

* feat: a smarter 404 page

* refactor: simplify ternary

* refactor: get rid of unecessary nulls and their implications

* fix: improve platform packing on home page platform filter

* update sidenav titles

* Not so smart 404 but still useful

This reverts commits d372a4d and 9fff81a.

* add 404 error issue template

* more consistent sidebar separator

Closes #9827

* fix wrong sidebar toggle id

* fix mobile sidebar overflow issue

Closes #9828

* oops: hide sidebar by default

* akshually fix the sidebar overflow mobile

* show useful content above the fold

* feat: expand platforms on platformFilter while searching

* feat: a nicer scrollbar on platform filter items (when necessary)

* update meta descriptions for docs in new concepts section (#9795)

* update meta descriptions for docs in new concepts section

* Apply suggestions from code review

Co-authored-by: Liza Mock <liza.mock@sentry.io>

---------

Co-authored-by: Liza Mock <liza.mock@sentry.io>

* Firefox scrollbar styles

* smooth animations on platform expansion

feature phone friendly :)

* expand paltform with at least 2 character search string

* load platform icons ASAP

* fix search accross all sites button

* improve typescript types on Search

* feat: show python integrations as guides on home page.

* show Android and Elixir integrations on the home page

* show platform integrations on platformSelector

* refactor: sort platforms alphabetically

* refactor: remove unecessary null check

* chore: get rid of annoying cache size limit (useless anyway) Error

* chore: fix boolean attribute error

* chore: suppress missing metadataBase warning

* refactor: migrate codeKeywords/Keyword from defaultProps to js default
parameters

* refactor: migrate codeKeywords/KeywordIndicator from defaultProps to js default parameters

* refactor: migrate codeKeywords/AnimatedContainer from defaultProps to js default parameters

* chore: improve frontmatter doc comments

* chore: suppress console warnings

* chore: fix missing hooks deps

* refactor: use next/image where it makes sense | 0 warnings 🎉

* fix `/product/accounts` redirect

* fix cron getting started with cli redirect, closes #9848

* fix redirect syntax 🙊

* Change redirect order

* remove dynamic segment from SaaS migration redirect

* move the rest of `/product/accounts/*` to static redirects

* fix me up

* fix: dedupe issue grouping redirect

* fix: dedupe js guides default integrations redirect

* fix redirect typo

* fix: dedupe data management redirect

* add root /account redirecT

* formatting noise

* feat: sync TOC to URL #hash

* fix intersection observer on Safari

* fix expandable indicator layout

* fix codeBlock selection color

closes #9882

* fix platformSelector flicker

closes 9881

* fix: reduce vertical margin around images

* fix: don't show stored platform on `/platforms/`

* fix: separate top left hamburer menu from logo

* fix platformSelector on mobile

* update meta descriptions for org membership, troubleshooting, and cloud integrations (#9903)

* attempt to fix `/account` 404 🤞

* Revert "attempt to fix `/account` 404 🤞" | not really :(

This reverts commit 167d7af.

* chore: update next.js to 14.2

* update integration platform descsriptions (#9916)

* update integration platform descsriptions

* Update docs/organization/integrations/integration-platform/index.mdx

* Revert next.js update

This reverts commit 2995344.

* update notification incidents integrations descriptions (#9918)

* try a fix for /account

* famous last words: useless anyway (#9928)

This reverts commit c9b0171.

I still have no idea how is this related, but sigh!!

* feat: add more emphasis to active sidebar item

* a denser home page

* better platformFilter search field alignment

* Add more contrast to the table of contents font colors

* refactor: migrate articleFooter to CSS modules

* refactor: migrate changelog buttons to CSS modules

* fix: make TS happy

* fix: better Chevron rotation range

* fix menu flicker when clicking an active changelog navbar element

---------

Co-authored-by: vivianyentran <vivian.tran@sentry.io>
Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
Co-authored-by: Stephanie Anderson <stephanie.anderson@sentry.io>
Co-authored-by: vivianyentran <20403606+vivianyentran@users.noreply.github.com>
Co-authored-by: George Gritsouk <989898+gggritso@users.noreply.github.com>
Co-authored-by: lizokm <lizka920@gmail.com>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
@github-actions github-actions bot locked and limited conversation to collaborators May 23, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.