Skip to content

Instantly share code, notes, and snippets.

@toolness
Last active August 29, 2015 14:23
Show Gist options
  • Save toolness/823c8d163181ce02b637 to your computer and use it in GitHub Desktop.
Save toolness/823c8d163181ce02b637 to your computer and use it in GitHub Desktop.
Notes on Webmaker App development setup

Here are some notes and suggestions regarding the setup instructions for the webmaker-android project, which I followed on June 29, 2015.

I can either file these suggestions as issues, or issue PRs for them directly.

  • The "Android" section of README.md says:

    If you make a change regarding activities within this native Android wrapper, you will need to update the res/xml/app_tracker.xml file to create a display name for that new activity, in Google Analytics.

    I'm not sure what "activities" means in this context. Also, this seems to be something that belongs in the "Adding New Pages or Components" or the "Google Analytics Event Firing" section, or in some other section entirely, rather than at the beginning of the Android setup instructions.

  • The instructions to run npm start should also be mentioned under the "Android" section, perhaps listed as an alternative to npm run build, since it's required to continuously build the Web assets. It should also be mentioned that devs need to rebuild the Android project after they've edited any Web assets.

  • The file _docs/get_started/README.md seems to duplicate a lot of the information contained in the root README.md. I think we might want to simply get rid of it.

  • The file _docs/android.md isn't linked-to from the root README.md. However, rather than linking to it, we might just want to get rid of the file, and mention Chrome Remote Debugging in README.md--since README.md already contains much of the information in android.md in a more compact form (as it links out to more well-maintained external documentation). If we do this, we can get rid of the _docs directory entirely.

@toolness
Copy link
Author

These points were subsequently addressed in the following issues/PRs:

mozilla/webmaker-android#2363

mozilla/webmaker-android#2364

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment