User-focused How to use the knowledge pooling tool and publication reporting workflow #5

Merged
mih merged 1 commit from publications into main 2026-02-04 09:34:38 +00:00
Member

This PR was motivated by drafting a publication reporting workflow for the TRR379 documentation. However, to avoid duplicating generic information across multiple workflows, it evolved into a proposed documentation structure in which setup and general shacl-vue/dump-things usage are pulled out into separate guides, with workflow-specific information reserved for specific examples (e.g., publication reporting).

This is only a start, and there are still a few missing pieces. Namely:

  • Adding info to the general usage guide on how to access submitted records in one's "inbox" using the dump-things API
  • Filling out specifics for the publication reporting workflow (e.g., contributor role assignment and other key data fields)
  • Adding info on the setup from a management perspective (e.g., Forgejo teams, configuring/deploying dump-things/shacl-vue, etc.)
This PR was motivated by drafting a publication reporting workflow for the TRR379 documentation. However, to avoid duplicating generic information across multiple workflows, it evolved into a proposed documentation structure in which setup and general shacl-vue/dump-things usage are pulled out into separate guides, with workflow-specific information reserved for specific examples (e.g., publication reporting). This is only a start, and there are still a few missing pieces. Namely: - [ ] Adding info to the general usage guide on how to access submitted records in one's "inbox" using the dump-things API - [x] Filling out specifics for the publication reporting workflow (e.g., contributor role assignment and other key data fields) - [ ] Adding info on the setup from a management perspective (e.g., Forgejo teams, configuring/deploying dump-things/shacl-vue, etc.)
The information on how to log in is more relevant for the
'get a hub account' HOWTO, and increase the amount of text in
the 'Use the knowledge pooling tool' quite a bit.
I've moved the information into 'get a hub account' and added
'and log in' to the heading. The Setup page for the knowledge
pool now links to it.
This way it is clear that both actions are necessary
Sketch publication reporting workflow
All checks were successful
Deploy on webserver / Build site with hugo and deploy on success (push) Successful in 9m35s
46f18c5c3e
a.wagner changed title from How to use the knowledge pooling tool and publication reporting workflow to User-focused How to use the knowledge pooling tool and publication reporting workflow 2025-11-17 14:00:35 +00:00
Collaborator

As this PR is quite long already, I am proposing to review the user-focused information in this PR as is now, and put information intended for administrative recipients in a separate PR.

As this PR is quite long already, I am proposing to review the user-focused information in this PR as is now, and put information intended for administrative recipients in a separate PR.
mih approved these changes 2025-11-17 16:06:49 +00:00
mih left a comment

I think this is already pretty comprehensive. I will merge this now. Future iterations are very likely, given that we still iterate on the tool and its workflows.

Thanks!!

I think this is already pretty comprehensive. I will merge this now. Future iterations are very likely, given that we still iterate on the tool and its workflows. Thanks!!
mih merged commit 46f18c5c3e into main 2025-11-17 16:06:57 +00:00
mih deleted branch publications 2025-11-17 16:06:57 +00:00
Sign in to join this conversation.
No reviewers
mih
No labels
No milestone
No project
No assignees
3 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
q04/docs.trr379.de!5
No description provided.