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.

Sign up for GitHub

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

Jump to bottom

feat(glossary): add sidebar to Glossary pages #26985

Merged
merged 5 commits into from
Jun 8, 2023
Merged

feat(glossary): add sidebar to Glossary pages #26985

merged 5 commits into from
Jun 8, 2023

Conversation

bsmth
Copy link
Member

@bsmth bsmth commented May 26, 2023

Description

This PR adds the glossary sidebar to sub-pages

Motivation

This should improve discoverability and allow readers to find other terms

@bsmth bsmth requested a review from a team as a code owner May 26, 2023 10:05
@bsmth bsmth requested review from chrisdavidmills, Rumyra and a team and removed request for a team May 26, 2023 10:05
@github-actions github-actions bot added the Content:Glossary Glossary entries label May 26, 2023
@github-actions
Copy link
Contributor

github-actions bot commented May 26, 2023 •
edited
Loading

Preview URLs (300 pages)
Flaws (87)

Note! 265 documents with no flaws that don't need to be listed. 🎉

URL: /en-US/docs/Glossary/Ink_overflow
Title: Ink overflow
Flaw count: 4

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Backgrounds_and_Borders
    • Can't resolve /en-US/docs/Web/CSS/CSS_Text_Decoration
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flow_Layout/Intro_to_formatting_contexts
    • Can't resolve /en-US/docs/Web/CSS/CSS_Overflow

URL: /en-US/docs/Glossary/Grid_Column
Title: Grid Column
Flaw count: 3

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Basic_Concepts_of_Grid_Layout

URL: /en-US/docs/Glossary/Flexbox
Title: Flexbox
Flaw count: 7

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Relationship_of_Flexbox_to_Other_Layout_Methods
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Aligning_Items_in_a_Flex_Container
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Ordering_Flex_Items
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Controlling_Ratios_of_Flex_Items_Along_the_Main_Ax
    • and 2 more flaws omitted

URL: /en-US/docs/Glossary/Grid_Container
Title: Grid container
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Basic_Concepts_of_Grid_Layout

URL: /en-US/docs/Glossary/Cross_Axis
Title: Cross Axis
Flaw count: 3

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Aligning_Items_in_a_Flex_Container
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Mastering_Wrapping_of_Flex_Items

URL: /en-US/docs/Glossary/Grid_Axis
Title: Grid Axis
Flaw count: 5

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Box_Alignment_in_CSS_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/CSS_Grid_Logical_Values_and_Writing_Modes
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Basic_Concepts_of_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Box_Alignment_in_CSS_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/CSS_Grid_Logical_Values_and_Writing_Modes

URL: /en-US/docs/Glossary/Cryptography
Title: Cryptography
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/Security/Information_Security_Basics
    • Can't resolve /en-US/docs/Archive/Security/Encryption_and_Decryption

URL: /en-US/docs/Glossary/Flex_Container
Title: Flex Container
Flaw count: 3

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Aligning_Items_in_a_Flex_Container
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Mastering_Wrapping_of_Flex_Items

URL: /en-US/docs/Glossary/Grid_Cell
Title: Grid Cell
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Basic_Concepts_of_Grid_Layout

URL: /en-US/docs/Glossary/Cipher_suite
Title: Cipher suite
Flaw count: 1

  • macros:
    • /en-US/docs/Glossary/cryptosystem does not exist

URL: /en-US/docs/Glossary/JavaScript
Title: JavaScript
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/JavaScript/reference

URL: /en-US/docs/Glossary/Gamut
Title: Gamut
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/Media_Queries/Using_media_queries

URL: /en-US/docs/Glossary/Lossless_compression
Title: Lossless compression
Flaw count: 4

  • macros:
    • /en-US/docs/Glossary/GZIP does not exist
    • /en-US/docs/Glossary/Brotli does not exist
    • /en-US/docs/Glossary/GZIP does not exist
    • /en-US/docs/Glossary/Brotli does not exist

URL: /en-US/docs/Glossary/Grid_Areas
Title: Grid Areas
Flaw count: 4

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Line-based_Placement_with_CSS_Grid
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Grid_Template_Areas
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Basic_Concepts_of_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Grid_Template_Areas

URL: /en-US/docs/Glossary/Flex_Item
Title: Flex Item
Flaw count: 3

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Ordering_Flex_Items
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Controlling_Ratios_of_Flex_Items_Along_the_Main_Ax

URL: /en-US/docs/Glossary/Flex
Title: Flex
Flaw count: 7

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Relationship_of_Flexbox_to_Other_Layout_Methods
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Aligning_Items_in_a_Flex_Container
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Ordering_Flex_Items
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Controlling_Ratios_of_Flex_Items_Along_the_Main_Ax
    • and 2 more flaws omitted

URL: /en-US/docs/Glossary/Grid
Title: Grid
Flaw count: 2

  • macros:
    • /en-US/docs/Glossary/grid_item does not exist
  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Basic_Concepts_of_Grid_Layout

URL: /en-US/docs/Glossary/Endianness
Title: Endianness
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/JavaScript/Typed_arrays

URL: /en-US/docs/Glossary/Cryptographic_hash_function
Title: Cryptographic hash function
Flaw count: 1

  • macros:
    • /en-US/docs/Glossary/digital_signature does not exist

URL: /en-US/docs/Glossary/FPS
Title: Frame rate (FPS)
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Images/Implementing_image_sprites_in_CSS

