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

Initial commit for Docusaurus integration #611

Merged
merged 16 commits into from
Jan 5, 2022
Merged

Initial commit for Docusaurus integration #611

merged 16 commits into from
Jan 5, 2022

Conversation

pringshia
Copy link
Contributor

@pringshia pringshia commented Nov 22, 2021

Adds docusaurus v2 at docs/web.

Run from root:

yarn install
yarn docs

Note: for now I've copied over the markdown files into docs/web/docs. We can later on delete the other doc files when the migration is complete.


TODOs:

BUG 1: react-dev-utils incompatibility between storybook and docusaurus

storybook requires this in package.json "resolutions":

"react-dev-utils": "patch:react-dev-utils@11.0.4#yarn-patches/react-dev-utils.patch",

... however docusaurus requires this in order to fix this issue + PR:

"react-dev-utils": "12.0.0-next.47"

Status: Exploring alternative solutions for docusaurus, as react-dev-utils@12 introduces other breaking changes for storybook

Resolved. Added a yarn patch with the changes from this PR directly to version 11.0.4. In an ideal world this would have been fixed in react-dev-utils@11.0.5 and not in a major version bump.


Screenshots

Screen Shot 2021-11-22 at 5 28 01 PM

Screen Shot 2021-11-22 at 5 28 07 PM

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

codecov-commenter commented Nov 22, 2021

Codecov Report

Merging #611 (5100eb0) into main (46b6118) will decrease coverage by 0.07%.
The diff coverage is 25.00%.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #611      +/-   ##
==========================================
- Coverage   63.26%   63.18%   -0.08%     
==========================================
  Files          86       86              
  Lines        8230     8242      +12     
==========================================
+ Hits         5207     5208       +1     
- Misses       3023     3034      +11     
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/operations/supervisor.py 79.00% <0.00%> (-0.65%) ⬇️
...tractions/architects/channels/websocket_channel.py 81.39% <0.00%> (+1.16%) ⬆️

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 46b6118...5100eb0. Read the comment docs.

@pringshia pringshia added the documentation Improvements or additions to documentation label Nov 22, 2021
pringshia and others added 11 commits November 22, 2021 11:25
)

* 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
* 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
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.

First pass looks good. We'll remove some of the boilerplate as we decide on content/usage for the blog and elsewhere.

@pringshia pringshia merged commit 4629f26 into main Jan 5, 2022
@JackUrb JackUrb deleted the docusaurus branch March 15, 2022 22:25
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. documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants