Some gotchas not documented

[camerow]

This is a very cool project, however there are many gotchas that could be better documented, and I need a little help navigating.

1. Posting/fetching data is done to a remote ref by default in the index.html provided in the repo -- threw me for a loop at first. It's documented but not in the quickstart, which would be helpful.
2. Provided index.html also uses a localStorage.getItem('GitHubToken') -- what is the intention here?
3. There is some admin functionality, but it's undocumented. Trying to dig into the code for an explanation but I'm coming up short. Could someone explain that to me as well?
4. Any recommendations on how I should host this for my team?

Thanks for all the hardwork, this is an awesome open source project. I'd be happy to make some PRs - just point me in the right direction! =)

• Will

[tristen]

@camerow thanks for the feedback! I would very much welcome pull requests!! especially clarifying details not outlined in the documentation.

Posting/fetching data is done to a remote ref by default in the index.html provided in the repo -- threw me for a loop at first. It's documented but not in the quickstart, which would be helpful.

Would <3 a pr

Provided index.html also uses a localStorage.getItem('GitHubToken') -- what is the intention here?

It's value is provided to the GitHubToken option in order to make read/write requests. Using localStorage was a way for me to provide a value stored on my browser without revealing what my accessToken is publicly.

There is some admin functionality, but it's undocumented. Trying to dig into the code for an explanation but I'm coming up short. Could someone explain that to me as well?

I did a terrible job documenting this. If a users object (contained in the team file) contains admin: true they have access to form fields that have admin: true set. An example of a form field only someone with admin privileges can see is here: https://github.com/mapbox/team-directory/blob/ad482d61a4e61454af8fb6fdbaa4cf9d61b50671/data/form.json#L37-L46

Any recommendations on how I should host this for my team?

We use team-directory by hosting a site that uses it on s3. A good way to get started might be to:

• Create a private repo in your organization account and grant collab privileges to team members.
• Use Heroku to host the site and replace this info with the private repo you created.