p4lang / tutorials

P4 language tutorials

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Update the basic Exercise with prerequisite section

AdarshRawat1 opened this issue · comments

Issue

A new user usually starts with the first module basic exercise and might skip the installation guidelines, resulting in errors like "Module not found" .

Possible solution

We can explicitly mention following points in the README of basic Exercise under a new PREREQUISITE section.

Discuss

If this section seems reasonable, should we include this only is first exercise or other exercises as well ?

IF we add a prerequisite for every exercise (and I'm not sure we should), it should be very brief, e.g. a link to a single location where the prerequisites are described clearly. I hope that the "Obtaining required software" section is good enough, but past experience suggests to me that no matter what we change, there will still be people that do something differently and then ask questions when things do not work for them.

IF we add a prerequisite for every exercise (and I'm not sure we should), it should be very brief, e.g. a link to a single location where the prerequisites are described clearly.

Sounds reasonable

I hope that the "Obtaining required software" section is good enough.

We can include this section as a single line before every tutorial.

Something like -

Make sure you have followed the steps in "Obtaining required software" section .

but past experience suggests to me that no matter what we change, there will still be people that do something differently and then ask questions when things do not work for them.

Totally agreed 👍