Hello Genodians,
The content on Genodians.org has been so interesting and varied that I worry we might lose valuable content in the sheer volume as time goes by. Here are a couple of ideas that I thought might help (probably already on the "to do" list, but just in case):
1. "Sticky" / "Featured" Posts - Things like the announcement for the latest release, other important news, etc. should probably be kept at/near the top or in a special area.
2. Search / Filter Tags - I think it would be helpful to add "tags" to the posts to make it easier to find items on a certain subject. I would recommend defining the format and adding the tag data as soon as possible, even if the feature isn't implemented for a while - it's always harder to go back over a lot of data than to enter it as the records are added.
Just food for thought...
Thanks!
While reading about Genode initially, I remember seeing a reference to a "wiki" somewhere; apparently there used to be a community- editable Genode wiki at some point?, which was later retired.
Hopefully that is not a bad omen for the announcement I'm about to make :-).. Maybe the old contents was just moved to another format, or there was a lack of external contributions, which did not warrant keeping its contents editable by third parties? Anyhow, here goes:
https://chiselapp.com/user/ttcoder/repository/genode-book/home
I'm writing an example in the one area where I'm starting to find my bearings a bit (Nitpicker: create a window, views...) to show what kind of format I expect. The idea is that others would do the same in areas I do *not* yet understand; then I'll get up to speed and will be able to fight my way out of a paper bag in them *g*. Obviously this would have to benefit the developers community at large.
**
Purpose (or lack thereof): This might get nowhere. If so, no big deal, didn't take personal resources or (much) time to set this up; it's mostly placeholders at this point.
Implementation: If the community does like the idea of a wiki, but not the implementation: this does not claim to be the best place for a wiki: maybe it'll end up having been just a stop gap hosting to get the ball rolling, until someone in the community finds a better host, better format (I'm very partial to fossil and all its features, don't expect unbiased/objective arguing from me *g*). What's important to me is the result: getting structured documentation, a programmer's hand book of sorts.
With all the disclaimers out of the way, here's my honest opinion: It would really help me and my project if there was a low-to-moderate flow of edits going to the "Genode Book" in the future, be it in the above form or another form. This might help others too.
Any suggestions, criticisms, out-of-the-box thinking, contributions, welcome, here or in "tickets" or wiki-forum ..etc.
Cedric
Hi Cedric,
Hopefully that is not a bad omen for the announcement I'm about to make :-).. Maybe the old contents was just moved to another format, or there was a lack of external contributions, which did not warrant keeping its contents editable by third parties? Anyhow, here goes:
https://chiselapp.com/user/ttcoder/repository/genode-book/home
I like the idea of a developer-oriented documentation maintained in a Wiki-style! Thanks for your initiative.
As you rightfully mentioned on the site, the "Genode Foundations" book is not really suitable for that. I wrote it as a reference, not as a didactic guide. The content is actually manually written, with source-code documentation woven in. You can find the text here [1].
[1] https://github.com/nfeske/genode-manual/blob/master/manual/functional_specif...
I actually don't plan to extend the scope of the "Genode Foundations" book because it is already fairly comprehensive and - as you mentioned - a bit overwhelming.
For the future, I'm considering writing a complementary document that focuses on the building blocks on top of the foundation (VFS, C runtime, networking, storage, GUI stack, virtualization). However, since some of these parts are still in flux, I think it is too early to start an intensive effort as I did for the "Foundations" book, yet.
A community-maintained collection of tutorial-style guides would be ideal to fill the gap right now. Regarding the substitution of the placeholders on your site with actual content, it would be good to know which areas would be most appreciated by users and aspiring developers.
Everyone,
* Can you think of concrete examples that you'd find helpful?
* Which areas of Genode do you find most challenging?
* What are the topics and application domains you'd enjoy reading about most?
Cheers Norman
I also like the developer wiki idea. Risk: keeping a wiki accurate for an evolving system requires an investment of time...
On 4/8/19 11:00 AM, Norman Feske wrote:
Everyone,
Can you think of concrete examples that you'd find helpful?
Which areas of Genode do you find most challenging?
What are the topics and application domains you'd enjoy reading about most?
One of the trickiest areas for me has been mixing the Libc environment with Genode native facilities (rpc, events, shared memory) in the same component.
Articles on networking would also be helpful. E.g., which of the common socket timeout techniques will work as they do in Linux? A list of known differences along these lines could be a great time saver.
// Steve Harp
An alternative to a wiki would be a question-and-answer forum like Stack Overflow. The tradeoff is shallow answers to articles in depth, but I would think Q&A to be more "self-maintaining".
I don't have a Stack Overflow account, but the licensing of the user content looks good to me, so I don't have a problem with using it.
Cheers Emery
On Monday, April 8, 2019 6:36:09 PM CEST, Steven Harp wrote:
I also like the developer wiki idea. Risk: keeping a wiki accurate for an evolving system requires an investment of time...
On 4/8/19 11:00 AM, Norman Feske wrote:
Everyone,
Can you think of concrete examples that you'd find helpful?
Which areas of Genode do you find most challenging?
What are the topics and application domains you'd enjoy reading about most?
One of the trickiest areas for me has been mixing the Libc environment with Genode native facilities (rpc, events, shared memory) in the same component.
Articles on networking would also be helpful. E.g., which of the common socket timeout techniques will work as they do in Linux? A list of known differences along these lines could be a great time saver.
// Steve Harp
Hi Steve,
El 8/4/19 a las 18:36, Steven Harp escribió:
I also like the developer wiki idea. Risk: keeping a wiki accurate for an evolving system requires an investment of time...
I find it useful that, for instance, the online documentation of Ubuntu normally tells you for wich versions of the system the article content has been approved. In the Genode Wiki, the author of an article could add the version he was using and other user can later add versions for which they could apply the article successfully. As soon as information in the article gets outdated, the affected parts could get split up by another user with the newer version like this:
Step 1 ====== ... Step 2 ====== :For version X and Y: ... :For version Z: ... Step 3 ====== ...
When an article becomes too complicated to read because of this, it can be split up completely into distinct articles about the same topic - for instance, one named "Topic A, versions up to Y" and one named "Topic A, versions beginning with Z". They would still contain the "approved version" tags but one can easily decide which articles to skip just by reading the title.
Articles on networking would also be helpful. E.g., which of the common socket timeout techniques will work as they do in Linux? A list of known differences along these lines could be a great time saver.
I could add information about the native Networking components of Genode but am not much into stuff like sockets and ported stacks ontop of that.
Cheers, Martin
On 31.03.2019 23:33, John J. Karcher wrote:
Hello Genodians,
The content on Genodians.org has been so interesting and varied that I worry we might lose valuable content in the sheer volume as time goes by. Here are a couple of ideas that I thought might help (probably already on the "to do" list, but just in case):
- "Sticky" / "Featured" Posts - Things like the announcement for the
latest release, other important news, etc. should probably be kept at/near the top or in a special area.
- Search / Filter Tags - I think it would be helpful to add "tags" to
the posts to make it easier to find items on a certain subject. I would recommend defining the format and adding the tag data as soon as possible, even if the feature isn't implemented for a while - it's always harder to go back over a lot of data than to enter it as the records are added.
Just food for thought...
Thanks!
Yes, I agree that these features are good to have as they would make Genodians.org much more convenient to use. But this will require some scripting to implement these features. Currently, Genodians.org is implemented as a simple web site with static content, only.
On 4/1/19 2:58 PM, Valery V. Sedletski via users wrote:
On 31.03.2019 23:33, John J. Karcher wrote:
Hello Genodians,
The content on Genodians.org has been so interesting and varied that I worry we might lose valuable content in the sheer volume as time goes by. Here are a couple of ideas that I thought might help (probably already on the "to do" list, but just in case):
- "Sticky" / "Featured" Posts - Things like the announcement for the
latest release, other important news, etc. should probably be kept at/near the top or in a special area.
- Search / Filter Tags - I think it would be helpful to add "tags" to
the posts to make it easier to find items on a certain subject. I would recommend defining the format and adding the tag data as soon as possible, even if the feature isn't implemented for a while - it's always harder to go back over a lot of data than to enter it as the records are added.
Just food for thought...
Thanks!
Yes, I agree that these features are good to have as they would make Genodians.org much more convenient to use. But this will require some scripting to implement these features. Currently, Genodians.org is implemented as a simple web site with static content, only.
Indeed. The "featured post" feature is the easier of the two, and shouldn't be too hard to implement with the current system.
I only brought up the "tags" idea at this time, because it will be a lot of (thankless) work to go back and add tags later. The data format could be defined (and data entered) before the feature is actually implemented.
Like I said, just a thought.
Thanks!
John J. Karcher devuser@alternateapproach.com
Hi,
On Sun, Mar 31, 2019 at 04:33:23PM -0400, John J. Karcher wrote:
Hello Genodians,
The content on Genodians.org has been so interesting and varied that I worry we might lose valuable content in the sheer volume as time goes by. Here are a couple of ideas that I thought might help (probably already on the "to do" list, but just in case):
- "Sticky" / "Featured" Posts - Things like the announcement for the latest
release, other important news, etc. should probably be kept at/near the top or in a special area.
- Search / Filter Tags - I think it would be helpful to add "tags" to the
posts to make it easier to find items on a certain subject. I would recommend defining the format and adding the tag data as soon as possible, even if the feature isn't implemented for a while - it's always harder to go back over a lot of data than to enter it as the records are added.
Just food for thought...
I can understand the wish for a more structured approach, but I have an odd feeling about the "sticky/featured" way. The question is: who decides what post becomes a featured one? I have understood genodians.org as a platform of community members with equal rights. In contrast to the "official" genode.org site, where already announcements, releases etc. can be found in the "news" area, and which is administrated by Genode Labs, genodians.org is a conglomerate of free developer content. Of course, Genode Labs as domain holder keeps the right to add/remove developer repositories, but apart from that everyone is equal member of the platform, and the last post is presented first. Moreover, interests are different regarding the visitors of the webpage. Newcomers will have different interests than more experienced users. Therefore, me personally would not like that "featured" feature.
The search and filter option is clearly a good convenience feature. As Valery has already mentioned, by now it is statically assembled content. So a first approach might be to find a way how Gosh can easily differentiate "tags" without disturbing normal content production much. Then tags could be filtered out when creating html out of a post. The script for producing the pages could collect the "tags" and produce one page per tag under genodians.org/tags/... where all articles are referenced inside. At the end of an article the tags of that one would reference the related tags pages.
What do you think about that approach? Would it fit your needs? Does anybody would like to step in here?
Best regards Stefan
Thanks!
John J. Karcher devuser@alternateapproach.com
Genode users mailing list users@lists.genode.org https://lists.genode.org/listinfo/users
Hi Stefan,
I can understand the wish for a more structured approach, but I have an odd feeling about the "sticky/featured" way. The question is: who decides what post becomes a featured one? I have understood genodians.org as a platform of community members with equal rights. In contrast to the "official" genode.org site, where already announcements, releases etc. can be found in the "news" area, and which is administrated by Genode Labs, genodians.org is a conglomerate of free developer content. Of course, Genode Labs as domain holder keeps the right to add/remove developer repositories, but apart from that everyone is equal member of the platform, and the last post is presented first. Moreover, interests are different regarding the visitors of the webpage. Newcomers will have different interests than more experienced users. Therefore, me personally would not like that "featured" feature.
thanks for sharing your opinion. I agree 100%. Sticky posts call for policy. But by design, the site tries to be as free from policy as possible.
I recognize John's point that he regards some articles as a kind of mileposts for orientation. In my opinion, however, the best way to keep important posts in the collective memory is to cross-reference them from newer posts. This way, readers may click through related articles and eventually discover the most relevant ones.
The search and filter option is clearly a good convenience feature. As Valery has already mentioned, by now it is statically assembled content. So a first approach might be to find a way how Gosh can easily differentiate "tags" without disturbing normal content production much. Then tags could be filtered out when creating html out of a post. The script for producing the pages could collect the "tags" and produce one page per tag under genodians.org/tags/... where all articles are referenced inside. At the end of an article the tags of that one would reference the related tags pages.
What do you think about that approach? Would it fit your needs? Does anybody would like to step in here?
The tags can be implemented like you suggest (the last part about the cross-referencing is a bit tricky though).
Regarding a suitable GOSH markup, the pipe character at the beginning of the line comes in mind. In GOSH, this is the markup for annotations.
| Annotations are useful in drafts of big documents | to highlight open questions or parts that are work | in progress. But in relatively short blog postings, | they have no use.
Since tags are actually kind of an annotation, we could specify tags as a space-separate list of words like this (e.g., at the end of the article, like a footer):
| storage performance cryptography
With this scheme, each tag can only be one word. But I think that's fine.
The list of tags could go into a dedicated box just below the list of authors at the left side of the page.
That said, I'm not too eager to implement the feature immediately. ;-)
Cheers Norman
I think that at least an agreement on how to define tags would be sensible. So, authors can start adding them while the effort of examining them may be delayed.
El 2/4/19 a las 10:04, Norman Feske escribió:
Since tags are actually kind of an annotation, we could specify tags as a space-separate list of words like this (e.g., at the end of the article, like a footer):
| storage performance cryptography
With this scheme, each tag can only be one word. But I think that's fine.
What about this approach:
| tags: "storage" "performance" "symmetric cryptography"
It would distinguish a tags annotation clearly from any normal annotation and allow for multiple words in a tag.
Cheers, Martin
On Tue, Apr 02, 2019 at 12:23:21PM +0200, Martin Stein wrote:
I think that at least an agreement on how to define tags would be sensible. So, authors can start adding them while the effort of examining them may be delayed.
El 2/4/19 a las 10:04, Norman Feske escribió:
Since tags are actually kind of an annotation, we could specify tags as a space-separate list of words like this (e.g., at the end of the article, like a footer):
| storage performance cryptography
With this scheme, each tag can only be one word. But I think that's fine.
What about this approach:
| tags: "storage" "performance" "symmetric cryptography"
It would distinguish a tags annotation clearly from any normal annotation and allow for multiple words in a tag.
I've opened up an issue at:
https://github.com/genodelabs/genodians.org/issues/11
so we can discuss the technical details there.
Regards Stefan
Cheers, Martin
Genode users mailing list users@lists.genode.org https://lists.genode.org/listinfo/users
Dear genodians,
to keep you informed about the outcome of the discussion about "tags' inside genodians.org postings:
We recommend all authors of genodians.org to add a GOSH annotation at the end of each posting, containing related keyword resp. tags. Those tags need to be simple words. If a word combination is absolutely essential, you might combine those words with an underscore. Here is an example:
| storage performance symmetric_cryptography
or have a look here:
https://github.com/skalk/genodian/commit/8186166f0ed31b67d02c17d9d860205e458...
For the time-being there will be no visible change in your postings, but in the future we can highlight and group postings according to their tags. How this will be done and visualized is topic of an ongoing discussion in the issue tracker. Participation is welcome also with regard to implementation ;-).
Thank you for your attention.
Regards Stefan
On Tue, Apr 02, 2019 at 12:52:00PM +0200, Stefan Kalkowski wrote:
On Tue, Apr 02, 2019 at 12:23:21PM +0200, Martin Stein wrote:
I think that at least an agreement on how to define tags would be sensible. So, authors can start adding them while the effort of examining them may be delayed.
El 2/4/19 a las 10:04, Norman Feske escribió:
Since tags are actually kind of an annotation, we could specify tags as a space-separate list of words like this (e.g., at the end of the article, like a footer):
| storage performance cryptography
With this scheme, each tag can only be one word. But I think that's fine.
What about this approach:
| tags: "storage" "performance" "symmetric cryptography"
It would distinguish a tags annotation clearly from any normal annotation and allow for multiple words in a tag.
I've opened up an issue at:
https://github.com/genodelabs/genodians.org/issues/11
so we can discuss the technical details there.
Regards Stefan
Cheers, Martin
Genode users mailing list users@lists.genode.org https://lists.genode.org/listinfo/users
-- Stefan Kalkowski Genode labs
https://github.com.skalk | https://genode.org
Genode users mailing list users@lists.genode.org https://lists.genode.org/listinfo/users