From 698438863ced48fd04a195e35f3b1a47d7cbbfad Mon Sep 17 00:00:00 2001 From: Peter Hedenskog Date: Fri, 10 Nov 2017 14:19:53 +0100 Subject: [PATCH] Introduction to sitespeed.io (#1791) --- HELP.md | 23 ------- docs/_includes/footer.html | 2 +- docs/_includes/index/box4.md | 2 + docs/_includes/index/install.md | 2 +- .../2017-03-01-that-timeline-from-chrome.md | 4 +- .../2017-04-03-releasing-with-confidence.md | 2 +- docs/_posts/2017-04-24-sitespeed.io-5.0.md | 4 +- docs/aboutus/index.md | 4 +- docs/documentation/browsertime/index.md | 2 +- .../index.md | 0 .../sitespeed.io/getting-started/index.md | 38 ----------- docs/documentation/sitespeed.io/index.md | 3 +- .../sitespeed.io/installation/index.md | 2 +- .../sitespeed.io/introduction/index.md | 60 ++++++++++++++++++ .../sitespeed.io/use-cases/index.md | 63 ------------------- docs/important/index.md | 63 +++++++++++++++++++ docs/version/pagexray.txt | 2 +- 17 files changed, 138 insertions(+), 138 deletions(-) delete mode 100644 HELP.md rename docs/documentation/browsertime/{getting-started => introduction}/index.md (100%) delete mode 100644 docs/documentation/sitespeed.io/getting-started/index.md create mode 100644 docs/documentation/sitespeed.io/introduction/index.md delete mode 100644 docs/documentation/sitespeed.io/use-cases/index.md create mode 100644 docs/important/index.md diff --git a/HELP.md b/HELP.md deleted file mode 100644 index 4758ac3e0..000000000 --- a/HELP.md +++ /dev/null @@ -1,23 +0,0 @@ -# Help -We want to make sitespeed.io the best web performance tool in the world and we hope you can to help us! - -## Developers -We love to have more people involved in making sitespeed.io better. We are constantly working on adding more documentation and trying to write more information in the issues so its easier to help out. If there's an [issue](https://github.com/sitespeedio/sitespeed.io/issues) that you want to take on, ping the the issue and we can help you get started. You can also [join our Slack channel](https://sitespeedio.herokuapp.com/) if you need help! - -## Designers -As a designer there's a lot you can do: You can make the HTML result pages look better. Maybe we should restructure the metrics? Maybe we should have graphs? Or could the header/footer look better? You could also have look at [https://www.sitespeed.io](https://www.sitespeed.io) where we have all the documentation. Make it look phab. You can pretty much help us with everything, no one in the core team got design skills :) - -## Documentation -Documentation is fun and it is the core of making sitespeed.io easy to use. We got a [special documentation tag for issues](https://github.com/sitespeedio/sitespeed.io/issues?q=is%3Aissue+is%3Aopen+label%3Adocumentation) that you can use to find where we know we lack documentation. Fixing spelling mistakes is great. Or rewrite parts that you think is too complicated. You can find what you need to send a PR to the documentation [here](https://github.com/sitespeedio/sitespeed.io/tree/master/docs). - -## Tests -We lack unit tests. You can read about [our testing pipeline](https://www.sitespeed.io/releasing-with-confidence/) that works good for us but more unit tests are always good. A good start is adding support for the code in the [support library](https://github.com/sitespeedio/sitespeed.io/tree/master/lib/support). - - -## Companies -Do you use sitespeed.io in your everyday work? Then we have a perfect proposition for you! Have a hack day with focus on sitespeed.io for your team and contribute back. Pick one the things in the **Help wanted** section. Or maybe there's a function you think is missing? Create it. Contribute back. - -# Help wanted -You can help us: -* [Add connectivity support](https://github.com/sitespeedio/browsertime/issues/313) for Android phones. -* Help us make the documentation even better. We love your feedback and help [https://github.com/sitespeedio/sitespeed.io/tree/master/docs](https://github.com/sitespeedio/sitespeed.io/tree/master/docs). diff --git a/docs/_includes/footer.html b/docs/_includes/footer.html index e4d581bf2..04ffec91c 100644 --- a/docs/_includes/footer.html +++ b/docs/_includes/footer.html @@ -33,7 +33,7 @@

sitespeed.io