URL: /en-US/docs/Glossary/Cipher
Title: Cipher
Flaw count: 2

  • macros:
    • /en-US/docs/Glossary/attack does not exist
  • broken_links:
    • Can't resolve /en-US/docs/Archive/Security/Encryption_and_Decryption

URL: /en-US/docs/Glossary/Main_Axis
Title: Main Axis
Flaw count: 3

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Basic_Concepts_of_Flexbox
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Aligning_Items_in_a_Flex_Container
    • Can't resolve /en-US/docs/Web/CSS/CSS_Flexible_Box_Layout/Controlling_Ratios_of_Flex_Items_Along_the_Main_Ax

URL: /en-US/docs/Glossary/Global_object
Title: Global object
Flaw count: 1

  • macros:
    • /en-US/docs/Glossary/interface does not exist

URL: /en-US/docs/Glossary/Internationalization_and_localization
Title: Internationalization
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Basic_Concepts_of_Grid_Layout

URL: /en-US/docs/Glossary/Grid_Lines
Title: Grid Lines
Flaw count: 6

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Writing_Modes
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Basic_Concepts_of_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Line-based_Placement_with_CSS_Grid
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Layout_using_Named_Grid_Lines
    • and 1 more flaws omitted

URL: /en-US/docs/Glossary/Key
Title: Key
Flaw count: 1

  • macros:
    • /en-US/docs/Glossary/cryptosystem does not exist

URL: /en-US/docs/Glossary/Grid_Row
Title: Grid Row
Flaw count: 3

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Basic_Concepts_of_Grid_Layout

URL: /en-US/docs/Glossary/Media/CSS
Title: Media (CSS)
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/Media_Queries/Using_media_queries
    • Can't resolve /en-US/docs/Web/CSS/Media_Queries

URL: /en-US/docs/Glossary/Grid_Tracks
Title: Grid Tracks
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Basic_Concepts_of_Grid_Layout

URL: /en-US/docs/Glossary/Attribute
Title: Attribute
Flaw count: 2

  • macros:
    • /en-US/docs/Web/API/HTMLInputElement/placeholder does not exist
    • /en-US/docs/Web/API/HTMLInputElement/placeholder does not exist

URL: /en-US/docs/Glossary/Fallback_Alignment
Title: Fallback alignment
Flaw count: 2

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Box_Alignment
    • Can't resolve /en-US/docs/Web/CSS/CSS_Box_Alignment

URL: /en-US/docs/Glossary/Gutters
Title: Gutters
Flaw count: 3

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Box_Alignment_in_CSS_Grid_Layout
    • Can't resolve /en-US/docs/Web/CSS/CSS_Grid_Layout/Basic_Concepts_of_Grid_Layout

URL: /en-US/docs/Glossary/Baseline/Typography
Title: Baseline (typography)
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Web/CSS/CSS_Box_Alignment#types_of_alignment

URL: /en-US/docs/Glossary/Decryption
Title: Decryption
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Encryption_and_Decryption

URL: /en-US/docs/Glossary/Fetch_metadata_request_header
Title: Fetch metadata request header
Flaw count: 1

  • macros:
    • /en-US/docs/Glossary/resource_isolation_policy does not exist

(comment last updated: 2023-06-08 08:37:02)

Josh-Cena
Josh-Cena requested changes May 26, 2023
View reviewed changes
Copy link
Member

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

Instead of adding this unmaintainable chunk, we should add a new macro to Yari. The current implementation is not performant as the sidebar height grows with the section's size (and this section is meant to grow steadily). We should implement the sidebar as automatically categorized by initial letter and collapsed under <details>.

@bsmth bsmth marked this pull request as draft May 31, 2023 09:03
@bsmth bsmth mentioned this pull request Jun 2, 2023
Merged
1 task
@bsmth
Copy link
Member Author

bsmth commented Jun 2, 2023 •
edited
Loading

we should add a new macro to Yari

Yes, this is better. I was hoping to avoid adding more macros, but this is an exception.

We should implement the sidebar as automatically categorized by initial letter and collapsed under <details>.

The linked PR does a 1:1 implementation of the current Glossary sidebar, there will be generic sidebar improvements coming soon (filtering). If this PR lands, I would look into collapsing alphabetically like you suggested, but this will be a follow-up for now.

@github-actions github-actions bot added the merge conflicts 🚧 [PR only] label Jun 5, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jun 5, 2023

This pull request has merge conflicts that must be resolved before it can be merged.

@bsmth bsmth marked this pull request as ready for review June 8, 2023 08:31
@github-actions github-actions bot removed the merge conflicts 🚧 [PR only] label Jun 8, 2023
@bsmth bsmth mentioned this pull request Jun 8, 2023
Merged
@Rumyra Rumyra merged commit ada5fa5 into mdn:main Jun 8, 2023
This was referenced Jun 14, 2023
Merged
Merged
@tristantheb tristantheb mentioned this pull request Oct 9, 2023
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Josh-Cena Josh-Cena Josh-Cena requested changes

@Rumyra Rumyra Rumyra approved these changes

@chrisdavidmills chrisdavidmills Awaiting requested review from chrisdavidmills chrisdavidmills is a code owner automatically assigned from mdn/yari-content-mdn

Assignees
No one assigned
Labels
Content:Glossary Glossary entries
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@bsmth @Rumyra @Josh-Cena