c70adf6702
* reorganizing security and access sections * updating delete doc * making vscode doc moore os agnostic * updating developing in a codespace * fixing broken links * fixing some broken links * fixing broken topic * fixing broken link * Managing users permissions for your organization and other stuff (#19231) * Add new 'Managing user permissions for your organization' article * Revise 'Managing access and security for Codespaces' and screenshot * Add codespaces to org repo permissions article * Apply suggestions from code review Co-authored-by: Amy Burns <timeyoutakeit@github.com> * fixing title to match slug * fixing broken link * updating personalization doc * updating troubleshooting guide * updating creating doc * adding information about when secrets are used * removing secrets stuff from this PR * Addig order of operations for codespaces * self review fixes * Apply suggestions from code review Co-authored-by: Allison Weins <3174849+2percentsilk@users.noreply.github.com> * renaming quickstart to correct pattern: * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * rewriting re. review comments * Codespaces landingpage (#19053) * adding new tables and linking to info on audit logs * editing some text: * adding new info on how to add image registry login * adding link and fixing table * formatting * formatting * Apply suggestions from code review Co-authored-by: Laura Coursen <lecoursen@github.com> * updaing private image registry secret info and other improvements * some minor fixes * fixing test errors * rewriting registry secret section * rewriting registry secret section * updating link to reflect title * Update content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md Co-authored-by: Laura Coursen <lecoursen@github.com> * updating bullet point * moving codespaces to top-level item * fixing duplicated redirect * Adding some organization for contributors * adding learning codespaces to index file * do not error out if category array is empty * Apply suggestions from code review Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com> * fixing broken link * testing what is possible for the landing page * adding first run of landing page * adding new video and intro text * add landing page scaffolding * Update codespaces_code_examples.yml * lint * fixing issues in branch * fixing nav * fixing broken directs * Creating guides sub-landing page * adding topics * removing unused toopic * removing instant * updating landing page and guides page * updating versioning * removing unused topic * removing other versions: * actually fixing broken links * fixing title * fixing intro to suit the landing page * Apply suggestions from code review Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * adding video * adding video * adding correct link for video * removing duplicated guides Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: Sarah Schneider <sarahs@github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com> Co-authored-by: Rachael Sewell <rachmari@github.com> Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> * rewording and reorganizing code samples * fixing some feedback from engineering * Adding doc on Secrets in codespaces (#19248) * adding secrets docs * fixing some broken links * fixing some more broken redirects * copy edit and updating limits for secrets * adding limits for users * Apply suggestions from code review Co-authored-by: Felicity Chapman <felicitymay@github.com> * adding feedback Co-authored-by: Felicity Chapman <felicitymay@github.com> * updating beta banner * adding quickstarts to landing page * removing availability section from reusable Co-authored-by: Lucas Costi <lucascosti@users.noreply.github.com> Co-authored-by: Allison Weins <3174849+2percentsilk@users.noreply.github.com> Co-authored-by: Laura Coursen <lecoursen@github.com> Co-authored-by: Sarah Schneider <sarahs@github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com> Co-authored-by: Rachael Sewell <rachmari@github.com> Co-authored-by: Felicity Chapman <felicitymay@github.com>
3.6 KiB
3.6 KiB
title, intro, permissions, redirect_from, versions, type, topics
| title | intro | permissions | redirect_from | versions | type | topics | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Creating a codespace | You can create a codespace for a branch in a repository to develop online. | Anyone can create a codespace for any public repository, or for any repository owned by their user account. |
|
|
how_to |
|
{% data reusables.codespaces.release-stage %}
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 %}
Codespaces are associated with a specific branch of a repository and the repository cannot be empty. {% data reusables.codespaces.concurrent-codespace-limit %} For more information, see "Deleting a codespace."
When you create a codespace, a number of steps happen to enable full access to your development environment.
- Resources such as a VM and storage for your container are assigned. A new VM is created every time you create or start a codespace to ensure that you always have the latest versions and security patches.
- {% data variables.product.prodname_codespaces %} recieves information about your repository, branch, commits, your public dotfiles repository, and any secrets that you have created.
- {% data variables.product.prodname_codespaces %} executes a shallow clone of the repository.
- If you have one in your repository, {% data variables.product.prodname_codespaces %} runs the
devcontainer.jsonfile. For more information, see "Configuring {% data variables.product.prodname_codespaces %} for your project." - Your Docker container,
docker-compose, or other initialization is run. - At this point, the codespace is marked as available and you can connect.
- Once the codespace is made available, depending on the commands in the devcontainer, the codespace will continue with some set up.
- The codespace shares ports added in the
devcontainer.jsonfile. - The codespace runs anything specified in
postCreateCommand. - {% data variables.product.prodname_codespaces %} clones your dotfiles repository to the codespaces environment and looks for an install file. For more information, see "Personalizing {% data variables.product.prodname_codespaces %} for your account."
- Finally, the codespace does a full clone of the repo so you have full access to it.
- The codespace shares ports added in the
{% data reusables.codespaces.use-visual-studio-features %}
{% data reusables.codespaces.you-can-see-all-your-codespaces %}
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.
- Under the repository name, use the {% octicon "download" aria-label="The download icon" %} Code drop-down menu, and select Open with Codespaces.
- To create a codespace using a Standard machine type, click {% octicon "plus" aria-label="The plus icon" %} New codespace.
