facebookexperimental / hermit

Hermit launches linux x86_64 programs in a special, hermetically isolated sandbox to control their execution. Hermit translates normal, nondeterministic behavior, into deterministic, repeatable behavior. This can be used for various applications, including replay-debugging, reproducible artifacts, chaos mode concurrency testing and bug analysis.
Other
1.17k stars 31 forks source link

User docs reference internal FB Workplace instance #15

Open knorrium opened 1 year ago

knorrium commented 1 year ago

The following links are inaccessible to external users, could the talks and CLI examples please be posted elsewhere?

https://github.com/facebookexperimental/hermit/blob/95b3ac7be2c464fc7be595c8548f4dd11167600b/docs/Users.md?plain=1#L30-L33

jasonwhite commented 1 year ago

Great suggestion. We'll try to publish those things soon. There shouldn't be any legal reasons not to.

rrnewton commented 1 year ago

Also, as part of porting more documentation to be external, we need to figure out some way to get this plantuml stuff to work, as well as generally fleshing out the bit of documentation that has currently been externalized under that docs/ directory.

For example, the Architecture.md file should render like this:

hermit system architecture

Update: Looks like there is some advice for combining plantuml and github markdown in this Gist.

sanmai-NL commented 1 year ago

Publishing an mdBook would allow for rich documentation with good UX.