Comments (4)
I'm pretty bad at docs too 😅 But the list above is a great start!
My general rule of thumb is simple:
If I can't figure out and install something by reading it's README within ~5m you've lost me :D
from miasma.
Actually I think this has less to do with any "Cloud" provider and more to do with just general instructions.
For example, I'd like to run this up in my on-prem private cloud if you will 😅 -- I have a small 22 RU Rack cabinet with 3x 1RU Hypervisor nodes running Proxmox VE.
If we can keep your project miasma "cloud agnostic" it'll be generally useful in more places (not just cloud) 👌
from miasma.
Most of that already exists, I just need to add more docs around the things listed in the issue. Though you're correct, it's less cloud docs and more generic docs.
Let me ask you this. You want to run Miasma on your local network, when you go to the documentation, what do you want to know and in what order?
For example, I had the same use case as you, running apps on my local network, I wrote the docs in order of what I would have wanted to know:
- Does this do what I need it to do?
- How do I install it?
- How do I add nodes?
- How do I create apps?
- What about routing and DNS for my local network?
What you want to know is probable different than myself, and I'm probably missing steps since I wrote everything myself and don't really need the docs.
from miasma.
I'm very bad at writing in general, so that usually doesn't translate well to large documentation websites. So if you have any recommendations on structure or content, LMK.
from miasma.
Related Issues (20)
- `2022`: GraphQL Refactor
- `2022`: CLI timeout HOT 1
- TLS/SSL Support HOT 16
- Simple Authentication
- Support Node Labels HOT 1
- Use dataloaders for commonly accessed data
- Secure Traefik Dashboard
- Horizontal Scaling
- Autoupdating Apps HOT 5
- Registry Plugin HOT 2
- Routes not set immediately HOT 1
- Release Process for CLI HOT 1
- Don't restart apps that are stopped after making a change
- App shows up on multiple nodes
- `setAppEnv` mutation doesn't restart the app
- Installation fails on Ubuntu 20.04 HOT 8
- Update services instead of starting/stopping them
- CLI App Groups are incorrect
- Service upgrade webhook
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 miasma.