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

Adding tutorial stubs to docusaurus #613

Merged
merged 11 commits into from
Dec 6, 2021
Merged

Adding tutorial stubs to docusaurus #613

merged 11 commits into from
Dec 6, 2021

Conversation

JackUrb
Copy link
Contributor

@JackUrb JackUrb commented Nov 23, 2021

Adds a number of pages intended to be filled out to complete my first pass of tutorial + how-to documentation.


High level categories:

Screen Shot 2021-12-06 at 10 38 10 AM

@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 Nov 23, 2021
@codecov-commenter
Copy link

codecov-commenter commented Nov 23, 2021

Codecov Report

Merging #613 (bb22e58) into docusaurus (1fb092f) will decrease coverage by 0.12%.
The diff coverage is 25.00%.

Impacted file tree graph

@@              Coverage Diff               @@
##           docusaurus     #613      +/-   ##
==============================================
- Coverage       63.24%   63.11%   -0.13%     
==============================================
  Files              86       86              
  Lines            8230     8242      +12     
==============================================
- Hits             5205     5202       -3     
- Misses           3025     3040      +15     
Impacted Files Coverage Δ
...ractions/blueprints/mixins/screen_task_required.py 76.34% <ø> (ø)
...ns/blueprints/parlai_chat/parlai_chat_blueprint.py 36.48% <ø> (ø)
mephisto/operations/utils.py 34.74% <10.00%> (-1.62%) ⬇️
...phisto/abstractions/architects/heroku_architect.py 35.51% <14.28%> (+0.27%) ⬆️
mephisto/abstractions/blueprint.py 77.50% <100.00%> (ø)
...lueprints/abstract/static_task/static_blueprint.py 41.41% <100.00%> (ø)
...tractions/blueprints/mixins/onboarding_required.py 77.58% <100.00%> (ø)
mephisto/abstractions/architects/mock_architect.py 88.88% <0.00%> (-2.62%) ⬇️
...tractions/architects/channels/websocket_channel.py 79.06% <0.00%> (-2.33%) ⬇️

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 1fb092f...bb22e58. Read the comment docs.

@pringshia
Copy link
Contributor

Looks good - liking the structure and organization. I've updated the OP with a screenshot of the high level categories in the side bar.

.gitignore Outdated
# Examples
examples/simple_static_task/hydra_configs/conf/*
!examples/simple_static_task/hydra_configs/conf/example.yaml
!examples/simple_static_task/hydra_configs/conf/onboardiing_example.yaml
Copy link
Contributor

Choose a reason for hiding this comment

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

looks like a typo, extra "i" in "onboardiing"

@@ -26,7 +26,7 @@
"file-loader": "^6.0.0",
"style-loader": "^0.23.0",
"url-loader": "^2.0.1",
"webpack": "^4.19.1",
"webpack": "^5.0.0-rc.6",
Copy link
Contributor

Choose a reason for hiding this comment

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

I always thought this would be a big upgrade, glad it wasn't too bad

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah the disruption is pretty minor across the board, I'm happy to help if downstream projects hit an issue after this lands.

@JackUrb JackUrb merged commit 75ef231 into docusaurus Dec 6, 2021
@JackUrb JackUrb deleted the tutorials branch December 6, 2021 19:30
pringshia added a commit that referenced this pull request Jan 5, 2022
* Initial commit for docusaurus integration

* Get storybook working with docusaurus, since they shared a common resolution for react-dev-utils

* Add all docs to Docusaurus

* Move pregenerated docs into Archive, fix up image links, fix up docusaurus.config.js

* Fix webpack5 and react-dev-utils incompat error

* Fix broken link in quickstart

* Hide the blog for now and make some basic updates to the homepage

* Fix docusaurus build issue

* Documentation for the Mephisto Review CLI and front-end build work (#612)

* Add review CLI docs

* Add more content

* Add Contributos & Authors folder

* Docs reorg

* Update broken link

* fix sidebar

* Position quickstart at the top of the Guides sidebar

* Sidebar and footer updates

* Flesh out sidebar organization a bit more

* fix broken links

* Adding tutorial stubs to docusaurus (#613)

* Adding doc stubs

* Contribution guide

* Adding documentation stubs for many sections

* Some documentation

* Working through first tutorial using defaults

* Fixing up mephisto wut

* Finishing first tutorial finally :)

* Fixing after webpack updates, work on tutorial 2

* Double ii fix

* fix broken quickstart link

* Almost finished with custom react tutorial

* Unnecessary change

Co-authored-by: Jack Urbanek <[email protected]>
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
No open projects
Development

Successfully merging this pull request may close these issues.

None yet

4 participants