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.

Sign up for GitHub

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

Jump to bottom

docs(reporting): create documentation for reporting #4878

Closed
ossdhaval opened this issue May 9, 2023 · 2 comments · Fixed by #5167
Closed

docs(reporting): create documentation for reporting #4878

ossdhaval opened this issue May 9, 2023 · 2 comments · Fixed by #5167
Assignees
@yuriyz
Labels
area-documentation Documentation needs to change as part of issue or PR
Milestone
1.0.16

Comments

@ossdhaval
Copy link
Contributor

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

https://docs.jans.io/head/admin/auth-server/reporting-metrics/

Suggested sections

  • Health
  • Monthly Active Users
  • Failed/Successful Authentications
  • Tokens Issued
  • User/Client Counts
@ossdhaval ossdhaval added the area-documentation Documentation needs to change as part of issue or PR label May 9, 2023
@ossdhaval
Copy link
Contributor Author

Hi @nynymike I suggest consolidating the reporting-matrix section with sub-documents becoming sub-sections in one document. Please share your views.

@moabu moabu modified the milestones: 1.0.13, 1.0.14 May 10, 2023
@ossdhaval ossdhaval modified the milestones: 1.0.14, 1.0.16 May 22, 2023
@yuriyz
Copy link
Contributor

yuriyz commented Jun 2, 2023

I agree, I also like bigger solid page then many tiny pages .

yuriyz added a commit that referenced this issue Jun 5, 2023
@yuriyz
doc(jans-auth-server): created documentation for reporting #4878
677a64b
yuriyz added a commit that referenced this issue Jun 5, 2023
@yuriyz
doc(jans-auth-server): fixed path in reporting docs #4878
943fb2a
yuriyz added a commit that referenced this issue Jun 5, 2023
@yuriyz
doc(jans-auth-server): removed redundant pages for reporting #4878
467ec17
yuriyz added a commit that referenced this issue Jun 6, 2023
@yuriyz
doc(jans-auth-server): emphasize stat endpoint on metrics page #4878
2038166
@yuriyz yuriyz mentioned this issue Jun 6, 2023
Merged
yuriyz added a commit that referenced this issue Jun 6, 2023
@yuriyz
docs(jans-auth-server): created documentation for reporting #4878 (#5167
7725478 
)

* doc(jans-auth-server): created documentation for reporting #4878

* doc(jans-auth-server): fixed path in reporting docs #4878

* doc(jans-auth-server): removed redundant pages for reporting #4878

* doc(jans-auth-server): emphasize stat endpoint on metrics page #4878
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@yuriyz yuriyz

Labels
area-documentation Documentation needs to change as part of issue or PR
Projects
None yet
Milestone
1.0.16
Development

Successfully merging a pull request may close this issue.

docs(jans-auth-server): created documentation for reporting #4878 JanssenProject/jans
3 participants
@ossdhaval @yuriyz @moabu