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

Marketing / Community Documentation for OCM-Gear #228

Open
10 tasks
ccwienk opened this issue Oct 31, 2024 · 0 comments
Open
10 tasks

Marketing / Community Documentation for OCM-Gear #228

ccwienk opened this issue Oct 31, 2024 · 0 comments
Assignees
@zkdev
Labels
area/ipcei documentation Improvements or additions to documentation

Comments

@ccwienk
Copy link
Collaborator

ccwienk commented Oct 31, 2024 •
edited
Loading

Context / Motivation

Improve OCM-Gear's external reception by improving its documentation. Add a friendly description of its features, and value-add in addition to existing technical documentation. In addition, capture some demo-showcases, esp. for Delivery-Dashboard. Ideally, this could be added as an animated graphic (gif), as done by other projects, such as YouCompleteMe.

  • Document Demo-Showcases for Delivery-Service
    • local setup (for usage w/ demo-cases; ideally w/o mandatory configuration)
    • Delivery-Service-API (e.g. using a short demo-shellscript)
    • ClamAV-Demo
    • (BDBA-Demo) - might not be feasible due to dependency towards BDBA-Instance
    • GitHub-Issue-Replicator
  • Document Demo-Showcases for Delivery-Dashboard (incl. animated graphics -> README)
    • Rescoring (create, browse, ..)
    • ChatBot (if we eventually integrate it..)
    • Browsing of Artefact-Metadata
@ccwienk ccwienk added documentation Improvements or additions to documentation area/ipcei labels Oct 31, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@zkdev zkdev

Labels
area/ipcei documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ccwienk @zkdev