Comments (7)
FYI
It's worth to use 'npm install doctoc && doctoc .' to automatically create
a good TOC in the github markdown files.
On Wed, Mar 11, 2015 at 5:18 PM, Gorka Lerchundi Osa <
[email protected]> wrote:
We need to create a good README to help people identifying:
- why this project exists
- what it includes
- how should be used
- make references to our 'recommended' base images.
- just-containers/base (ubuntu trusty)
- just-containers/base-slim (alpine)
—
Reply to this email directly or view it on GitHub
#12.
from s6-overlay.
thanks!
from s6-overlay.
+1, would really love to see an explanation of how these bits fit together, especially the env variables.
from s6-overlay.
closing this issue, we'll add documentation incrementally, I'll write something about envvars during this weekend.
from s6-overlay.
@pikeas @dreamcat4 some notes about how env variables work were added :-)
from s6-overlay.
Thanks Gorka @glerchundi. May I make some comments / suggestions about the docs?
- Rename 'FAQ' ---> Performance.
- Move 'Customizing s6 behaviour' closer to the top of page.
- Rename 'Customizing s6 behaviour' --> 'Config'
- Generate a TOC with the
doctoc
node.js helper program.
from s6-overlay.
@dreamcat4, I've updated the README with a TOC, generated by doctoc cleaned by me :-). Also, I renamed FAQ -> Performance. Regarding to customizing s6 behaviour, I made it consciously because I wanted to be there, at the bottom part of the README. I think a README is just as a starting point and default overlay behaviour is enough for most of the people!
again, thanks for your comments.
from s6-overlay.
Related Issues (20)
- systemd notify service conversion exmaple HOT 4
- s6-notifyoncheck: fatal: s6-supervise not running. HOT 3
- Installing S6 on official php-fpm container shows no log output from S6 HOT 5
- Issue with s6-overlay in Cattr project when deployed on Kubernetes HOT 6
- `UID not set` error HOT 10
- Question: pass args to the underlying service HOT 6
- s6-overlay v3 only sends SIGTERM to `/etc/services.d` after `S6_SERVICES_GRACETIME` HOT 8
- Setting S6_READ_ONLY_ROOT does not copy `/etc` to `/run/s6/etc` HOT 3
- Service is started, but reported as "normally down", seemingly by default HOT 11
- 3.1.6.1 hangs at the very end of shutdown for more than a minute HOT 3
- In some rare occasions s6-overlay hangs at shutdown for undefined amount of time HOT 4
- Using s6-overlay with ECS Exec HOT 8
- How to create something similar like cont-init if this one is deprecated ? HOT 3
- Best practice for redirecting output from app1 to app2 HOT 5
- Problem using S6_STAGE2_HOOK to run shell script HOT 2
- s6-linux-init: warning: parent wrote to fd 3! HOT 9
- How to read ENV variables from a file for the main process (defined in CMD) HOT 4
- Shutdown container during s6-rc startup leads to deadlock HOT 3
- finish script does not receive system.exit code but 0 HOT 33
- Cannot make Log to stdout work with s6-overlay 3.1.6.2 (no bug, just looking for some guidance/help). HOT 3
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 s6-overlay.