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

Quickstart #333

Merged
merged 6 commits into from
Jul 1, 2020
Merged

Quickstart #333

merged 6 commits into from
Jul 1, 2020

Conversation

zkoppert
Copy link
Contributor

@zkoppert zkoppert commented Jun 30, 2020

  • Format how to into numbered steps
  • Add gif to show people the way

resolves #218

@zkoppert zkoppert marked this pull request as ready for review June 30, 2020 23:46
@zkoppert zkoppert mentioned this pull request Jun 30, 2020
Copy link
Contributor

@IAmHughes IAmHughes left a comment

Choose a reason for hiding this comment

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

@zkoppert thanks so much for doing this and adding the gif!

I think something happened with the formatting though, as the gif is reallllly small and off to the side. I like the right align idea but on my monitor it's so small.

image

README.md Outdated Show resolved Hide resolved
@zkoppert zkoppert added the documentation Improvements or additions to documentation label Jun 30, 2020
Co-authored-by: Thomas Hughes <iamhughes@github.com>
@zkoppert
Copy link
Contributor Author

Thanks @IAmHughes. That size is much, much better!

Copy link
Contributor

@IAmHughes IAmHughes left a comment

Choose a reason for hiding this comment

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

Looks great to me now! 🎉

image

@zkoppert zkoppert merged commit 4513b63 into master Jul 1, 2020
@zkoppert zkoppert deleted the quickstart branch July 1, 2020 00:07
@@ -60,10 +59,15 @@ Developers on **GitHub** can call the **GitHub Action** to lint their code base
| **YAML** | [YamlLint](https://github.com/adrienverge/yamllint) |

## How to use
<img height="512" src="https://github.com/github/super-linter/blob/quickstart/docs/how-to.gif?raw=true" alt="How to gif">
Copy link
Contributor

Choose a reason for hiding this comment

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

The URL for this is wrong. And this is a 2300px x 1600px 17Mb GIF. Do we really need to dump such a HUUUUUGE file on everyone visiting the home page of this repo?

Copy link
Contributor

Choose a reason for hiding this comment

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

Resolving as #337 was opened to discuss and is more visible than a merged PR, thanks for chiming in @bazzadp

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Too hard to install
3 participants