feat: Add various content types to docusaurus (#7231)
This brings blog posts, showcase posts, and newsletter editions into the Docusaurus site. It also adds support for using TailwindCSS inside a container. So this will probably end up being the new freesewing.org site in v4.
This commit is contained in:
Joost De Cock
GitHub
parent
ef8f68bcaf
commit
469eb43c95
595 changed files with 20432 additions and 2469 deletions
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
title: Getting started with Codespaces
|
||||
order: 13
|
||||
sidebar_position: 13
|
||||
---
|
||||
|
||||
:::note
|
||||
|
|
@ -29,19 +29,22 @@ to have or use your own computer to perform this development work.
|
|||
## Accessing Codespaces
|
||||
|
||||
Access Codespaces from the GitHub website while logged in:
|
||||
|
||||
- The "Your Codespaces" page is accessed via the "Codespaces" link at the top
|
||||
of any GitHub page.
|
||||
of any GitHub page.
|
||||
- A shortcut URL is: https://github.com/codespaces
|
||||
|
||||
## Creating a codespace
|
||||
|
||||
To create a new codespace:
|
||||
|
||||
- Select the "New codespace" button at the top of the Your Codespaces page.
|
||||
- A shortcut URL is: https://github.com/codespaces/new
|
||||
|
||||
This will open a "Create a New Codespace" page.
|
||||
|
||||
On the Create a New Codespace page, select the options for your codespace:
|
||||
|
||||
- Repository -> ("`username/freesewing`" assuming that is the name of your GitHub repository)
|
||||
- Branch -> (select the branch you want to use)
|
||||
- Region -> (select the region most appropriate for you)
|
||||
|
|
@ -52,14 +55,13 @@ The Codespaces app will open in the browser window.
|
|||
The Codespaces app is basically the [Visual Studio Code][vs] app with
|
||||
Codespaces and GitHub integration built in.
|
||||
|
||||
[vs]: https://code.visualstudio.com
|
||||
|
||||
(Wait 45 seconds or so for the Codespace app to clone the repository from
|
||||
GitHub to the codespace repository and start.)
|
||||
[vs]: https://code.visualstudio.com 'Wait 45 seconds or so for the Codespace app to clone the repository from
|
||||
GitHub to the codespace repository and start.'
|
||||
|
||||
## Editing files
|
||||
|
||||
You can browse and edit files in your codespace repository from within the app:
|
||||
|
||||
- On the Activity Bar on the far left side of the page, select the
|
||||
Explorer icon.
|
||||
(The icon looks like two pages of paper.)
|
||||
|
|
@ -72,6 +74,7 @@ Auto-save is enabled by default, so any changes you make are
|
|||
automatically saved in your codespace repository.
|
||||
|
||||
To commit changes to your codespace repository:
|
||||
|
||||
- In the Activity Bar on the far left side of the page,
|
||||
select the Source Control icon.
|
||||
- In the Source Control sidebar you can see a list of changed files.
|
||||
|
|
@ -82,6 +85,7 @@ To commit changes to your codespace repository:
|
|||
|
||||
To push committed changes from your codespace repository back to your
|
||||
GitHub repository:
|
||||
|
||||
- After committing changes to your codespace repository, press the
|
||||
"Sync Changes" button to push the committed changes to your GitHub
|
||||
repository.
|
||||
|
|
@ -94,13 +98,16 @@ GitHub repository:
|
|||
In the "Terminal" panel at the bottom of the page, you can run commands.
|
||||
|
||||
To start the lab website (to view and test new designs and design changes):
|
||||
|
||||
- In the Terminal panel, run `yarn kickstart` and then `yarn lab`.
|
||||
|
||||
To start the dev or org websites (to view and test documentation changes):
|
||||
|
||||
- dev: In the Terminal panel, run `cd sites/dev` and `yarn start`.
|
||||
- org: In the Terminal panel, run `cd sites/org` and `yarn start`.
|
||||
|
||||
After the lab, dev, or org website starts:
|
||||
|
||||
- The usual `localhost:8000` port will automatically be forwarded to a custom
|
||||
URL.
|
||||
- A pop-up will appear saying that the port has been forwarded. The "Open in
|
||||
|
|
@ -122,6 +129,7 @@ However, you can make the port public so others can access it
|
|||
(or so you can access it on a different browser while not logged into GitHub).
|
||||
|
||||
To make the port public:
|
||||
|
||||
- In the Ports panel, right-click on the port and select
|
||||
Port Visibility -> Public.
|
||||
- The custom URL will be now be a publicly-accessible forwarded port.
|
||||
|
|
@ -130,6 +138,7 @@ To make the port public:
|
|||
## Starting and stopping a codespace
|
||||
|
||||
You can start and stop your codespace via the Your Codespaces page.
|
||||
|
||||
- To start: Click on the codespace name to browse to the Codespaces
|
||||
app URL for that codespace.
|
||||
(You can also right-click to copy the URL and open it in a
|
||||
|
|
@ -150,7 +159,8 @@ You can rename a codespace to make it easier to identify.
|
|||
(This will help if you have more than one codespace.)
|
||||
|
||||
To rename a codespace:
|
||||
- Go to the Your Codespaces page.
|
||||
|
||||
- Go to the Your Codespaces page.
|
||||
- Open the "..." ellipses menu next to the codespace
|
||||
and select "Rename".
|
||||
|
||||
|
|
@ -158,17 +168,18 @@ To rename a codespace:
|
|||
|
||||
You can access GitHub Settings via the user icon menu in the upper right
|
||||
corner of any GitHub page (but not on the Codespaces app page).
|
||||
|
||||
- Selecting the "Settings" menu item will open the GitHub Settings page.
|
||||
- The Codespaces settings are under "Codespaces" in the left sidebar
|
||||
on the Settings page.
|
||||
on the Settings page.
|
||||
- A shortcut URL is: https://github.com/settings/codespaces
|
||||
|
||||
|
||||
Among the Codespaces settings available are:
|
||||
|
||||
- "Default idle timeout" (how long codespaces continue to run when idle,
|
||||
before being stopped)
|
||||
before being stopped)
|
||||
- "Default retention period" (how long codespace repositories are kept
|
||||
when unused, before being deleted)
|
||||
when unused, before being deleted)
|
||||
|
||||
:::note
|
||||
Do not be confused by the other Settings icon/menu at the bottom left of the
|
||||
|
|
@ -180,11 +191,13 @@ are located.
|
|||
## Usage and Quotas
|
||||
|
||||
To check usage:
|
||||
|
||||
- Usage information is under "Billing and plans" in the left sidebar on
|
||||
the Settings page.
|
||||
- A shortcut URL is: https://github.com/settings/billing
|
||||
|
||||
About quotas:
|
||||
|
||||
- As a free account user, you have a quota of 120 core-hours of usage
|
||||
and 15 GB of storage per billing month.
|
||||
That is the total for all your codespaces combined.
|
||||
|
|
@ -209,18 +222,20 @@ Don't worry -- you won't get a bill if you exceed your quota!
|
|||
Instead, you will just be unable to start any of your codespaces
|
||||
until the start of the next billing month.
|
||||
And, if you have any work-in-progress changes that you need access to
|
||||
before then, you can export those changes to a new GitHub branch.
|
||||
before then, you can export those changes to a new GitHub branch.
|
||||
:::
|
||||
|
||||
## Deleting a codespace
|
||||
|
||||
To delete a codespace:
|
||||
|
||||
- Go to the Your Codespaces page.
|
||||
- Open the "..." ellipses menu next to the codespace
|
||||
and select "Delete".
|
||||
|
||||
:::note RELATED
|
||||
For more information, please see:
|
||||
|
||||
- [GitHub Codebases documentation](https://docs.github.com/en/codespaces).
|
||||
- [About billing for GitHub Codespaces](https://docs.github.com/en/billing/managing-billing-for-github-codespaces/about-billing-for-github-codespaces)
|
||||
:::
|
||||
:::
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue