Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add READMEs and comments to PYexamples #1067

Open
17 tasks
VanDavv opened this issue Dec 7, 2022 · 0 comments
Open
17 tasks

Add READMEs and comments to PYexamples #1067

VanDavv opened this issue Dec 7, 2022 · 0 comments
Labels
epic

Comments

@VanDavv
Copy link
Contributor

VanDavv commented Dec 7, 2022 •
edited by lucekdudek

  • Prepare a README in the examples directory containing both install instructions (can be taken from root README), a list of all examples and corresponding commands to run, and GIFs/images showing the expected output. Some of those descriptions are present in the handbook
  • Inside each examples’ directory describe file structure (why certain files are needed and how to e.g. build a GVM image), add a description of the solved problem and which API parts are used (to distinguish between a basic hello world example which should use the bare minimum)
  • Add comments to the source code itself, explaining what certain parts of the code do or how are they derived (like image hash)

Examples (can be converted to separated issues)

  • http-proxy
  • ssh
  • blender
  • low-level-api
  • webapp
  • custom_runtime
  • market-strategy
  • webapp_fileupload
  • custom-usage-counter
  • yacat
  • external-api-request
  • scan
  • hello-world
  • simple-service-poc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
epic
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@VanDavv @lucekdudek