jprdonnelly/docs
1
0
Fork 0
mirror of synced 2025-12-22 03:16:52 -05:00
Code Issues Projects Releases Wiki Activity

updating content files

Browse Source
This commit is contained in:
Grace Park
2021-06-14 12:06:52 -07:00
parent 850ab9ccb4
commit 6f7e4f50dc
1154 changed files with 6299 additions and 6267 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
content/codespaces/developing-in-codespaces/creating-a-codespace.md
View File

@@ -16,7 +16,7 @@ topics:
{% data reusables.codespaces.release-stage %}
### About codespace creation
## About codespace creation
You can create a codespace on either {% data variables.product.prodname_dotcom_the_website %} or in {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.codespaces-are-personal %}
@@ -42,7 +42,7 @@ When you create a codespace, a number of steps happen to enable full access to y
{% data reusables.codespaces.you-can-see-all-your-codespaces %}
### Creating a codespace
## Creating a codespace
{% data reusables.repositories.navigate-to-repo %}
2. Under the repository name, use the "Branch" drop-down menu, and select the branch you want to create a codespace for.

2
content/codespaces/developing-in-codespaces/deleting-a-codespace.md
View File

@@ -26,6 +26,6 @@ topics:
2. To the right of the codespace you want to delete, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}, then click **{% octicon "trash" aria-label="The trash icon" %} Delete**
![Delete button](/assets/images/help/codespaces/delete-codespace.png)
### Deleting a codespace in {% data variables.product.prodname_vscode %}
## Deleting a codespace in {% data variables.product.prodname_vscode %}
For information on deleting a codespace in {% data variables.product.prodname_vscode %}, see "[Using Codespaces in Visual Studio Code](/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code#deleting-a-codespace-in-visual-studio-code)."

12
content/codespaces/developing-in-codespaces/developing-in-a-codespace.md
View File

@@ -16,7 +16,7 @@ topics:
{% data reusables.codespaces.release-stage %}
### About development with {% data variables.product.prodname_codespaces %}
## About development with {% data variables.product.prodname_codespaces %}
{% data variables.product.prodname_codespaces %} provides you with the full development experience of {% data variables.product.prodname_vscode %}. {% data reusables.codespaces.use-visual-studio-features %}
@@ -34,24 +34,24 @@ For more information on using {% data variables.product.prodname_vscode %}, see
{% data reusables.codespaces.use-chrome %} For more information, see "[Troubleshooting your codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)."
#### Personalizing your codespace
### Personalizing your codespace
{% data reusables.codespaces.about-personalization %} For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/codespaces/setting-up-your-codespace/personalizing-codespaces-for-your-account)."
{% data reusables.codespaces.apply-devcontainer-changes %} For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project#apply-changes-to-your-configuration)."
#### Running your app from a codespace
### Running your app from a codespace
{% data reusables.codespaces.about-port-forwarding %} For more information, see "[Forwarding ports in your codespace](/github/developing-online-with-codespaces/forwarding-ports-in-your-codespace)."
#### Committing your changes
### Committing your changes
{% data reusables.codespaces.committing-link-to-procedure %}
#### Using the Command Palette
### Using the Command Palette
The Command Palette allows you to access and manage many features for {% data variables.product.prodname_codespaces %} and {% data variables.product.prodname_vscode %}. For more information, see "[Using the Command Palette in {% data variables.product.prodname_codespaces %}](/codespaces/codespaces-reference/using-the-command-palette-in-codespaces)."
### Navigating to an existing codespace
## Navigating to an existing codespace
1. {% data reusables.codespaces.you-can-see-all-your-codespaces %}
2. Click the name of the codespace you want to develop in.

10
content/codespaces/developing-in-codespaces/forwarding-ports-in-your-codespace.md
View File

@@ -14,7 +14,7 @@ topics:
{% data reusables.codespaces.release-stage %}
### About forwarded ports
## About forwarded ports
Port forwarding gives you access to TCP ports running within your codespace. For example, if you're running a web application on port 4000, you can access the application from your browser to test and debug the application.
@@ -24,7 +24,7 @@ When an application running inside a codespace outputs a port to the console, {%
You can also forward a port manually, label forwarded ports, share fowarded ports publicly, and add forwarded ports to the codespace configuration.
### Forwarding a port
## Forwarding a port
You can manually forward a port that wasn't forwarded automatically.
@@ -34,7 +34,7 @@ You can manually forward a port that wasn't forwarded automatically.
1. Type the port number or address, then press enter.
![Text box to type port button](/assets/images/help/codespaces/port-number-text-box.png)
### Labeling a port
## Labeling a port
You can label a port to make the port more easily identifiable in a list.
@@ -43,7 +43,7 @@ You can label a port to make the port more easily identifiable in a list.
![Label icon for port](/assets/images/help/codespaces/label-icon.png)
{% data reusables.codespaces.type-port-label %}
### Sharing a port
## Sharing a port
If you want to share a forwarded port with others, you can make the port public. After you make a port public, anyone with the port's URL can view the running application without needing to authenticate.
@@ -54,7 +54,7 @@ If you want to share a forwarded port with others, you can make the port public.
![Copy icon for port URL](/assets/images/help/codespaces/copy-icon-port-url.png)
1. Send the copied URL to the person you want to share the port with.
### Adding a port to the codespace configuration
## Adding a port to the codespace configuration
You can add a forwarded port to the {% data variables.product.prodname_codespaces %} configuration for the repository, so the port will automatically be forwarded for all codespaces created from the repository. After you update the configuration, any previously created codespaces must be rebuilt for the change to apply. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)."

10
content/codespaces/developing-in-codespaces/using-codespaces-in-visual-studio-code.md
View File

