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 ESLint tutorial embed & links to Getting started
docs page
#7971
Conversation
@jamischarles, thanks for your PR! By analyzing the history of the files in this pull request, we identified @nzakas, @kaicataldo and @P3r to be potential reviewers. |
Thanks for the pull request, @jamischarles! I took a look to make sure it's ready for merging and found some changes are needed:
Can you please update the pull request to address these? (More information can be found in our pull request guide.) |
LGTM |
LGTM |
Thanks for making this video! I don't really have a strong opinion either way, but I think it would be slightly better if the tutorial video was below the "Installation and Usage" section. Personally, I would want to read the section before watching the video. |
@not-an-aardvark I think video should be either at the begging or the end of the article. I have no preference either way, but I think we should avoid putting it in the middle. Current placement seems fine to me. @jamischarles Builds are failing because there's a linting validation in the markdown file. You are missing a line-break around header. |
I recently published a Pluralsight course on ESLint: https://www.pluralsight.com/courses/eslint-better-code-quality. Adding a youtube embed and link to the getting-started page. Prior context here: eslint/archive-website#324
LGTM |
@ilyavolodin Fixed the lint issue (oh the irony...) @not-an-aardvark I lean more towards the top, because people then know what options they have and can decide which medium they want to use to continue, but happy to move it if you guys want. |
I'm also leaning more towards the top. People can skip the video and come back to it later, if they know that it's there. @not-an-aardvark If you are OK with video placement, I'll merge this in. |
🎉 Thanks folks! When should I expect this change to show up on eslint.org (so I can verify that everything looks good)? |
@jamischarles This should be available with next ESLint release. We are currently on hold waiting to do next patch release, due to some issues with our build server. Hopefully it will be resolved in the next few days. |
What is the purpose of this pull request? (put an "X" next to item)
[X] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:
What changes did you make? (Give an overview)
Prior context here:
eslint/archive-website#324
This PR adds a youtube embed of an ESLint Tutorial Video to the
Getting started
docs page.@ilyavolodin I don't have strong feelings about any of the wording or placement. We don't even have to include the
Pluralsight
verbiage.Is there anything you'd like reviewers to focus on?
Content and placement.
Special Notes & Testing steps
I added the embed and tested it in the
eslint.github.io
repo locally, and by publishing it as github pages. In both cases the youtube embed seemed to work fine. Screenshot: