behavioral-model icon indicating copy to clipboard operation
behavioral-model copied to clipboard

Add more documentation of simple_switch_CLI commands to runtime_CLI.md

Open jafingerhut opened this issue 4 years ago • 7 comments

Creating this issue as one that can be marked as good for P4 beginners that are looking for a way to contribute things that take relatively small amount of learning and time.

This file documents many of the commands available in simple_switch_CLI, but there are plenty remaining marked as "TODO": https://github.com/p4lang/behavioral-model/blob/main/docs/runtime_CLI.md

Even picking one of those and writing some documentation would be useful, or if you feel energetic, a group of related commands.

jafingerhut avatar Dec 12 '21 16:12 jafingerhut

@antoninbas Does this repository have support for labels on issues, e.g. "beginner"? Ah, to answer my own question, I see another issue labeled as "good first issue". I do not see how to change this issue to have that label. Perhaps it requires your permissions to do so?

jafingerhut avatar Dec 12 '21 16:12 jafingerhut

@jafingerhut I added the good first issue label. I also bumped up your permissions for this repo to Triage so you can now label issues and assign them.

antoninbas avatar Dec 13 '21 17:12 antoninbas

This issue is stale because it has been open 180 days with no activity. Remove stale label or comment, or this will be closed in 180 days

github-actions[bot] avatar Sep 01 '22 00:09 github-actions[bot]

@antoninbas Can you assign me this issue I wanna take a shot at this ? Also if you could mention some reference files realted to this issue it would be huge help

abhijeet007rocks8 avatar Oct 01 '22 19:10 abhijeet007rocks8

@abhijeet007rocks8 sure, thanks for looking into this

antoninbas avatar Oct 03 '22 17:10 antoninbas

@antoninbas Can you provide some resources that i can take look into for writing the documentation

abhijeet007rocks8 avatar Oct 16 '22 07:10 abhijeet007rocks8

The only resources are the existing incomplete documentation (https://github.com/p4lang/behavioral-model/blob/main/docs/runtime_CLI.md) and the CLI code (https://github.com/p4lang/behavioral-model/blob/main/tools/runtime_CLI.py) which includes docstrings for most command.

antoninbas avatar Oct 18 '22 16:10 antoninbas

This issue is stale because it has been open 180 days with no activity. Remove stale label or comment, or this will be closed in 180 days

github-actions[bot] avatar Apr 17 '23 00:04 github-actions[bot]