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

docs: mention docusaurus.community site in resources #8943

Merged
merged 7 commits into from
Apr 28, 2023

Conversation

thadguidry
Copy link
Contributor

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

https://Docusaurus.community site should be mentioned under Community.

Test Plan

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Related issues/PRs

Fixes #8939

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Apr 28, 2023
@netlify
Copy link

netlify bot commented Apr 28, 2023

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 072f947
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/644b42fd5e578b000835cd9a
😎 Deploy Preview https://deploy-preview-8943--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@github-actions
Copy link

github-actions bot commented Apr 28, 2023

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟠 84 🟢 97 🟠 83 🟢 100 🟠 89 Report
/docs/installation 🟠 76 🟢 100 🟢 92 🟢 100 🟠 89 Report

@Josh-Cena Josh-Cena changed the title Fixes #8939 Add Community Docs site docs: add Community Docs site Apr 28, 2023
@Josh-Cena Josh-Cena added documentation The issue is related to the documentation of Docusaurus pr: documentation This PR works on the website or other text documents in the repo. and removed documentation The issue is related to the documentation of Docusaurus labels Apr 28, 2023
@thadguidry
Copy link
Contributor Author

thadguidry commented Apr 28, 2023

I have no idea how to fix the info admonition autocorrecting!

It's supposed to look like this:

:::info
We might allow direct links to be added in our official documentation that point to the community documentation, on a case by case basis, and as the community requests that such links to articles are useful.

We are also contemplating further integration into the official documentation at some point in the future.
:::

So that it's not super bolded as an info title for the whole 1st sentence!

Copy link
Collaborator

@Josh-Cena Josh-Cena left a comment

Choose a reason for hiding this comment

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

I don't think this needs an entire page. Just putting it in "resources" is good enough.

Co-authored-by: Joshua Chen <sidachen2003@gmail.com>
@Josh-Cena
Copy link
Collaborator

I have no idea how to fix the info admonition autocorrecting!

@thadguidry This is because of Prettier autoformatting. Please see https://docusaurus.io/docs/markdown-features/admonitions#usage-with-prettier

@thadguidry
Copy link
Contributor Author

I have no idea how to fix the info admonition autocorrecting!

@thadguidry This is because of Prettier autoformatting. Please see https://docusaurus.io/docs/markdown-features/admonitions#usage-with-prettier

Prettier extension is disabled in my VSCode and yet something is still autocorrecting the info admonition formatting once I click on commit (but not push yet).

@Josh-Cena
Copy link
Collaborator

Prettier extension is disabled in my VSCode and yet something is still autocorrecting the info admonition formatting once I click on commit (but not push yet).

We have a husky hook that automatically runs Prettier on pre-commit.

@Josh-Cena
Copy link
Collaborator

@thadguidry Please, please read https://docusaurus.io/docs/markdown-features/admonitions#usage-with-prettier — even if you hack around the pre-commit hook, this style will be rejected by the CI. All you need to do is add line breaks around the ::: fences.

Copy link
Collaborator

@slorber slorber left a comment

Choose a reason for hiding this comment

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

Thanks 👍

Ok to add this once you are ready with the text

@slorber slorber changed the title docs: add Community Docs site docs: mention docusaurus.community site in resources Apr 28, 2023
@slorber slorber merged commit 2cae24f into facebook:main Apr 28, 2023
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: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Mention docusaurus.community docs under Awesome Resources
4 participants