Skip to content

docs: add modules to usagestats #160

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.

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

Merged
merged 5 commits into from
Jul 31, 2024
Merged

docs: add modules to usagestats #160

merged 5 commits into from
Jul 31, 2024

Conversation

JTorreG
Copy link
Collaborator

@JTorreG JTorreG commented Jul 30, 2024

Adds the modules object documentation to the Usage Statistics document

@JTorreG JTorreG self-assigned this Jul 30, 2024
@JTorreG JTorreG requested review from ac000, lcrilly and avahahn July 30, 2024 14:42
@lcrilly
Copy link
Contributor

lcrilly commented Jul 30, 2024

I know it's a different repo but want to make sure we don't forget to extend https://github.com/nginx/unit/blob/master/docs/unit-openapi.yaml#L3903

@lcrilly
Copy link
Contributor

lcrilly commented Jul 30, 2024

The overall context of the page (including the filename) is heavily predicated on usage statistics but the modules object is something a bit different.

E.g.

Unit collects instance- and app-wide metrics

Worth a look through the page to refine this explanation?

@ac000
Copy link
Member

ac000 commented Jul 30, 2024

I know it's a different repo but want to make sure we don't forget to extend https://github.com/nginx/unit/blob/master/docs/unit-openapi.yaml#L3903

How is this used and is it hand generated?

@ac000
Copy link
Member

ac000 commented Jul 30, 2024

The overall context of the page (including the filename) is heavily predicated on usage statistics but the modules object is something a bit different.

Should probably be renamed status-endpoint.rst or somesuch... (just status.rst might be confused for the overall status of the project)

@lcrilly
Copy link
Contributor

lcrilly commented Jul 30, 2024

I suggest statusapi.rst because we already have controlapi.rst

Copy link
Contributor

@lcrilly lcrilly left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@JTorreG JTorreG merged commit 9c820c3 into main Jul 31, 2024
@JTorreG JTorreG deleted the status-modules branch July 31, 2024 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants