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

docs: renku plugins graph and aqs annotations #3622

Merged
merged 6 commits into from
Oct 4, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,25 @@ data science pipeline.
`Documentation <https://github.com/ratschlab/renku-mls/blob/master/docs/gettingstarted.rst>`_
`Example Project <https://renkulab.io/projects/learn-renku/plugins/renku-mls-plugin>`_

renku-graph-vis
---------------

`renku-graph-vis <https://github.com/oda-hub/renku-graph-vis/>`_ is a plugin that
provides a graphical representation of the renku repository's knowledge graph.
In particular, the plugin enables an interactive graph visualization feature
for real-time monitoring during a renku session introducing the ability to have
a live overview of the ongoing development. It also provides two CLI commands:

* ``display`` to generate a representation of the graph over a png output image
* ``show-graph`` to start an interactive visualization of the graph over the browser

renku-aqs-annotation
--------------------

`renku-aqs-annotation <https://github.com/oda-hub/renku-aqs-annotation/>`_ is a plugin that
intercepts several key astroquery methods and stores a number of dedicated annotations
containing information about the calls to these methods (like the arguments used in the call)
to the project's Knowledge Graph.

Developing a plugin?
--------------------
Expand Down
4 changes: 4 additions & 0 deletions docs/spelling_wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ Amalthea
analytics
api
app
aqs
args
argv
ascii
astroquery
async
attrs
auditability
Expand Down Expand Up @@ -173,6 +175,7 @@ params
PIDs
pipenv
PNG
png
Postgresql
powerline
pre
Expand Down Expand Up @@ -296,6 +299,7 @@ versioning
Versioning
vertices
viewmodel
vis
vm
wasDerivedFrom
webhook
Expand Down