On 03/09/15 13:05, Neeraj Sharma wrote:
Although the information is available in one for or another the wiki can be
greatly improved to make first-time-users experience much better. Having
said that here are some of my thoughts on the subject to make wiki more
effective and a one-stop-shop documentation medium for the rumpkernel
project. Needless to say nothing beats rumpkernel iirc :)
Disclaimer: I spent not more than 30min on this.
I've mostly written a rump kernel FAQ, with most of the questions you
posed below (plus answers to them). My questions don't come in explicit
categories, though. Might be worthwhile to create a hierarchy/taxonomy
there.
I did spend more than 30min on the questions, but then again it was a
sunny and warm day on Monday and it was nice to sit by the river, and
that may have influenced the time spent ;)
I was planning to publish the FAQ last night, but all my extra time was
eaten by irc. I'll polish and publish it now('ish), and then we can
figure out the next steps.
There is already a page in the wiki for "2".
1. Introduction
1.1. Core Components
1.1.1. rumpkernels
1.1.2. rumprun
1.1.3. So, what was the difference again?
1.2. Other Components
1.2.x. tools/stuff/other components
1.3. How is it Licensed and why should you care?
1.5. Who is behind it?
1.4. A little bit of history maybe?
1.5. Is commercial training and support available?
2. How does it compare?
2.1. How is it different from X?
2.2. How is it different from Y?
...
3. How does it stand out and why should I care?
3.1. What differentiates it?
3.2. Why should you care?
3.3. Who is using it in production or any noticeable project?
3.4. Some usecases?
4. What resources are available to understand the project?
4.1. Where is the software?
4.2. Where are all the docs?
4.3. Any videos or talks?
5. How can I collaborate, contribute and be updated with the latest and
greatest?
5.1. Official channel to be social and seek help?
5.2. How should I be sending patches and stuff?
6. What has been achieved so far (current status)?
6.1. Current Status
6.2. You can help in the following ways
7. What is the vision / roadmap for the near term (or maybe even a longer
one as well)?
8. Installation
8.1. Installation for X
8.1.1. Pre-requisites
8.1.2. Build
8.1.3. Install
...
9. Use
9.1. Build your first unikernel
9.1.1. Build first unikernel in language-X (e.g. C, Python, and Erlang)
10. Run / Deploy
10.1. Run on qemu/kvm
10.2. Run on Xen
10.3. Run on Baremetal
...
11. Debugging
11.1. What are my tools?
11.2. Is there any difference in build commands for getting debug info, etc?
11.3. Miscellaneous topics and external references to connect the dots
12. Known issues and shortcomings
13. Project Ideas
14. Tuning
14.1. Tuning for size
14.2. Tuning for speed
-Neeraj
