search

opentrace-community / opentrace-cloud-functions

OpenTrace Cloud Functions. Reference implementation of the BlueTrace protocol.
https://bluetrace.io
GNU General Public License v3.0
273 stars 121 forks source link

Update README #1

Closed samtstern closed 4 years ago

samtstern commented 4 years ago

This README gives more in-depth instructions on how to automate all the deployment steps here for Google Cloud and Firebase. Hopefully it will make it a little easier for someone to get started!

samtstern commented 4 years ago

Sorry I did not mean to open this yet!

achrinza commented 4 years ago

Seems like this would make the README rather long-winded. Maybe we should shift the setup guides into their own page?

This would be my suggestion:

|
L README.md
L docs
    L setup-with-gcp.md

Within the README, we could have the following to direct users to the respective docs:

## Setup

Setup guides are available for these platforms:
- [Google Cloud Platform / Firebase](./docs/setup-with-gcp.md)

This would help achieve 2 things:

  1. Keep the README short and sweet A README is meant for users to quickly glance at what the repo is about, and provide links to resources for further reading,

  2. Keep the setup guides compartmentalized We want to make the docs as easy to read as possible for the users. By splitting the guides according to their funtion, we can reduce the overall size of the docs and make it less daunting for new users to understand.

samtstern commented 4 years ago

@achrinza keeping the README short seems reasonable! I am happy to move the setup guide to a docs subfolder.

Also since I am new here: are you on the project team or just passing by for a review?

achrinza commented 4 years ago

@samtstern I’m watching the repo and passing by for a review, though I’m not on the project team.