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

refactor: separates firebase setup guide #23

Open achrinza opened 4 years ago

achrinza commented 4 years ago

Quoting from https://github.com/opentrace-community/opentrace-cloud-functions/pull/1#issuecomment-613971180:

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:

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.

Signed-off-by: Rifa Achrinza 25147899+achrinza@users.noreply.github.com