Skip to content

chore(metrics): github page doc #284

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 26 commits into from
Dec 12, 2021
Merged

chore(metrics): github page doc #284

merged 26 commits into from
Dec 12, 2021

Conversation

flochaz
Copy link
Contributor

@flochaz flochaz commented Dec 9, 2021

Description of your changes

Add doc for metrics module

How to verify this change

  1. build the doc with npm run docs-runLocalDocker
  2. go to http://localhost:8000/core/metrics/

Related issues, RFCs

#151

PR status

Is this ready for review?: YES
Is it a breaking change?: NO

Checklist

  • My changes meet the tenets criteria
  • I have performed a self-review of my own code
  • I have commented my code where necessary, particularly in areas that should be flagged with a TODO, or hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • The code coverage hasn't decreased
  • I have added tests that prove my change is effective and works
  • New and existing unit tests pass locally and in Github Actions
  • Any dependent changes have been merged and published in downstream module
  • The PR title follows the conventional commit semantics

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Copy link
Contributor

@dreamorosi dreamorosi left a comment

Choose a reason for hiding this comment

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

Looking great! No issue with the content, just some minor formatting details (tried to provide suggestions for most of them).

@dreamorosi dreamorosi added documentation Improvements or additions to documentation metrics This item relates to the Metrics Utility labels Dec 10, 2021
@dreamorosi dreamorosi added this to the beta-release milestone Dec 10, 2021
@dreamorosi dreamorosi linked an issue Dec 10, 2021 that may be closed by this pull request
@flochaz flochaz merged commit 2561ede into main Dec 12, 2021
@flochaz flochaz deleted the metrics/doc branch December 12, 2021 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation metrics This item relates to the Metrics Utility
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Docs: create metrics documentation
3 participants