-
Notifications
You must be signed in to change notification settings - Fork 734
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Supported Release Info and Upgrade Path for v1.2 (#1494) * Supported Release Info and Upgrade Path for v1.2 * Update support-release-policy.md * Update daprdocs/content/en/operations/support/support-release-policy.md Co-authored-by: Aaron Crawfis <[email protected]> * Adding K8s versions table (#1521) * Adding table of kubernetes versions * Updating intro * Fix incorrect postgresql connection string example (#1524) Co-authored-by: Aaron Crawfis <[email protected]> * Update docs on using Codespaces with Dapr repos (#1522) * Update docs on using Codespaces with Dapr repos * Move codespaces.md under the Contributing topic * Update daprdocs/content/en/contributing/codespaces.md Co-authored-by: Aaron Crawfis <[email protected]> * Fix two typos (#1526) Co-authored-by: Aaron Crawfis <[email protected]> * Update chinese content (#1527) Co-authored-by: Aaron Crawfis <[email protected]> * Updated to fix deprecated helm chart location (#1528) The `https://kubernetes-charts.storage.googleapis.com/` location is no longer used, so this change updates this, the command to install, and the missing update step that will cause the install to fail if an update was never done after adding the location. Co-authored-by: Aaron Crawfis <[email protected]> * nr_consul_typo fixed malformed yaml (#1532) Co-authored-by: Aaron Crawfis <[email protected]> Co-authored-by: Bernd Verst <[email protected]> Co-authored-by: Mark Fussell <[email protected]> Co-authored-by: Zonciu Liang <[email protected]> Co-authored-by: Simon Leet <[email protected]> Co-authored-by: Maarten Mulders <[email protected]> Co-authored-by: Newbe36524 <[email protected]> Co-authored-by: Steven Jenkins De Haro <[email protected]> Co-authored-by: Abdulaziz Elsheikh <[email protected]>
- Loading branch information
1 parent
e6de9cb
commit 2261b1c
Showing
10 changed files
with
82 additions
and
48 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
--- | ||
type: docs | ||
title: "Contributing with GitHub Codespaces" | ||
linkTitle: "GitHub Codespaces" | ||
weight: 2500 | ||
description: "How to work with Dapr repos in GitHub Codespaces" | ||
aliases: | ||
- "/developing-applications/ides/codespaces/" | ||
--- | ||
|
||
[GitHub Codespaces](https://github.com/features/codespaces) are the easiest way to get up and running for contributing to a Dapr repo. In as little as a single click, you can have an environment with all of the prerequisites ready to go in your browser. | ||
|
||
{{% alert title="Private Beta" color="warning" %}} | ||
GitHub Codespaces is currently in a private beta. Sign up [here](https://github.com/features/codespaces/signup). | ||
{{% /alert %}} | ||
|
||
## Features | ||
|
||
- **Click and Run**: Get a dedicated and sandboxed environment with all of the required frameworks and packages ready to go. | ||
- **Usage-based Billing**: Only pay for the time you spend developing in the Codespace. Environments are spun down automatically when not in use. | ||
- **Portable**: Run in your browser or in Visual Studio Code | ||
|
||
## Open a Dapr repo in a Codespace | ||
|
||
To open a Dapr repository in a Codespace simply select "Code" from the repo homepage and "Open with Codespaces": | ||
|
||
<img src="/images/codespaces-create.png" alt="Screenshot of creating a Dapr Codespace" width="300"> | ||
|
||
If you haven't already forked the repo, creating the Codespace will also create a fork for you and use it inside the Codespace. | ||
|
||
### Supported repos | ||
|
||
- [Dapr](https://github.com/dapr/dapr) | ||
- [Components-contrib](https://github.com/dapr/components-contrib) | ||
- [Python SDK](https://github.com/dapr/python-sdk) | ||
|
||
### Developing Dapr Components in a Codespace | ||
|
||
Developing a new Dapr component requires working with both the [components-contrib](https://github.com/dapr/components-contrib) and [dapr](https://github.com/dapr/dapr) repos together under the `$GOPATH` tree for testing purposes. To facilitate this, the `/go/src/github.com/dapr` folder in the components-contrib Codespace will already be set up with your fork of components-contrib, and a clone of the dapr repo as described in the [component development documentation](https://github.com/dapr/components-contrib/blob/master/docs/developing-component.md). A few things to note in this configuration: | ||
|
||
- The components-contrib and dapr repos only define Codespaces for the Linux amd64 environment at the moment. | ||
- The `/go/src/github.com/dapr/components-contrib` folder is a soft link to Codespace's default `/workspace/components-contrib` folder, so changes in one will be automatically reflected in the other. | ||
- Since the `/go/src/github.com/dapr/dapr` folder uses a clone of the official dapr repo rather than a fork, you will not be able to make a pull request from changes made in that folder directly. You can use the dapr Codespace separately for that PR, or if you would like to use the same Codespace for the dapr changes as well, you should remap the dapr repo origin to your fork in the components-contrib Codespace. For example, to use a dapr fork under `my-git-alias`: | ||
|
||
```bash | ||
cd /go/src/github.com/dapr/dapr | ||
git remote set-url origin https://github.com/my-git-alias/dapr | ||
git fetch | ||
git reset --hard | ||
``` | ||
|
||
## Related links | ||
- [GitHub documentation](https://docs.github.com/en/github/developing-online-with-codespaces/about-codespaces) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 0 additions & 32 deletions
32
daprdocs/content/en/developing-applications/ides/codespaces.md
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters