From 1f3bd126ca000982c538f1621d47722737740943 Mon Sep 17 00:00:00 2001 From: hubwriter Date: Thu, 1 Dec 2022 13:56:16 +0000 Subject: [PATCH] Quick docs bug fix: relocate the lifecycle article (#33084) --- .../creating-a-codespace-for-a-repository.md | 2 +- .../creating-a-codespace-from-a-template.md | 2 +- .../codespaces/developing-in-codespaces/deleting-a-codespace.md | 2 +- content/codespaces/developing-in-codespaces/index.md | 1 - .../developing-in-codespaces/opening-an-existing-codespace.md | 2 +- .../stopping-and-starting-a-codespace.md | 2 +- content/codespaces/getting-started/deep-dive.md | 2 +- content/codespaces/getting-started/index.md | 1 + .../the-codespace-lifecycle.md | 1 + content/codespaces/index.md | 2 +- .../restricting-the-base-image-for-codespaces.md | 2 +- .../using-github-codespaces-with-github-classroom.md | 2 +- data/reusables/codespaces/stopping-a-codespace.md | 2 +- 13 files changed, 12 insertions(+), 11 deletions(-) rename content/codespaces/{developing-in-codespaces => getting-started}/the-codespace-lifecycle.md (99%) diff --git a/content/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository.md b/content/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository.md index e4492c0bb6..aeb477c475 100644 --- a/content/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository.md +++ b/content/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository.md @@ -49,7 +49,7 @@ When you create a codespace, a number of steps happen to create and connect you For more information on what happens when you create a codespace, see "[Deep Dive](/codespaces/getting-started/deep-dive)." -For more information on the lifecycle of a codespace, see "[The codespace lifecycle](/codespaces/developing-in-codespaces/the-codespace-lifecycle)." +For more information on the lifecycle of a codespace, see "[The codespace lifecycle](/codespaces/getting-started/the-codespace-lifecycle)." If you want to use Git hooks for your codespace, then you should set up hooks using the [`devcontainer.json` lifecycle scripts](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_lifecycle-scripts), such as `postCreateCommand`, during step 4. Since your codespace container is created after the repository is cloned, any [git template directory](https://git-scm.com/docs/git-init#_template_directory) configured in the container image will not apply to your codespace. Hooks must instead be installed after the codespace is created. For more information on using `postCreateCommand`, see the [`devcontainer.json` reference](https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_devcontainerjson-properties) in the {% data variables.product.prodname_vscode_shortname %} documentation. diff --git a/content/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template.md b/content/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template.md index 1f90ae0e98..842a20e971 100644 --- a/content/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template.md +++ b/content/codespaces/developing-in-codespaces/creating-a-codespace-from-a-template.md @@ -98,5 +98,5 @@ You can publish an unpublished codespace from the "Your codespaces" page on {% d ## Further reading - "[Creating a codespace for a repository](/codespaces/developing-in-codespaces/creating-a-codespace-for-a-repository)" -- "[The codespace lifecycle](/codespaces/developing-in-codespaces/the-codespace-lifecycle)" +- "[The codespace lifecycle](/codespaces/getting-started/the-codespace-lifecycle)" - "[Using source control in your codespace](/codespaces/developing-in-codespaces/using-source-control-in-your-codespace)" \ No newline at end of file diff --git a/content/codespaces/developing-in-codespaces/deleting-a-codespace.md b/content/codespaces/developing-in-codespaces/deleting-a-codespace.md index c004006e66..255f1ee23b 100644 --- a/content/codespaces/developing-in-codespaces/deleting-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/deleting-a-codespace.md @@ -130,5 +130,5 @@ For more information, click the "{% data variables.product.prodname_cli %}" tab You can also use the REST API to delete codespaces for your organization. For more information, see "[Codespaces organizations](/rest/codespaces/organizations#delete-a-codespace-from-the-organization)." ## Further reading -- "[The codespace lifecycle](/codespaces/developing-in-codespaces/the-codespace-lifecycle)" +- "[The codespace lifecycle](/codespaces/getting-started/the-codespace-lifecycle)" - "[Configuring automatic deletion of your codespaces](/codespaces/customizing-your-codespace/configuring-automatic-deletion-of-your-codespaces)" diff --git a/content/codespaces/developing-in-codespaces/index.md b/content/codespaces/developing-in-codespaces/index.md index 5fbcfac9a0..bbee3530d4 100644 --- a/content/codespaces/developing-in-codespaces/index.md +++ b/content/codespaces/developing-in-codespaces/index.md @@ -7,7 +7,6 @@ versions: topics: - Codespaces children: - - /the-codespace-lifecycle - /developing-in-a-codespace - /creating-a-codespace-for-a-repository - /creating-a-codespace-from-a-template diff --git a/content/codespaces/developing-in-codespaces/opening-an-existing-codespace.md b/content/codespaces/developing-in-codespaces/opening-an-existing-codespace.md index cc463fbc81..c9cdeb3891 100644 --- a/content/codespaces/developing-in-codespaces/opening-an-existing-codespace.md +++ b/content/codespaces/developing-in-codespaces/opening-an-existing-codespace.md @@ -18,7 +18,7 @@ shortTitle: Open an existing codespace {% endjetbrains %} -You can reopen any of your active or stopped codespaces on {% data variables.product.prodname_dotcom_the_website %}, in a JetBrains IDE, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. You can't reopen a codespace that has been deleted. For more information, see "[The codespace lifecycle](/codespaces/developing-in-codespaces/the-codespace-lifecycle)." +You can reopen any of your active or stopped codespaces on {% data variables.product.prodname_dotcom_the_website %}, in a JetBrains IDE, in {% data variables.product.prodname_vscode %}, or by using {% data variables.product.prodname_cli %}. You can't reopen a codespace that has been deleted. For more information, see "[The codespace lifecycle](/codespaces/getting-started/the-codespace-lifecycle)." You can view all your codespaces on the "Your codespaces" page at [github.com/codespaces](https://github.com/codespaces). From this page, you can: diff --git a/content/codespaces/developing-in-codespaces/stopping-and-starting-a-codespace.md b/content/codespaces/developing-in-codespaces/stopping-and-starting-a-codespace.md index e7f3fd455e..6602cce6b4 100644 --- a/content/codespaces/developing-in-codespaces/stopping-and-starting-a-codespace.md +++ b/content/codespaces/developing-in-codespaces/stopping-and-starting-a-codespace.md @@ -105,4 +105,4 @@ When you restart a codespace you can choose to open it in {% data variables.prod ## Further reading -- "[The codespace lifecycle](/codespaces/developing-in-codespaces/the-codespace-lifecycle)" +- "[The codespace lifecycle](/codespaces/getting-started/the-codespace-lifecycle)" diff --git a/content/codespaces/getting-started/deep-dive.md b/content/codespaces/getting-started/deep-dive.md index 48c9c1004b..b0e910db46 100644 --- a/content/codespaces/getting-started/deep-dive.md +++ b/content/codespaces/getting-started/deep-dive.md @@ -156,4 +156,4 @@ If you work on your codespaces in a JetBrains IDE, you can add plugins from the - "[Enabling {% data variables.product.prodname_github_codespaces %} for your organization](/codespaces/managing-codespaces-for-your-organization/enabling-github-codespaces-for-your-organization)" - "[Managing the cost of {% data variables.product.prodname_github_codespaces %} in your organization](/codespaces/managing-codespaces-for-your-organization/managing-the-cost-of-github-codespaces-in-your-organization)" - "[Add a dev container configuration to your repository](/codespaces/setting-up-your-project-for-codespaces/setting-up-your-project-for-codespaces)" -- "[The codespace lifecycle](/codespaces/developing-in-codespaces/the-codespace-lifecycle)" +- "[The codespace lifecycle](/codespaces/getting-started/the-codespace-lifecycle)" diff --git a/content/codespaces/getting-started/index.md b/content/codespaces/getting-started/index.md index 11960b51c4..4ba4ae862f 100644 --- a/content/codespaces/getting-started/index.md +++ b/content/codespaces/getting-started/index.md @@ -7,6 +7,7 @@ versions: ghec: '*' children: - /quickstart + - /the-codespace-lifecycle - /deep-dive --- diff --git a/content/codespaces/developing-in-codespaces/the-codespace-lifecycle.md b/content/codespaces/getting-started/the-codespace-lifecycle.md similarity index 99% rename from content/codespaces/developing-in-codespaces/the-codespace-lifecycle.md rename to content/codespaces/getting-started/the-codespace-lifecycle.md index 1d1af74da9..cf41e1bb83 100644 --- a/content/codespaces/developing-in-codespaces/the-codespace-lifecycle.md +++ b/content/codespaces/getting-started/the-codespace-lifecycle.md @@ -10,6 +10,7 @@ topics: - Developer redirect_from: - /codespaces/developing-in-codespaces/codespaces-lifecycle + - /codespaces/developing-in-codespaces/the-codespace-lifecycle --- ## About the lifecycle of a codespace diff --git a/content/codespaces/index.md b/content/codespaces/index.md index 87296d4009..d4db8281a8 100644 --- a/content/codespaces/index.md +++ b/content/codespaces/index.md @@ -8,7 +8,7 @@ introLinks: featuredLinks: guides: - /codespaces/managing-codespaces-for-your-organization/enabling-codespaces-for-your-organization - - /codespaces/developing-in-codespaces/the-codespace-lifecycle + - /codespaces/getting-started/the-codespace-lifecycle - /codespaces/setting-up-your-codespace/configuring-codespaces-for-your-project - /codespaces/managing-your-codespaces/managing-repository-access-for-your-codespaces - /billing/managing-billing-for-github-codespaces/about-billing-for-codespaces diff --git a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-base-image-for-codespaces.md b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-base-image-for-codespaces.md index 066c79fa3c..89f9678fcc 100644 --- a/content/codespaces/managing-codespaces-for-your-organization/restricting-the-base-image-for-codespaces.md +++ b/content/codespaces/managing-codespaces-for-your-organization/restricting-the-base-image-for-codespaces.md @@ -34,7 +34,7 @@ If the image specified in the dev container configuration does not match one of {% note %} **Notes**: -* The base image policy is only applied when a codespace is created. It is currently not applied when you rebuild a container. This will change in a future release. For more information, see "[The codespace lifecycle](/codespaces/developing-in-codespaces/the-codespace-lifecycle#rebuilding-a-codespace)." +* The base image policy is only applied when a codespace is created. It is currently not applied when you rebuild a container. This will change in a future release. For more information, see "[The codespace lifecycle](/codespaces/getting-started/the-codespace-lifecycle#rebuilding-a-codespace)." * The base image policy does not apply to the default image, or the image that's used to recover a codespace if an error is introduced into a dev container configuration which prevents the container from being rebuilt. {% endnote %} diff --git a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md index 34a57ee0e7..878abde882 100644 --- a/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md +++ b/content/education/manage-coursework-with-github-classroom/integrate-github-classroom-with-an-ide/using-github-codespaces-with-github-classroom.md @@ -99,4 +99,4 @@ Teachers can view each student's codespace for an assignment in the assignment o ![Teacher assignment overview with student's codespaces](/assets/images/help/classroom/teacher-assignment-view-with-codespaces.png) -When you connect to a codespace through a browser, auto-save is enabled automatically. If you want to save changes to the repository, you will need to commit the changes and push them to a remote branch. If you leave your codespace running without interaction for 30 minutes by default, the codespace will timeout and stop running. Your data will be preserved from the last time you made a change. For more information on the lifecycle of a codespace, see "[The codespace lifecycle](/codespaces/developing-in-codespaces/the-codespace-lifecycle)." +When you connect to a codespace through a browser, auto-save is enabled automatically. If you want to save changes to the repository, you will need to commit the changes and push them to a remote branch. If you leave your codespace running without interaction for 30 minutes by default, the codespace will timeout and stop running. Your data will be preserved from the last time you made a change. For more information on the lifecycle of a codespace, see "[The codespace lifecycle](/codespaces/getting-started/the-codespace-lifecycle)." diff --git a/data/reusables/codespaces/stopping-a-codespace.md b/data/reusables/codespaces/stopping-a-codespace.md index f6938a5972..69b2ead649 100644 --- a/data/reusables/codespaces/stopping-a-codespace.md +++ b/data/reusables/codespaces/stopping-a-codespace.md @@ -1,4 +1,4 @@ -You can stop a codespace at any time. When you stop a codespace, any running processes are stopped and the terminal history is cleared. Any saved changes in your codespace will still be available when you next start it. If you do not explicitly stop a codespace, it will continue to run until it times out from inactivity. For more information, see "[The codespace lifecycle](/codespaces/developing-in-codespaces/the-codespace-lifecycle#timeouts-for-github-codespaces)." +You can stop a codespace at any time. When you stop a codespace, any running processes are stopped and the terminal history is cleared. Any saved changes in your codespace will still be available when you next start it. If you do not explicitly stop a codespace, it will continue to run until it times out from inactivity. For more information, see "[The codespace lifecycle](/codespaces/getting-started/the-codespace-lifecycle#timeouts-for-github-codespaces)." Only running codespaces incur CPU charges. A stopped codespace incurs only storage costs.