Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Make documentation clearer #20

Open
moka-co opened this issue May 17, 2023 · 0 comments
Open

Make documentation clearer #20

moka-co opened this issue May 17, 2023 · 0 comments
Labels
backend Work concerning the backend of Scambi’s infrastructure documentation Improvements or additions to documentation enhancement New feature or request

Comments

@moka-co
Copy link
Contributor

moka-co commented May 17, 2023

  • It would be ideal to include an architectural diagram that showcases each VPS, along with their respective roles and the services they host. Currently, it is painful and a time-consuming process to repeatedly refer to the entire documentation to determine the location of i.e. Baserow or try to guess the hosting location of a service based solely on the hostname.
  • Providing explanations for why we do thing X instead of Y. In my opinion this makes the documentation clearer and it's easier for new people and not experts administrators to understand the infrastructure. This could be easily written in another directory without touching the current documentation, kinda of like as an integration.
  • Basic Accounting, like which VPS do we pay, which one we don't

Any opinions, objections, suggestions are accepted

@moka-co moka-co added documentation Improvements or additions to documentation enhancement New feature or request backend Work concerning the backend of Scambi’s infrastructure labels May 17, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend Work concerning the backend of Scambi’s infrastructure documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant