retis-org / retis

Tracing packets in the Linux networking stack & friends
https://retis.readthedocs.io/en/stable/
100 stars 14 forks source link

Publish documentation #232

Closed amorenoz closed 1 year ago

amorenoz commented 1 year ago

Changes summary:

Future work:

An example with some fake releases can be seen here.

Fixed: #235

amorenoz commented 1 year ago

Overall that looks very nice!

In addition to the small comments, I think we should keep in the main README:

* Some c/p examples (to attract users).

We might end up having lots of examples (hopefully!), so how about a short version of the most common ones and then a link to the expanded version?

* Instructions on how to install from copr and container.

* Limitations (not to hide them anywhere).

In general, the challenge here is to reuse the code/content and avoid duplication. Not sure if GH can inline another .md file.

atenart commented 1 year ago

Overall that looks very nice! In addition to the small comments, I think we should keep in the main README:

* Some c/p examples (to attract users).

We might end up having lots of examples (hopefully!), so how about a short version of the most common ones and then a link to the expanded version?

Agreed, that would be best. The idea is to attract users on the README. Having in addition a more detailed doc with more complex / broad examples is nice too.

* Instructions on how to install from copr and container.

* Limitations (not to hide them anywhere).

In general, the challenge here is to reuse the code/content and avoid duplication. Not sure if GH can inline another .md file.

Maybe we can have the limitations only on the homepage then? And for installation instructions, there might be some duplication. I'd say it's OK if it's only for a few things and if there are no simple solution.

amorenoz commented 1 year ago

Closing this PR, will create anotherone from a branch in this repo, so the result can be seen more easily.