Skip to content

Commit 08e899c

Browse files
authored
Merge pull request #6146 from github/repo-sync
repo sync
2 parents 2c080cf + 685692b commit 08e899c

File tree

8 files changed

+141
-81
lines changed

8 files changed

+141
-81
lines changed
222 KB
Loading
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
---
2+
title: About Codespaces
3+
intro: '{% data variables.product.prodname_codespaces %} is a configurable online development environment, hosted by {% data variables.product.prodname_dotcom %} and powered by {% data variables.product.prodname_vscode %}, that allows you to develop entirely in the cloud.'
4+
product: '{% data reusables.gated-features.codespaces %}'
5+
redirect_from:
6+
- /github/developing-online-with-github-codespaces/about-github-codespaces
7+
- /github/developing-online-with-codespaces/about-codespaces
8+
- /codespaces/getting-started-with-codespaces/about-codespaces
9+
versions:
10+
free-pro-team: '*'
11+
topics:
12+
- Codespaces
13+
---
14+
15+
{% note %}
16+
17+
**Note:** {% data variables.product.prodname_codespaces %} is currently in limited public beta and subject to change. During the beta period, {% data variables.product.prodname_dotcom %} does not make any guarantees about the availability of {% data variables.product.prodname_codespaces %}.
18+
19+
{% endnote %}
20+
21+
### About {% data variables.product.prodname_codespaces %}
22+
23+
{% data variables.product.prodname_codespaces %} is a configurable cloud development environment available in your browser on {% data variables.product.prodname_dotcom %} or through {% data variables.product.prodname_vscode %}.
24+
25+
![An open codespace](/assets/images/help/codespaces/codespace-overview.png)
26+
27+
A codespace includes everything developers need to develop for a specific repository, including the {% data variables.product.prodname_vscode %} editing experience and common languages, tools, and utilities. {% data variables.product.prodname_codespaces %} is completely configurable, allowing you to create a customized development environment for your project, and allowing developers to personalize their experience with extensions and dotfile settings.
28+
29+
Codespaces offers many benefits to all teams by allowing for a consistent environment across your entire team, fast onboarding, and creating a secure space for development.
30+
31+
32+
### A consistent environment
33+
34+
You can create a single codespace configuration that defines the environment of every new codespace that anyone creates for your repository. Once you've made a configuration, developers don’t have to worry about installing the right tools to comment, review, or contribute. The standard environment is already available for them as soon as they create a codespace from the repository. For more information, see "[Configuring {% data variables.product.prodname_codespaces %} for your project](/github/developing-online-with-codespaces/configuring-codespaces-for-your-project)."
35+
36+
For help getting started with configurations for specific languages, see the [Getting Started](/codespaces/getting-started-with-codespaces) tutorials.
37+
38+
While every codespace created from your repository has a consistent development environment, developers can use {% data variables.product.prodname_codespaces %} wherever they need it – on {% data variables.product.prodname_dotcom %} or through {% data variables.product.prodname_vscode %}.
39+
40+
### Fast and personal onboarding
41+
42+
With a [dev container](/codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project#about-dev-containers) already configured in your repository, any new developer can quickly onboard with the correct development environment for your project by using the {% octicon "download" aria-label="The download icon" %} **Code** drop-down menu, and selecting **Open with Codespaces**.
43+
44+
![Open with Codespaces button](/assets/images/help/codespaces/open-with-codespaces-button.png)
45+
46+
Developers can start coding faster by reducing time spent configuring their environment.
47+
48+
Developers can also personalize aspects of their codespace environment by using a [dotfiles](https://dotfiles.github.io/tutorials/) repository. Personalization can include shell preferences, additional tools, editor settings, and extensions, such as Live Share. Personal customizations are stored on a per-user basis, so every codespace a developer opens has their environment ready to go. For more information, see "[Personalizing {% data variables.product.prodname_codespaces %} for your account](/github/developing-online-with-codespaces/personalizing-codespaces-for-your-account)."
49+
50+
Because {% data variables.product.prodname_codespaces %} can be accessed in the browser, developers can work on multiple projects by switching between tabs.
51+
52+
### A secure environment
53+
54+
{% data variables.product.prodname_codespaces %} allows developers to develop in the cloud instead of locally. This creates one single, trackable, source of truth. Developers can contribute from anywhere, on any machine, including tablets or Chromebooks, and there is no need to maintain local copies of intellectual property. Developers always have to be logged in and provided with access to both {% data variables.product.prodname_codespaces %} and specific repositories. These permissions can be revoked at any time. As soon as you revoke access, those developers will lose all access to protected resources. In addition, authenticated developers create audit trails so you know who is doing what. For more information on access and security, see "[Managing access and security for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-access-and-security-for-codespaces)."
55+
56+
Using {% data variables.product.prodname_codespaces %} is the most secure when all members of your team are using it. It means that there is no need to clone the repository onto a local machine and that developers don't need to install locally as `root`.
57+
58+
Developers and organization administrators can also configure settings to add encrypted secrets and enable GPG verification. For more information, see "[Managing encrypted secrets for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces)", "[Managing GPG verification for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/managing-gpg-verification-for-codespaces)".
59+
60+
### About billing for {% data variables.product.prodname_codespaces %}
61+
62+
{% data reusables.codespaces.about-billing-for-codespaces %} For more information, see "[About billing for {% data variables.product.prodname_codespaces %}](/github/developing-online-with-codespaces/about-billing-for-codespaces)."
63+
64+
### Joining the beta
65+
66+
A limited number of people will be invited to join the beta. To join the waitlist, see [Sign up for Codespaces beta](https://github.com/features/codespaces/signup).
67+
68+
### Contacting us about {% data variables.product.prodname_codespaces %}
69+
70+
If you encounter problems using {% data variables.product.prodname_codespaces %}, see "[Troubleshooting your codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)."
71+
72+
If you still need help or have feedback about {% data variables.product.prodname_codespaces %}, use the [Codespaces Feedback](https://github.com/github/feedback/discussions/categories/codespaces-feedback) discussion.

content/codespaces/getting-started-with-codespaces/about-billing-for-codespaces.md renamed to content/codespaces/codespaces-reference/about-billing-for-codespaces.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ versions:
66
free-pro-team: '*'
77
redirect_from:
88
- /github/developing-online-with-codespaces/about-billing-for-codespaces
9+
- /codespaces/getting-started-with-codespaces/about-billing-for-codespaces
910
topics:
1011
- Codespaces
1112
---
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Reference
3+
intro: 'This section contains references that will allow you to be successful with {% data variables.product.prodname_codespaces %}'
4+
versions:
5+
free-pro-team: '*'
6+
---
7+
8+
{% link_with_intro /about-billing-for-codespaces %}
9+

content/codespaces/getting-started-with-codespaces/about-codespaces.md

Lines changed: 0 additions & 62 deletions
This file was deleted.

content/codespaces/getting-started-with-codespaces/index.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@ versions:
55
free-pro-team: '*'
66
---
77

8-
{% link_with_intro /about-codespaces %}
9-
10-
{% link_with_intro /about-billing-for-codespaces %}
11-
128
{% link_with_intro /getting-started-with-your-nodejs-project-in-codespaces %}
139

1410
{% link_with_intro /getting-started-with-your-python-project-in-codespaces %}

content/codespaces/index.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,9 @@ topics:
1616

1717
### Table of Contents
1818

19+
{% link_in_list /about-codespaces %}
1920
{% link_in_list /getting-started-with-codespaces %}
2021
{% link_in_list /setting-up-your-codespace %}
2122
{% link_in_list /developing-in-codespaces %}
22-
{% link_in_list /working-with-your-codespace %}
23+
{% link_in_list /working-with-your-codespace %}
24+
{% link_in_list /codespaces-reference %}

0 commit comments

Comments
 (0)