Update to reflect OIDC authentication support in pool tool #15

Merged
j.goddard merged 5 commits from oidc into main 2026-08-18 09:46:50 +00:00
Member

The knowledge pool editor now supports a simple OIDC-based login rather than requiring manual generation/entry of an access token. This PR does the following to reflect that in the TRR379 documentation:

  • Moves the how-to guide on generating an access token to the "Advanced" section, so that users starting out don't stumble on it unnecessarily
  • Update the authentication instructions in the contributor profile and publication reporting workflow how-to guides to recommend using the new login feature instead of tokens
The knowledge pool editor now supports a simple OIDC-based login rather than requiring manual generation/entry of an access token. This PR does the following to reflect that in the TRR379 documentation: - Moves the how-to guide on generating an access token to the "Advanced" section, so that users starting out don't stumble on it unnecessarily - Update the authentication instructions in the contributor profile and publication reporting workflow how-to guides to recommend using the new login feature instead of tokens
msz left a comment

I think all changes are correct and they deemphasize the usage of tokens, but (considering that references/services/knowledge-pooling is now the page that gets linked from the /ui landing page of the Pool) I wonder if we should go two little steps further to better highlight the use of OAuth2 as the (primary?) login method. I'd suggest:

  • in references/services/knowledge-pooling/_index.md it says at the beginning "Token-based authentication that integrates with Forgejo teams" - maybe worth changing to "OAuth2 and token-based..." (OAuth2 is arguably a niche / technical term, but to me this communicates "sign in through" / "access delegation" better than anything else)
  • in start/accounts/_index.md (first "see..." link in the page above) it still says "Access to the knowledge pooling tool is managed using tokens and Forgejo teams" and could use the same treatment as other pages in this PR.

Finally (this is just loosely for consideration rather than a change suggestion), I think it's good to have login explained (repeated) directly in the pages about submitting contributor or publication records, but there is no standalone explanation. So from the references page, you go through several clicks to get there. OTOH, one is more likely to start from the howtos...

I think all changes are correct and they deemphasize the usage of tokens, but (considering that `references/services/knowledge-pooling` is now the page that gets linked from the `/ui` landing page of the Pool) I wonder if we should go two little steps further to better highlight the use of OAuth2 as the (primary?) login method. I'd suggest: - in `references/services/knowledge-pooling/_index.md` it says at the beginning "Token-based authentication that integrates with Forgejo teams" - maybe worth changing to "OAuth2 and token-based..." (OAuth2 is arguably a niche / technical term, but to me this communicates "sign in through" / "access delegation" better than anything else) - in `start/accounts/_index.md` (first "see..." link in the page above) it still says "Access to the knowledge pooling tool is managed using tokens and Forgejo teams" and could use the same treatment as other pages in this PR. Finally (this is just loosely for consideration rather than a change suggestion), I think it's good to have login explained (repeated) directly in the pages about submitting contributor or publication records, but there is no standalone explanation. So from the references page, you go through several clicks to get there. OTOH, one is more likely to start from the howtos...
Sign in to join this conversation.
No reviewers
No labels
No milestone
No project
No assignees
2 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!15
No description provided.