feat(v2): Improve the initial templates #4302

[samuelships]

Motivation

Attempt to fix #4079, with small consistent commits. This pr is a follow up to #4302.
This is my progress so far

• Added content for deploying your site

RoadMap

• Add content for translating site and managing versions

/cc @ShinteiMai

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

[netlify]

[V1] Deploy preview success

Built with commit 4eb31e4

https://deploy-preview-4320--docusaurus-1.netlify.app

[github-actions]

Size Change: -46 B (0%)

Total Size: 532 kB

Filename	Size	Change
website/build/assets/css/styles.********.css	87.1 kB	-46 B (0%)

ℹ️ View Unchanged

Filename	Size	Change
website/build/assets/js/main.********.js	359 kB	0 B
website/build/blog/2017/12/14/introducing-docusaurus/index.html	60.3 kB	0 B
website/build/docs/introduction/index.html	235 B	0 B
website/build/index.html	25.4 kB	0 B

_{compressed-size-action}

[netlify]

Deploy preview for docusaurus-2 ready!

Built with commit 4eb31e4

https://deploy-preview-4320--docusaurus-2.netlify.app

[github-actions]

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟠 Performance	78
🟢 Accessibility	96
🟢 Best practices	100
🟢 SEO	100
🟢 PWA	95

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

[samuelships]

@slorber Still waiting for a review

[slorber]

FYI I merged master in this PR and resolved the conflicts for you

[slorber]

Same comment as on the PR by @ShinteiMai

This page is way too verbose, we need something much more simple.

We don't need an exhaustive guide on how to deploy to GH pages, and particularly not a tutorial on how to automate this process with Github actions and the complicated CI script. This does not really spark joy to the user but rather a headache 😅

Basically, you just need to tell the user to run npm run build, and document the simplest way to get this site online.

• Self-host: npm run serve (no need to explain --port -- host options here or tell it's not performant)
• Github pages: tell the user to add a minimal config and npm run deploy (don't show an exhaustive list of env variable options here, don't tell how to automate this)
• Netlify or Vercel: signup, run npm run build and then drag & drop the ./build folder

Try to remove useless wordings and keep it minimalistic, inspire yourself from the 1st part which was largely trimmed, and use an imperative tone.

We should rather tell the user exactly what to do, we should not really give him any options (apart from choosing a hosting solution), so avoid telling the user about any cli or env variable options

[samuelships]

@slorber, I have made some changes

[samuelships]

@javidrashid I have added a screen recording.

[slorber]

Thanks, that looks better to me

Can you please run prettier on your docs files? Those are not formatted and there are missing line breaks around code blocks/admonitions.

I'm even surprised that the CI linter does not complain on this, will investigate

[slorber]

unfortunately this code is not valid anymore after prettier has been run 😅 that's why I said there were missing line breaks, because you have to add extra line breaks in some places before running prettier

[slorber]

going to revert your commit and do the fixes directly so I can merge asap

[slorber]

FYI I edited the whole tutorial on this PR to make it more coherent, and cleaned up some mistakes.

Thanks for working on this, going to merge now

[samuelships]

Thanks @slorber