Merge pull request #691 from ojacques/codespaces

Add Codespaces capability to contribute to the site

Author: janiceilene

.devcontainer.json

@@ -0,0 +1,18 @@
+// Codespaces environment for docs.github.com
+// For format details, see https://aka.ms/vscode-remote/devcontainer.json 
+{
+    "name": "docs.github.com",
+    "service": "container-doc",
+    "settings": {
+        "terminal.integrated.shell.linux": "/bin/bash",
+        "cSpell.language": ",en"
+    },
+    // Install pre-requisites, and start to serve docs.github.com locally
+    "postCreateCommand": "npm install && npm start",
+    "forwardPorts": [4000],
+    // Visual Studio Code extensions which help authoring for docs.github.com.
+    "extensions": [
+        "yzhang.markdown-all-in-one",
+        "streetsidesoftware.code-spell-checker"
+    ]
+}

CONTRIBUTING.md

@@ -27,8 +27,13 @@ Fork using GitHub Desktop:
 - Once Desktop is set up, you can use it to [fork the repo](https://docs.github.com/en/desktop/contributing-and-collaborating-using-github-desktop/cloning-and-forking-repositories-from-github-desktop)!
 
 Fork using the command line:
+
 - [Fork the repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo#fork-an-example-repository) so that you can make your changes without affecting the original project until you're ready to merge them.
 
+Fork with [GitHub Codespaces](https://github.com/features/codespaces):
+
+- [Fork, edit, and preview](https://docs.github.com/en/free-pro-team@latest/github/developing-online-with-codespaces/creating-a-codespace) using [GitHub Codespaces](https://github.com/features/codespaces) without having to install and run the project locally.
+
 ### Make your update:
 Make your changes to the file(s) you'd like to update. Here are some tips and tricks for [using the docs codebase](#working-in-the-githubdocs-repository).
   - Are you making changes to the application code? You'll need **Node.js v14** to run the site locally. See [contributing/development.md](contributing/development.md).

contributing/development.md

@@ -26,6 +26,12 @@ When you're ready to stop your local server, type <kbd>CTRL</kbd><kbd>c</kbd> in
 
 Note that `npm run build` is a one-time step that create static assets.
 
+### Using GitHub Codespaces
+
+As an alternative, you can simply use [GitHub Codespaces](https://github.com/features/codespaces).
+
+In a matter of minutes, you will be ready to edit, preview and test your changes directly from the comfort of your browser.
+
 ## Site structure
 
 This site was originally a Ruby on Rails web application. Some time later it was converted into a static site powered by [Jekyll](https://jekyllrb.com/). A few years after that it was migrated to [Nanoc](https://nanoc.ws/), another Ruby static site generator.