Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

User docs reference internal FB Workplace instance #15

Open
knorrium opened this issue Nov 22, 2022 · 3 comments
Open

User docs reference internal FB Workplace instance #15

knorrium opened this issue Nov 22, 2022 · 3 comments

Comments

@knorrium
Copy link

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

hermit/docs/Users.md

Lines 30 to 33 in 95b3ac7

* Find hermit [CLI examples here](https://fb.workplace.com/notes/hermetic-infra-fyi/hermit-tech-preview-a-linux-reproducibility-tool/244656753248444/)
* See demos in [this tech talk](https://fb.workplace.com/groups/591973351138875/permalink/1132872253715646/).
* [This talk](https://fb.workplace.com/groups/591973351138875/posts/1533285603674307) shows concurrency testing with hermit "chaos" mode.
* [This talk](https://fb.workplace.com/groups/hermit.fyi/post

@jasonwhite
Copy link
Contributor

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

@rrnewton
Copy link
Contributor

rrnewton commented Nov 29, 2022

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
Copy link

sanmai-NL commented Feb 20, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants