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.

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

Add Integration Tutorials #3

Open
kmdn opened this issue Jan 27, 2022 · 0 comments
Open

Add Integration Tutorials #3

kmdn opened this issue Jan 27, 2022 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@kmdn
Copy link
Owner

kmdn commented Jan 27, 2022

[What]
Add more explicit tutorials additionally to the "implicit" knowledge conveyed by templates (currently given by linker recommendation and spaCy mention detection submodules).

[How]
Add tutorials (e.g. video, step-by-step, ...) on how to add an own system for:

  1. integration into main system (entry as known and identified IP)
  2. integration into customized system (IP-based external call)
  3. integration into local execution (optional: only useful in case of excessive back-and-forth network communication)

[Why]
Current implementations are not as understandable as we'd like them to be.
We have to lower the user entry barrier in order to gain community support and potential traction.

@kmdn kmdn changed the title Add Tutorials Add Integration Tutorials (Improve Documentation) Jan 27, 2022
@kmdn kmdn added documentation Improvements or additions to documentation good first issue Good for newcomers labels Jan 27, 2022
@kmdn kmdn self-assigned this Jan 27, 2022
@kmdn kmdn changed the title Add Integration Tutorials (Improve Documentation) Add Integration Tutorials Jan 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant