Comments (1)
I've been looking at other documentation guides, and they choose to handle this by making their documentation oriented towards the user, such that their quick start guides are all about how to install and use the client. Then they have a separate section in their docs that discusses how to deploy the server-side infrastructure and how to maintain it.
e.g.
https://kubernetes.io/docs/home/
https://www.nomadproject.io/docs
https://docs.docker.com/
This seems like a good approach for Hippo as well. I will change the introductory pages to reference using the Hippo CLI, moving the "set up hippo server" guides elsewhere.
from hippo-docs.
Related Issues (18)
- image URLs broken when developing locally HOT 1
- Remove two-part links HOT 2
- Style guide for referencing binaries, code artifacts, and env vars HOT 1
- Version numbers: Can we use a shortcode or something for that? HOT 2
- remove admin/password credentials from docs HOT 1
- change links to hippofactory.dev/hippofactory.io
- rearrange the "boot hippo" and "install CLI tools" docs
- Docs for windows HOT 1
- Improve subtlety in install documentation.
- Quickstart: no choice allowed
- Need some way to differentiate between top-level headings and sub-topics
- Add information on outbound HTTP
- Hippo directory might have changed, but instructions point to old location
- make it easier to copy/paste commands
- Update docs for running locally HOT 2
- create glossary for hippo terminology
- nomad docs
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 hippo-docs.