docs(cli): add info about development on github codespaces

[vedantmgoyal9]

Motivation

• GitHub Codespaces returns 502 when forwarding port #6865 (comment)

Have you read the Contributing Guidelines on pull requests?

Yes.

Related PRs

• GitHub Codespaces returns 502 when forwarding port #6865

[facebook-github-bot]

Hi @vedantmgoyal2009!

Thank you for your pull request and welcome to our community.

Action Required

In order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you.

Process

In order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with CLA signed. The tagging process may take up to 1 hour after signing. Please give it that time before contacting us about it.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

[vedantmgoyal9]

@facebook-github-bot recheck now.

[Josh-Cena]

@vedantmgoyal2009 The CLA bot updates the PR status automatically. It doesn't get triggered by anything.

[Josh-Cena]

I think you are far over-estimating the number of people who use GitHub codespaces. You are the first so far to report this problem either on GitHub or Discord. Therefore, I don't think it makes sense to put this in installation, which everyone has to read.

What about moving to the CLI documentation instead?

[netlify]

✔️ [V2]
Built without sensitive environment variables

🔨 Explore the source changes: 9f180c7

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

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

[github-actions]

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟠 Performance	56
🟢 Accessibility	100
🟢 Best practices	92
🟢 SEO	100
🟢 PWA	90

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

[vedantmgoyal9]

I do not have any problem in moving it to CLI docs but am just putting my thoughts here.

I think there are a considerable number of developers on GitHub that uses and even provide support for development on Codespaces and do have .devcontainer files for easier development. For instance, I can remember of Oh-my-posh (https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/CONTRIBUTING.md#codespaces--devcontainer-development-environment)

[Josh-Cena]

Yes, but that's CONTRIBUTING, which is developer-facing, not user-facing.

We have a lot of casual users who don't use these toolchains—they have a text editor, Node and NPM, and that's it. We don't want to clutter the installation guide (and any introductory content) with these niche use-cases. So yes, moving to CLI docs is the most sensible.

[vedantmgoyal9]

I guess a section under "Advanced Guides" would make more sense?

[Josh-Cena]

No, because "advanced" is relative to users' understanding of our infrastructure, not relative to their toolchain's advancedness :)

[facebook-github-bot]

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Meta Open Source project. Thanks!

[slorber]

ok to add this here, but I'd like the block to be quite generic

It does not apply only to codespace, and this option is also available in other frameworks: CRA, Gatsby, NextJS...

See for example
https://nextjs.org/docs/api-reference/cli#development
gatsbyjs/gatsby#8149

[vedantmgoyal9]

Thank you🎉🎉