Documentation structure about db1000n

[arriven]

Yeah, started with that opinion as well but seeing the amount of contributions changed my mind 😅

[Amet13]

@iamtodor @arriven I'll prepare a proof of concept of the structure of the new doc in 10-30 mins.
Let's discuss it after I finish

[arriven]

I think it's worth keeping the instruction for new users in Ukrainian, everything else can be English only. I'll merge PR from @Amet13 as is

[Amet13]

I think it could be forced by implementing CODEOWNERS functionality partially

[iamtodor]

@arriven @Amet13 I think we can close this issue

[arriven]

@iamtodor since you're probably the biggest contributor to the docs yet, could you take a look at this?

[iamtodor]

@arriven to be honest, I had literally the same assumption. The reason I didn't suggest it is I thought it would bring additional efforts

[iamtodor]

would you like to move vpn list to a separate page from readme? but still having a link from readme

[iamtodor]

@Amet13 sounds good to me!

[arriven]

VPN instructions can be a separate page, but probably also nice to include some options directly into the instructions for new users

[arriven]

@Amet13 agreed

[Amet13]

@arriven @iamtodor let's review this one: https://github.com/Arriven/db1000n/pull/128/files

[Amet13]

The idea is to keep the main readme pretty clean.
There is also a duplicate of it in Ukrainian.
Crosslinking between ua and en versions of README.

Tool-specific docs are in their directories (for example kubernetes/{manifests,helm-chart}, terraform/{aws,gcp,...}.
General documentation for advanced users and developers is in docs/

TODO:

• [done] still thinking about what to do with this doc: https://github.com/Amet13/db1000n-1/blob/n118/docs/gcp-installation-ua.md (it's pretty useless and wouldn't work, as far as I see)
• in main README we have direct links to binaries: https://github.com/Amet13/db1000n-1/tree/n118#for-dummies for every new release we should update them will think which links we can use for the latest version only (like here https://github.com/Amet13/db1000n-1/tree/n118#binary-file)
• maybe to add some badges? low prio

[iamtodor]

@Amet13 @arriven I am not sure whether we need to keep Ukrainian instruction. I think all of us (I mean the IT community) know English at, at least pre-intermediate level. But keeping 2 separate langs would bring us double efforts

[Amet13]

@iamtodor agree, just moved it to not to break current docs.
But if we write README just once, maybe it won't be a really big effort to keep both versions

[iamtodor]

@Amet13 @Amet13 I would suggest having somewhere in docs (maybe for developers or it's up to your where to leave it) the following agreement:

I think we should also enforce the rule where at least two other people should validate new guides/big changes to guides and different scripts/terraform/k8s_manifests/docker-compose files which we don't have CI jobs for yet. I'll create a separate label for that

[iamtodor]

CODEOWNERS functionality was implemented in #187

[m-v-kalashnikov]

@arriven @Amet13 I can move all docs to MKdocs which would be hosted on GitHub pages