Skip to content
This repository has been archived by the owner on Jan 11, 2023. It is now read-only.

Re-write getting started docs #1334

Merged

Conversation

jasonLaster
Copy link
Contributor

@jasonLaster jasonLaster commented Nov 28, 2016

Associated Issue: #1233

Overview

We've gotten lots of feedback on our getting started docs. Here are some takeaways

  • beginners need a simpler focused getting started guide
  • beginners need more help with certain gotchas along the process
  • beginners could benefit from screenshots / gifs
  • beginners can benefit by having common questions answered (i.e. why yarn)
  • beginners don't always feel ready to jump into an up for grab. Having a good first activity is helpful
  • advanced users will figure it out. They're a minority compared to the many beginners who are good devs, but have questions
  • the docs are currently spread out and have too much information that comes before the setup instructions. they can always learn the local dev stuff after they're setup.

Summary of Changes

  1. add getting started doc
  2. add first activity doc
  3. consolidate contributing doc
  4. consolidate readme

Test Plan

  • we should double check content to make sure it makes sense
  • we should click all the links

CC @Garbee, @clarkbw, @viswanathamsantosh


**Share what you know** Give a talk in school, work, or a local meetup. I'm willing to bet your audience will not know the debugger is a web app!

- here are @amitzur's [slides](https://docs.google.com/presentation/d/1jdnvL-BwwxEuFbb9tiRxcT6UT-Ua0jGhy9FKBT4b43E/edit) from his [talk](https://twitter.com/amitzur/status/790153843946426369)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@clarkbw i think your slides could be good here too


```bash
yarn run chrome
```
Copy link
Contributor Author

Choose a reason for hiding this comment

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

🌟 @Garbee I think you'll like this!

* [linux](https://github.com/devtools-html/debugger.html/issues/1082)


```
Copy link
Contributor Author

Choose a reason for hiding this comment

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

ughh, meant to have some context here. not sure if we need the same linux details

Copy link
Contributor

@clarkbw clarkbw left a comment

Choose a reason for hiding this comment

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

Overall looks like good changes. 👍

@@ -1,6 +1,6 @@
# debugger.html
# Debugger.html
Copy link
Contributor

Choose a reason for hiding this comment

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

Why the caps? We've always gone lowercase.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

haha - yeah, wanted to have a conversation about and hear why. sorry forgot to comment

@@ -0,0 +1,22 @@
const spawn = require('child_process').spawn;

const chromeBinary = "/Applications/Google\ Chrome.app/Contents/MacOS/Google\ Chrome"
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe a note or file a followup issue to get Windows working.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

good point


```bash
npm i -g [email protected]
g clone [email protected]:devtools-html/debugger.html.git
Copy link
Contributor

Choose a reason for hiding this comment

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

git clone


#### Starting Firefox

If you're looking for an alternative to `yarn run firefox`, you have two options: cli, gcli.
Copy link
Contributor

Choose a reason for hiding this comment

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

I think you might have skipped the GCLI option below.

@@ -35,126 +25,19 @@ We respect your time and want to help you make the most of it as you learn more
* [Configuration](#configuration)
* [Create a local config file](#create-a-local-config-file)
* [Issues and Pull Request labels](#issues-and-pull-requests)
[Project Overview](#sd)
[What should I know before I get started?](#what-should-i-know-before-i-get-started)
Copy link
Contributor Author

Choose a reason for hiding this comment

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

not necessary

@jasonLaster jasonLaster force-pushed the docs-getting-started branch 11 times, most recently from 91d6c07 to 178a666 Compare November 29, 2016 15:07
1. add getting started
2. add first activity
3. consolidate contributing
4. consolidate readme
@jasonLaster jasonLaster merged commit 71c9e99 into firefox-devtools:master Nov 29, 2016
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants