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

feat: improvements on glossary articles #33413

Merged
merged 9 commits into from
May 6, 2024

Conversation

PassionPenguin
Copy link
Contributor

@PassionPenguin PassionPenguin commented May 4, 2024

Description

improvements includes:

  • normalize see also url name
  • add styles for the first occurence (the definition) of the glossary
  • remove crypto system glossary macro link, as it's not existed in glossary list

Motivation

inconsistent glossary definition stylings make it harder to understand (e.g. why some labled on MDN links, while some dont' have are also mdn docs?)

Additional details

Related issues and pull requests

@PassionPenguin PassionPenguin requested a review from a team as a code owner May 4, 2024 13:13
@PassionPenguin PassionPenguin requested review from pepelsbey and removed request for a team May 4, 2024 13:13
@github-actions github-actions bot added Content:Glossary Glossary entries size/m [PR only] 51-500 LoC changed labels May 4, 2024
Copy link
Contributor

github-actions bot commented May 4, 2024

Preview URLs (66 pages)
Flaws (3)

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

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

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

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/Decryption
Title: Decryption
Flaw count: 1

  • broken_links:
    • Can't resolve /en-US/docs/Encryption_and_Decryption
External URLs (12)

URL: /en-US/docs/Glossary/Apple_Safari
Title: Apple Safari


URL: /en-US/docs/Glossary/Conditional
Title: Conditional


URL: /en-US/docs/Glossary/Accessibility
Title: Accessibility


URL: /en-US/docs/Glossary/Computer_Programming
Title: Computer Programming


URL: /en-US/docs/Glossary/CORS-safelisted_request_header
Title: CORS-safelisted request header


URL: /en-US/docs/Glossary/Adobe_Flash
Title: Adobe Flash


URL: /en-US/docs/Glossary/Cross-site_scripting
Title: Cross-site scripting (XSS)


URL: /en-US/docs/Glossary/CRLF
Title: CRLF


URL: /en-US/docs/Glossary/Canvas
Title: Canvas

(comment last updated: 2024-05-06 17:55:55)

Copy link
Member

@estelle estelle left a comment

Choose a reason for hiding this comment

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

lots of comments, all of them minor.

thank you for doing all this work.

files/en-us/glossary/canvas/index.md Outdated Show resolved Hide resolved
files/en-us/glossary/canvas/index.md Outdated Show resolved Hide resolved
files/en-us/glossary/closure/index.md Outdated Show resolved Hide resolved
files/en-us/glossary/continuous_media/index.md Outdated Show resolved Hide resolved
files/en-us/glossary/decryption/index.md Outdated Show resolved Hide resolved
files/en-us/glossary/character/index.md Outdated Show resolved Hide resolved
files/en-us/glossary/canonical_order/index.md Outdated Show resolved Hide resolved
files/en-us/glossary/baseline/typography/index.md Outdated Show resolved Hide resolved
files/en-us/glossary/atag/index.md Outdated Show resolved Hide resolved
files/en-us/glossary/accessibility/index.md Outdated Show resolved Hide resolved
Copy link
Member

@estelle estelle left a comment

Choose a reason for hiding this comment

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

Thanks! 🎉

@estelle estelle merged commit 7a551aa into mdn:main May 6, 2024
8 checks passed
@PassionPenguin PassionPenguin deleted the glossary-improvements branch May 6, 2024 23:33
PassionPenguin added a commit to PassionPenguin/translated-content that referenced this pull request May 7, 2024
PassionPenguin added a commit to PassionPenguin/translated-content that referenced this pull request May 7, 2024
PassionPenguin added a commit to PassionPenguin/translated-content that referenced this pull request May 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:Glossary Glossary entries size/m [PR only] 51-500 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants