nuts-foundation / nuts-foundation/nuts-node

Wiki: improve authorization books

Open
#2,871 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation final
Dominant language
Go
Stars
28
Forks
23
Avg merge
1d 10h
Merged PRs (30d)
76

Description

We removed the NutsAuthorizationCredential EHR integration guide, it is replaced with policy based authorization. This is documented on the Wiki in the following book: https://wiki.nuts.nl/books/authorizing-resource-access

The book needs to be improved:

  • Split in 2 books:
    • Writing a use case
      • Move "Guidelines" to it
      • Write "Writing a Discovery Definition"
    • Implementing a use case
      • Write "Registering on a Discovery Service"
      • Write "Using Discovery Services"
      • Move "APISIX deployment" description and improve it

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the current authorizing-resource-access book on the Nuts Wiki and review its existing Guidelines and APISIX deployment content. Organize the material into separate Writing a use case and Implementing a use case books, covering the Discovery Definition, Discovery Service registration and use, and improved APISIX deployment description. Done means all requested sections are present in the two-book structure and the removed EHR integration guide is no longer treated as current.

Written by the indexing model from the issue text.

Assessment

Domain
authorization, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.