JanssenProject/jans

docs(OAuth feature): create documentation for UMA features

Aperta

#4860 aperta il 8 mag 2023

 (1 commento) (0 reazioni) (1 assegnatario)Java (175 fork)auto 404
area-documentationgood first issuehacktoberfestpriority-5triaged

Metriche repository

Star
 (639 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

General Guidelines

  • Start by covering the general definition of the feature in a few lines and then point to the appropriate section of the SPEC. Please refrain from repeating what is there in the SPEC already.
  • Try to make the content Janssen Server specific ( e.g. what are the related Janssen Server properties or feature flags, how to change relevant settings using TUI/command line (use the screenshots), recommendations around recommended values, use-cases)
  • Follow the documentation contribution guidelines.
  • Feel free to refer to content available in Gluu documentation (or any other IDP) if the content doesn't need to be customized for Janssen Server

Document Location

Suggested sections

Existing Gluu documentation:

https://gluu.org/docs/gluu-server/4.5/admin-guide/uma/

Above plus there is more documentation around UMA in Gluu docs. Jans docs also have small bit of existing UMA docs.

Guida contributor