content icon indicating copy to clipboard operation
content copied to clipboard

Base64: Glossary entry is more like a tutorial

Open estelle opened this issue 3 years ago • 2 comments

MDN URL

https://developer.mozilla.org/en-US/docs/Glossary/Base64

What specific section or headline is this issue about?

The "Unicode Problem"

What information was incorrect, unhelpful, or incomplete?

If information is important, it shouldn't be hidden in a glossary entry. if it isn't important, it should be removed.

What did you expect to see?

A brief glossary term definition

Do you have any supporting links, references, or citations?

No response

Do you have anything more you want to share?

No response

MDN metadata

Page report details
  • Folder: en-us/glossary/base64
  • MDN URL: https://developer.mozilla.org/en-US/docs/Glossary/Base64
  • GitHub URL: https://github.com/mdn/content/blob/main/files/en-us/glossary/base64/index.md
  • Last commit: https://github.com/mdn/content/commit/8db6f634a8e916a6e11c7eb00f15e0f85129ee6a
  • Document last modified: 2022-10-03T07:38:33.000Z

estelle avatar Oct 27 '22 22:10 estelle

Yeah that “The "Unicode Problem"” section rightly should not be buried in a glossary entry. But it was added a very long time ago, and is now linked to from Stack Overflow and GitHub issue trackers and a number of other external sites —

  • https://stackoverflow.com/questions/30106476/using-javascripts-atob-to-decode-base64-doesnt-properly-decode-utf-8-strings
  • https://stackoverflow.com/questions/67401649/how-to-convert-blob-to-base64
  • https://github.com/AzureAD/microsoft-authentication-library-for-js/issues/246
  • https://davidmac.pro/posts/2021-09-15-base64-tools/
  • https://bitcoden.com/answers/php-base64-encoded-response-does-not-get-decoded-correctly-in-javascript

…so, if we move it, we should do it in a way that doesn’t break all those links

sideshowbarker avatar Oct 28 '22 04:10 sideshowbarker

FWIW I tried to refactor the code examples a while ago, but it was basically impenetrable for me😅

Josh-Cena avatar Oct 28 '22 04:10 Josh-Cena

What would be an appropriate place to put an article about this unicode issue? Then we could create an article with that title so everyone could find it via search engines, and not only thru StackOverflow links

estelle avatar Jan 10 '23 23:01 estelle

What would be an appropriate place to put an article about this unicode issue?

Maybe as a new subsection of the https://developer.mozilla.org/en-US/docs/Web/API/btoa article

sideshowbarker avatar Jan 11 '23 04:01 sideshowbarker

Maybe as a new subsection of the https://developer.mozilla.org/en-US/docs/Web/API/btoa article

Good suggestion, but that seems equally obscure and even less findable - people would have to know btoa() to find it. Base64, even if it's in glossary, is likely what people will look for. Let's leave as is.

estelle avatar Apr 21 '23 20:04 estelle