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.

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

Add documentation about FlagsProvider #4870

Merged
merged 7 commits into from
Aug 17, 2023

Conversation

tomatophobia
Copy link
Contributor

Motivation:

  • The idea comes from here.
  • By providing documentation for FlagsProvider, developers will be able to easily modify default properties and receive assistance with testing and debugging.

Modifications:

  • Create a documentation of configuring properties via FlagsProvider.

Result:

  • The document can help developers to modify default properties or test more easily.

site/src/pages/docs/server-flags-provider.mdx Outdated Show resolved Hide resolved
site/src/pages/docs/server-flags-provider.mdx Outdated Show resolved Hide resolved
site/src/pages/docs/server-flags-provider.mdx Outdated Show resolved Hide resolved
Apply the review and rebase the branch
Copy link
Contributor

@jrhee17 jrhee17 left a comment

Choose a reason for hiding this comment

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

Thanks! Left some minor comments, but looks good! 🙇

site/src/pages/docs/server-flags-provider.mdx Outdated Show resolved Hide resolved
site/src/pages/docs/server-flags-provider.mdx Outdated Show resolved Hide resolved
site/src/pages/docs/toc.json Outdated Show resolved Hide resolved
site/src/pages/docs/server-flags-provider.mdx Outdated Show resolved Hide resolved
site/src/pages/docs/server-flags-provider.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@ikhoon ikhoon left a comment

Choose a reason for hiding this comment

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

Thanks, @tomatophobia! Please address @jrhee17's comments.

site/src/pages/docs/server-flags-provider.mdx Outdated Show resolved Hide resolved
@ikhoon ikhoon added this to the 1.25.0 milestone Jun 24, 2023
@codecov
Copy link

codecov bot commented Aug 5, 2023

Codecov Report

Patch coverage has no change and project coverage change: +0.03% 🎉

Comparison is base (b2e31ee) 74.18% compared to head (352dfb9) 74.21%.

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #4870      +/-   ##
============================================
+ Coverage     74.18%   74.21%   +0.03%     
- Complexity    19472    19485      +13     
============================================
  Files          1672     1672              
  Lines         71799    71799              
  Branches       9202     9202              
============================================
+ Hits          53261    53283      +22     
+ Misses        14199    14186      -13     
+ Partials       4339     4330       -9     

see 18 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jrhee17
Copy link
Contributor

jrhee17 commented Aug 15, 2023

For others who are reviewing:

globalflags

Copy link
Contributor

@jrhee17 jrhee17 left a comment

Choose a reason for hiding this comment

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

Pushed a small commit, but looks good to me! Thanks a lot for the additional documentation @tomatophobia 🙇 👍 🚀

Copy link
Member

@trustin trustin left a comment

Choose a reason for hiding this comment

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

Thanks a lot, @tomatophobia! 🙇

Copy link
Member

@minwoox minwoox left a comment

Choose a reason for hiding this comment

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

I am so glad that now we have documentation for the Flags provider. 😆
Thanks a lot, @tomatophobia! 🚀 🚀 🚀

@minwoox minwoox merged commit 402162c into line:main Aug 17, 2023
12 of 14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants