Skip to content

Conversation

@slorber
Copy link
Collaborator

@slorber slorber commented Jan 7, 2022

Motivation

Refactor the hacky @theme/hooks/useDocs hook into a proper @docusaurus/plugin-content-docs/client interface

First cases where a plugin exposes its own client-side code

Have you read the Contributing Guidelines on pull requests?

yes

Test Plan

refactor: existing tests should pass

@slorber slorber added the pr: maintenance This PR does not produce any behavior differences to end users when upgrading. label Jan 7, 2022
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jan 7, 2022
@netlify
Copy link

netlify bot commented Jan 7, 2022

✔️ [V2]

🔨 Explore the source changes: d30641f

🔍 Inspect the deploy log: https://app.netlify.com/sites/docusaurus-2/deploys/61d860a1ff7b0f000810fb84

😎 Browse the preview: https://deploy-preview-6287--docusaurus-2.netlify.app

@github-actions
Copy link

github-actions bot commented Jan 7, 2022

⚡️ Lighthouse report for the changes in this PR:

Category Score
🟠 Performance 88
🟢 Accessibility 98
🟢 Best practices 100
🟢 SEO 100
🟢 PWA 95

Lighthouse ran on https://deploy-preview-6287--docusaurus-2.netlify.app/

@github-actions
Copy link

github-actions bot commented Jan 7, 2022

Size Change: +731 B (0%)

Total Size: 675 kB

Filename Size Change
website/build/assets/js/main.********.js 501 kB +731 B (0%)
ℹ️ View Unchanged
Filename Size
website/.docusaurus/globalData.json 41.6 kB
website/build/assets/css/styles.********.css 102 kB
website/build/index.html 29.6 kB

compressed-size-action

'@theme/(.*)': '@docusaurus/theme-classic/src/theme/$1',
'@site/(.*)': 'website/$1',

// TODO why Jest can't figure node package entry points?
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

@slorber slorber merged commit 024f2bf into main Jan 7, 2022
@slorber slorber deleted the slorber/refactor-useDocs-hook branch January 7, 2022 16:04
feynmanliang pushed a commit to feynmanliang/beanmachine that referenced this pull request Apr 5, 2022
…arch#1387)

Summary:
### Motivation

Fix vulnerability described in  ai/nanoid#328

Note `docusaurus-plugin-internaldocs-fb` doesn't pin its hard docusaurus version dependency and facebook/docusaurus#6287 introduced a breaking change, so we need to pin docusaurus version to keep the build green.

### Changes proposed

Upgrades pinned JS dep versions from running `yarn upgrade`

Pull Request resolved: facebookresearch#1387

Test Plan:
`yarn build`

### Types of changes
- [x] Docs change / refactoring / dependency upgrade
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

### Checklist
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [x] I have read the **[CONTRIBUTING](https://github.com/facebookresearch/beanmachine/blob/main/CONTRIBUTING.md)** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
- [x] The title of my pull request is a short description of the requested changes.

**Static Docs Preview: beanmachine**
|[Full Site](https://our.intern.facebook.com/intern/staticdocs/eph/D35151907/V5/beanmachine/)|

|**Modified Pages**|

Reviewed By: horizon-blue

Differential Revision: D35151907

Pulled By: feynmanliang

fbshipit-source-id: 051b702c83a482fb3d3dacbd8bb3ebe9a0109af3
facebook-github-bot pushed a commit to facebookresearch/beanmachine that referenced this pull request Apr 5, 2022
Summary:
### Motivation

Fix vulnerability described in  ai/nanoid#328

Note `docusaurus-plugin-internaldocs-fb` doesn't pin its hard docusaurus version dependency and facebook/docusaurus#6287 introduced a breaking change, so we need to pin docusaurus version to keep the build green.

### Changes proposed

Upgrades pinned JS dep versions from running `yarn upgrade`

Pull Request resolved: #1387

Test Plan:
`yarn build`

### Types of changes
- [x] Docs change / refactoring / dependency upgrade
- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to change)

### Checklist
- [ ] My code follows the code style of this project.
- [ ] My change requires a change to the documentation.
- [ ] I have updated the documentation accordingly.
- [x] I have read the **[CONTRIBUTING](https://github.com/facebookresearch/beanmachine/blob/main/CONTRIBUTING.md)** document.
- [ ] I have added tests to cover my changes.
- [ ] All new and existing tests passed.
- [x] The title of my pull request is a short description of the requested changes.

**Static Docs Preview: beanmachine**
|[Full Site](https://our.intern.facebook.com/intern/staticdocs/eph/D35151907/V5/beanmachine/)|

|**Modified Pages**|

Reviewed By: horizon-blue

Differential Revision: D35151907

Pulled By: feynmanliang

fbshipit-source-id: b4274c7fc713fccddd1d1c64c9024138107a5716
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

CLA Signed Signed Facebook CLA pr: maintenance This PR does not produce any behavior differences to end users when upgrading.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants