Hi All,
The meeting notes are as follows. Please feel free to correct anything.
Yann - Collect ideas from people to improve things for newconmers
Bertrand :- Is the wiki OK/not OK ? It is page to document things for
new comers. However, it is not updated regularly. Also limited people
can modify wiki. The wiki is not documented enough.
Anthony - People can ask on IRC
XXX - Different instructions on Wiki on how to get write access for Wiki.
Yann - Is the wiki the best place to keep the information ?
Bertrand - There is a doc inside git which needs to be in sync with
code. The other doc is about how to set up Xen. We lack documentation
for this. If you compare it to other distros. We need more people to
write documentation. The current information is stale. How can have a
better visibility for docs on google ?
XXX - What google looks for keywords. It is done by SEO.
Bertrand - In wiki, you can add flags to add subjects. One might be able
to extract documentation from Xen codebase.
Yann - Should we have captcha for Wiki to avoid spamming by bots ?
Bertrand - Even with captcha, Bots can generate spam information.
Yann - This means we should move doc to git repository.
Bertrand - Documentation on command line infiormation is there in Xen.
But we lack information about Xen (how to set up)
Yann - Doc should explain the evolution of code. We need documentation
for users. Which version of Xen supports what features ?
Ayan - Release notes should document this
Yann/Bert/Anthony - There is not sufficient documentation available.
XXX - Wiki should also be used for collaboration for on going development.
XXX - Otherwise, we need to go through the mailing list.
Bertrand - We need to organise wiki in a better way.
Yann - The wiki for documentation needs to have correct info. So it
should go through a review.
XXX - Where can I find information related to virtio (a specific feature) ?
Bertrand - Issue tracker (Gitlab epics) can provide the answer.
Edwin - How does a new user create issue vs protect gitlab epics from
spamming . This is account restricted.
XXX - There are multiple repositories. (Gitlab. GitHub, etc). How do we
know where the main repo lies ?
Bertrand - There are multiple downstream forks of Xen. Google may throw
up any any
Edwin - There should be information in code where canonical repo is.
XXX - Move wiki to GitHub or gitlab.
Yann - Gitlab protects against spams. So moving wiki to Github makes
sense. Once a page is imported in GitHub, then the other wiki pages can
be redirected.
XXX - Wiki cannot be modified by non member of project.
Bertrand - I doubt there are lot of people who want to contribute to wiki.
XXX - Can we somehow track the good ideas discussed here ? There should
be a difference between technical doc (on GitHub) or non technical doc
for users (on Wiki). This can be discussed on community call.
Bertrand - We need links in wiki to point to autogenerated documentation.
Olivier - We could get historical information from the proposed new
wiki. I could bootstrap and get more technical person to write specific
stuff.
Bertrand - If you find an incorrect info on wiki, send it on xen-devel
mailing list. We did write on some wiki pages that the information is
out of date.
Olivier - Ask contractors from linux foundation to do redirection from
old wiki pages.
Anthony - The wiki page is not managed by linux foundation.
Bertrand - Do not expect mantainers to do the porting of pages. They can
help. And we need consensus.
XXX - There is a wiki linux Foundation org.
Bertrand - Moving pages to git repo, the issue is that formatting is a
nightmare. Also, how do we sanity check the documentation
Olivier - Need how to guides (eg Xen on RPI). Create pages explaining
Xen project (history, architecture). How to install ? How to use (eg
distros) ? Keep it separate from technical documentation. George might
help us with people.
Start with a small article and then populate it with more how to pages ?
We should centralise the information somewhere.
Bertrand - We should avoid duplicating contents from Xen project into
new wiki.
Olivier - Need to track this item about improving the document, just
like any other technical item.
XXX - Create an issue to document things. Also need to push for motivation.
Olivier - For technical doc, where do we start ?
XXX - We could not get the information about memory allocation flags.
We need to add documentation to APIs.
Bertrand - The documentation should be in code. There was no consensus
on that.
XXX - Also the documentation has different formats.
Bertrand - For some part of code, we make sure someone modifying the
code is also updating the corresponding doc. It is not true for all the
code.
XXX - It is not clear whether to write a design doc or not.
Bertrand - Sending a design doc to the mailing list is very useful. So
we do not go into wrong direction. We should not commit design doc in
code. Always send design doc to mailing list.
Kind regards,
Ayan
