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

Auto Generate Provider Documentation #873

Merged
merged 5 commits into from
Aug 1, 2022
Merged

Conversation

Etesam913
Copy link
Contributor

@Etesam913 Etesam913 commented Jul 29, 2022

Overview

Uses the method from #870 to add auto-generate Provider docs.

Image

provider-docs

@facebook-github-bot facebook-github-bot added the CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed. label Jul 29, 2022
@codecov-commenter
Copy link

codecov-commenter commented Jul 29, 2022

Codecov Report

Merging #873 (e9b0fb9) into auto-generate-requester (b1bf25c) will increase coverage by 0.07%.
The diff coverage is n/a.

@@                     Coverage Diff                     @@
##           auto-generate-requester     #873      +/-   ##
===========================================================
+ Coverage                    64.48%   64.55%   +0.07%     
===========================================================
  Files                          107      107              
  Lines                         9289     9291       +2     
===========================================================
+ Hits                          5990     5998       +8     
+ Misses                        3299     3293       -6     
Impacted Files Coverage Δ
mephisto/utils/metrics.py 29.62% <0.00%> (-0.23%) ⬇️
...ractions/blueprints/mixins/screen_task_required.py 74.74% <0.00%> (+0.25%) ⬆️
...tractions/architects/channels/websocket_channel.py 76.56% <0.00%> (+5.46%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b1bf25c...e9b0fb9. Read the comment docs.

@Etesam913 Etesam913 changed the title [WIP] Auto generate providers [WIP] Auto Generate Provider Documentation Jul 29, 2022
@Etesam913 Etesam913 changed the title [WIP] Auto Generate Provider Documentation Auto Generate Provider Documentation Jul 31, 2022
)
provider_file.new_header(level=1, title="Provider")
provider_file.new_paragraph(
"The crowd provider determines the source of the crowd workers."
Copy link
Contributor

@pringshia pringshia Aug 1, 2022

Choose a reason for hiding this comment

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

I like the simplicity of what you have here. I think I would merge it with some of the details from https://mephisto.ai/docs/explanations/architecture_overview/#crowdproviders to say something like:

Crowd providers standardize access to external crowd workers, by wrapping external API communication through a standardized interface.

cc @JackUrb

provider_file = MdUtils(
file_name="../../../../docs/web/docs/reference/providers.md",
)
provider_file.new_header(level=1, title="Provider")
Copy link
Contributor

Choose a reason for hiding this comment

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

All the other sibling pages are plural ("Architects", "Blueprints"). Can we call this "Providers" to stay consistent?

Copy link
Contributor

@JackUrb JackUrb left a comment

Choose a reason for hiding this comment

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

Simple enough! Provider's at the moment don't have very much to customize on a launch, but I'm happy to have this for the ones that inevitably get more complex (very future-proofed!)

@Etesam913 Etesam913 changed the base branch from auto-generate-requester to main August 1, 2022 17:43
@Etesam913 Etesam913 merged commit f1b6766 into main Aug 1, 2022
@Etesam913 Etesam913 deleted the auto-generate-providers branch August 8, 2022 15:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed This label is managed by the Facebook bot. Authors need to sign the CLA before a PR can be reviewed.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants