Comments (18)
Yeah, started with that opinion as well but seeing the amount of contributions changed my mind 😅
from db1000n.
@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
from db1000n.
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
from db1000n.
I think it could be forced by implementing CODEOWNERS functionality partially
from db1000n.
@arriven @Amet13 I think we can close this issue
from db1000n.
@iamtodor since you're probably the biggest contributor to the docs yet, could you take a look at this?
from db1000n.
@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
from db1000n.
would you like to move vpn list to a separate page from readme? but still having a link from readme
from db1000n.
@Amet13 sounds good to me!
from db1000n.
VPN instructions can be a separate page, but probably also nice to include some options directly into the instructions for new users
from db1000n.
@Amet13 agreed
from db1000n.
@arriven @iamtodor let's review this one: https://github.com/Arriven/db1000n/pull/128/files
from db1000n.
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
from db1000n.
@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
from db1000n.
@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
from db1000n.
@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
from db1000n.
CODEOWNERS functionality was implemented in #187
from db1000n.
@arriven @Amet13 I can move all docs to MKdocs which would be hosted on GitHub pages
from db1000n.
Related Issues (20)
- SIGSEGV incoming HOT 3
- Things to optimize - performance HOT 10
- Reference to db1000nX100 project HOT 1
- Error when pulling docker image HOT 1
- vpn load balancing script
- Simplify logs HOT 8
- Can you compiling file or opkg OpenWRT for MIPS, MIPSBE, MMIPS etc? ;) HOT 14
- Trojan HOT 3
- Scale up db1000n automatically in order to utilize all available system resources HOT 2
- Disk usage is increasing with Docker containers HOT 5
- Can you add limit download/upload speed? HOT 3
- Add more stats (cpu/memory load, amount of open connections, etc.)
- oom killed HOT 23
- prometheus.go:298: Can't push metrics to gateway HOT 2
- ERROR: HostClient can't follow redirects to a different protocol, please use Client instead HOT 1
- Config path is not available anymore for Digital Ocean deployment HOT 1
- Add new sites? HOT 2
- Non-cumulative stats HOT 1
- Build unsuccesful by go install HOT 4
- . HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from db1000n.