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

Add terminology/references/dictionary #1120

Open
hzoo opened this issue Jan 1, 2017 · 11 comments
Open

Add terminology/references/dictionary #1120

hzoo opened this issue Jan 1, 2017 · 11 comments

Comments

@hzoo
Copy link
Member

hzoo commented Jan 1, 2017

Add a page to explain Babel/js specific terms that users might not know at first

like: es6/es2015, TC39, plugin, preset, etc.

Not sure how we want to do this but at least we can come up with some terms, and then how to show it on the site and whether we should be linking to it in some way.

@brigand
Copy link
Contributor

brigand commented Jan 2, 2017

One option is to show the definition on sustained hover. It could use an <abbr> tag.

@nitin42
Copy link
Contributor

nitin42 commented Feb 28, 2017

I think these terms are described in brief here. or... not?

@aaronang
Copy link
Member

@nitin42 Yes you are right, but I think it might be useful to have one central place for common terminology. Easier to find and search 😄

@nitin42
Copy link
Contributor

nitin42 commented Mar 1, 2017

Ok ! I am working on this 😄

@nitin42
Copy link
Contributor

nitin42 commented Mar 1, 2017

Can we also include the different packages? Brief about each package. For eg - babel-cli

@existentialism
Copy link
Member

Maybe the first step is to compile a list of the terms that need defining?

Depending on the number of them, there may be better options than a dedicated page (as @brigand suggested <abbr />, or more custom tooltips, etc) as it wouldn't require a user to click back and forth.

@nitin42
Copy link
Contributor

nitin42 commented Mar 1, 2017

screen shot 2017-03-01 at 9 22 14 pm
Looks great though !

@existentialism
Copy link
Member

Yeah (though, I really need to get around to improving typography styles on the site)!

Two areas that are worth discussion, IMO:

Duplication of content

Let's take anywhere that references ES2015 as an example. Why wouldn't we just link to Learn ES2015 which contains the same text and way more vs. linking to the term on the Terminology page?

I definitely think we want to avoid using the terminology page as a crutch for good information architecture :)

Linking

It may be outside the initial scope, but I'd like to at least address easing the burden for content creators to remember linking to a term to the terminology page. It might be crude, but something as simple as scanning for and converting "TC39" -> <abbr title="TC39 is the committee that evolves JavaScript. Its members are companies (among others, all major browser vendors).">TC39</abbr> might go a long way towards achieving this without needing to remember to link?

@nitin42
Copy link
Contributor

nitin42 commented Mar 1, 2017

Gr8!

@nitin42
Copy link
Contributor

nitin42 commented Mar 1, 2017

So ? What can we do now ? I have a list of terms !

@stale stale bot added the stale label Jun 12, 2017
@stale
Copy link

stale bot commented Jun 12, 2017

This issue has been automatically marked as stale because it has not had recent activity 😴. It will be closed if no further activity occurs. Thank you for your contributions 👌!

@stale stale bot closed this as completed Jun 20, 2017
@hzoo hzoo reopened this Jun 20, 2017
@stale stale bot removed the stale label Jun 20, 2017
@hzoo hzoo mentioned this issue Apr 18, 2018
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants