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

Fix the language table in the docs #3493

Closed
wants to merge 2 commits into from
Closed

Fix the language table in the docs #3493

wants to merge 2 commits into from

Conversation

brandonocasey
Copy link
Contributor

Description

Noticed that the language table on http://docs.videojs.com/docs/guides/languages.html is not correctly formatted. Looked at the markdown file for it and saw some malformed HTML. Fixed it

Requirements Checklist

  • Feature implemented / Bug fixed
  • Reviewed by Two Core Contributors

@mister-ben
Copy link
Contributor

Does this doc need to list language codes? Something like this from the explanation of Navigator.language on MDN might suffice:

A string representing the language version as defined in BCP 47. Examples of valid language codes include "en", "en-US", "fr", "es-ES", etc.

@misteroneill
Copy link
Member

I'm all for leaving the table out - especially when there's a link directly to an always-updated list of files/languages. This seems like wasteful documentation.

@brandonocasey
Copy link
Contributor Author

yeah that works too, I can just change it to a link

@gkatsev
Copy link
Member

gkatsev commented Aug 4, 2016

I think the original idea was to have the list of names for the json files in an easily accessible place.

@misteroneill
Copy link
Member

The problem I see there is that you then have to remember to update this document anytime a new file is added/removed. Not that it's a common occurrence, but...

@gkatsev
Copy link
Member

gkatsev commented Aug 4, 2016

this list has all* the languages, not just the ones currently available in videojs.
Also, I wasn't necessarily saying we need to keep it, was just trying to give background on why it's there. If such a list is available in a more official place (specifically the two-letter language codes) we could just link it.

*not actually all, but a large selection of the most commonly used languages

@brandonocasey
Copy link
Contributor Author

brandonocasey commented Aug 4, 2016

@misteroneill
Copy link
Member

Oh, I see, then ignore me. :)

@brandonocasey
Copy link
Contributor Author

@gkatsev @mister-ben @misteroneill So the consensus here is to change the table into a link right? How about this?

link to an external website that contains all possible languages
@misteroneill
Copy link
Member

LGTM

@misteroneill misteroneill added the needs: LGTM Needs one or more additional approvals label Aug 5, 2016
@gkatsev
Copy link
Member

gkatsev commented Aug 8, 2016

LGTM

@gkatsev gkatsev added confirmed minor This PR can be added to a minor release. It should not be added to a patch release. and removed needs: LGTM Needs one or more additional approvals labels Aug 8, 2016
@gkatsev gkatsev modified the milestone: 3.12 build-improvements Aug 11, 2016
@gkatsev gkatsev closed this in 1bb40b8 Aug 11, 2016
@brandonocasey brandonocasey deleted the fix/lang-table branch August 24, 2016 18:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
confirmed minor This PR can be added to a minor release. It should not be added to a patch release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants