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: elaborate on "docs-only" and "blog-only" #6131

Merged
merged 2 commits into from
Dec 20, 2021
Merged

docs: elaborate on "docs-only" and "blog-only" #6131

merged 2 commits into from
Dec 20, 2021

Conversation

himanshu007-creator
Copy link
Contributor

@himanshu007-creator himanshu007-creator commented Dec 19, 2021

Motivation

Love for opensource and trying out new things

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

(Write your test plan here. If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots and videos!)

Related PRs

(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)

@Josh-Cena
Copy link
Collaborator

I did mention in the issue that "we still need to rephrase it" but here I see a verbatim copy with some contents not even in the right place😅

Anyways, I would take this over and you can sit back while I do the edits before merging. Hope your love for opensource can take you far!

@Josh-Cena Josh-Cena added the pr: documentation This PR works on the website or other text documents in the repo. label Dec 19, 2021
@Josh-Cena Josh-Cena linked an issue Dec 19, 2021 that may be closed by this pull request
2 tasks
@Josh-Cena Josh-Cena changed the title rephrased documentation docs: elaborate on "docs-only" and "blog-only" Dec 20, 2021
@netlify
Copy link

netlify bot commented Dec 20, 2021

✔️ [V2]
Built without sensitive environment variables

🔨 Explore the source changes: fa70db6

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

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

@github-actions
Copy link

⚡️ Lighthouse report for the changes in this PR:

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

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

@Josh-Cena Josh-Cena merged commit c0a9978 into facebook:main Dec 20, 2021
@@ -328,7 +328,7 @@ authors:
The configuration file can be localized, just create a localized copy of it at:

```bash
website/i18n/<locale>/docusaurus-plugin-content-blog/authors.yml
Copy link
Collaborator

@slorber slorber Dec 20, 2021

Choose a reason for hiding this comment

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

this is a syntax we use on quite a few places, changing it only there makes it inconsistent.

We should either change it everywhere, or nowhere. I suggest to revert this change

Copy link
Collaborator

Choose a reason for hiding this comment

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

The mustache syntax is also used in quite a few places (at least when talking about category index pages). I made this change because it disrupts my local MDX syntax highlighting (silvenon/vscode-mdx#22) 🤦‍♂️

I suggest we collect all usage of such placeholder and try to normalize them. I would prefer single braces to either mustache or angle brackets.

Copy link
Collaborator

Choose a reason for hiding this comment

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

agree for normalization. I don't have a strong opinion on which syntax to use

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.

Rephrase the section on "docs-only" and "blog-only"
4 participants