@@ -16,7 +16,7 @@ topics:
{% data reusables.codespaces.release-stage %}
### Prerequisites
## Prerequisites
To develop in a codespace directly in {% data variables.product.prodname_vscode %}, you must sign into the {% data variables.product.prodname_github_codespaces %} extension. The {% data variables.product.prodname_github_codespaces %} extension requires {% data variables.product.prodname_vscode %} October 2020 Release 1.51 or later.
@@ -45,7 +45,7 @@ Use the {% data variables.product.prodname_vs %} Marketplace to install the [{%
{% endwindows %}
### Creating a codespace in {% data variables.product.prodname_vscode %}
## Creating a codespace in {% data variables.product.prodname_vscode %}
After you connect your {% data variables.product.product_name %} account to the {% data variables.product.prodname_github_codespaces %} extension, you can develop in a codespace that you created on {% data variables.product.product_name %} or in {% data variables.product.prodname_vscode %}.
@@ -58,14 +58,14 @@ After you connect your {% data variables.product.product_name %} account to the
![Searching for a branch to create a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-branch-vscode.png)
5. Click the machine type you want to develop in.
![Instance types for a new {% data variables.product.prodname_codespaces %}](/assets/images/help/codespaces/choose-sku-vscode.png)
### Opening a codespace in {% data variables.product.prodname_vscode %}
## Opening a codespace in {% data variables.product.prodname_vscode %}
{% data reusables.codespaces.click-remote-explorer-icon-vscode %}
2. Under "Codespaces", click the codespace you want to develop in.
3. Click the Connect to Codespace icon.
![The Connect to Codespace icon in {% data variables.product.prodname_vscode %}](/assets/images/help/codespaces/click-connect-to-codespace-icon-vscode.png)
### Changing the machine type in {% data variables.product.prodname_vscode %}
## Changing the machine type in {% data variables.product.prodname_vscode %}
{% data reusables.codespaces.codespaces-machine-types %}
@@ -81,7 +81,7 @@ You can change the machine type of your codespace at any time.
If the codespace is currently running, a message is displayed asking if you would like to restart and reconnect to your codespace now. Click **Yes** if you want to change the machine type used for this codespace immediately. If you click **No**, or if the codespace is not currently running, the change will take effect the next time the codespace restarts.
### Deleting a codespace in {% data variables.product.prodname_vscode %}
## Deleting a codespace in {% data variables.product.prodname_vscode %}
1. Under "Codespaces", right-click the codespace you want to delete.
2. In the drop-down menu, click **Delete Codespace**.

14
content/codespaces/developing-in-codespaces/using-source-control-in-your-codespace.md
View File

@@ -12,7 +12,7 @@ topics:
{% data reusables.codespaces.release-stage %}
### About source control in {% data variables.product.prodname_codespaces %}
## About source control in {% data variables.product.prodname_codespaces %}
You can perform all the Git actions you need directly within your codespace. For example, you can fetch changes from the remote repository, switch branches, create a new branch, commit and push changes, and create a pull request. You can use the integrated terminal within your codespace to enter Git commands, or you can click icons and menu options to complete all the most common Git tasks. This guide explains how to use the graphical user interface for source control.
@@ -26,7 +26,7 @@ A typical workflow for updating a file using {% data variables.product.prodname_
* Commit the change.
* Raise a pull request.
### Creating or switching branches
## Creating or switching branches
1. If the current branch is not shown in the status bar, at the bottom of your codespace, right-click the status bar and select **Source control**.
1. Click the branch name in the status bar.
@@ -40,7 +40,7 @@ A typical workflow for updating a file using {% data variables.product.prodname_
{% endtip %}
### Pulling changes from the remote repository
## Pulling changes from the remote repository
You can pull changes from the remote repository into your codespace at any time.
@@ -51,7 +51,7 @@ You can pull changes from the remote repository into your codespace at any time.
If a dev container has been changed since you created the codespace you can apply the changes by rebuilding the container for the codespace. For more information, see "[Configuring Codespaces for your project](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#applying-changes-to-your-configuration)."
### Setting your codespace to automatically fetch new changes
## Setting your codespace to automatically fetch new changes
You can set your codespace to automatically fetch details of any new commits that have been made to the remote repository. This allows you to see whether your local copy of the repository is out of date, in which case you may choose to pull in the new changes.
@@ -66,7 +66,7 @@ If the fetch operation detects new changes on the remote repository, you'll see
![Enable Git autofetch](/assets/images/help/codespaces/autofetch-all.png)
1. If you want to change the number of seconds between each automatic fetch, edit the value of **Git: Autofetch Period**.
### Committing your changes
## Committing your changes
{% data reusables.codespaces.source-control-display-dark %}
1. To stage your changes, click **+** next to the file you've changed, or next to **Changes** if you've changed multiple files and you want to stage them all.
@@ -76,7 +76,7 @@ If the fetch operation detects new changes on the remote repository, you'll see
1. To commit your staged changes, click the check mark at the top the source control side bar.
![Click the check mark icon](/assets/images/help/codespaces/codespaces-commit-checkmark-icon.png)
### Raising a pull request
## Raising a pull request
1. After you've committed changes to your local copy of the repository, click the **Create Pull Request** icon.
![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-pr-button.png)
@@ -84,7 +84,7 @@ If the fetch operation detects new changes on the remote repository, you'll see
![Source control side bar with staging button highlighted](/assets/images/help/codespaces/codespaces-commit-pr.png)
1. Click **Create**.
### Pushing changes to your remote repository
## Pushing changes to your remote repository
You can push the changes you've made. This applies those changes to the upstream branch on the remote repository. You might want to do this if you're not yet ready to create a pull request, or if you prefer to create a pull request on {% data variables.product.prodname_dotcom %}.