bee-docs icon indicating copy to clipboard operation
bee-docs copied to clipboard

Add Gateway Docs

Open significance opened this issue 2 years ago • 3 comments

There's lot of info here so I will probably break it down during the docs review, which I will commence as soon as this is merged. I have included, broadly speaking:

  • current state of thinking on how and why to run a gateway
  • detailed instructions on how to run your own gateway
  • an example with instructions using docker compose that runs all three elements and uses the Cloudflare API to automatically provision wildcard TLS certs for free

Would appreciate feedback, I will go through the text once more and also run through the instructions one last time to make sure they work before I merge it.

significance avatar Jun 01 '22 08:06 significance

Nice work, I like it!

I haven't done a full review yet, because it is quite big, but from an overview I would like to point out two things:

  • I would avoid mentioning what is planned in the future or what is investigated. I would prefer if the documentation would be about documenting existing things.
  • I would avoid mentioning web2 and web3, because they are more marketing terms than technical, therefore their meaning can be highly subjective based on the previous experience of the reader.

agazso avatar Jun 02 '22 08:06 agazso

thanks for your input pushed a much revised version which i think should address most of your feedback

significance avatar Jun 02 '22 11:06 significance

@agazso @vojtechsimetka @zelig have completed an in-depth review of the whole thing. much better now.

would welcome your feedbacks

significance avatar Jun 07 '22 09:06 significance