-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add content troubleshooting #16
Open
bryantson
wants to merge
9
commits into
main
Choose a base branch
from
add-content-troubleshooting
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
817ac48
Add some more content for FAQ and troubleshooting guide
bryantson 3cedd30
Add some more content for troubleshooting guide
bryantson 11c30f4
Add some new stuff for troubleshooting guide
bryantson c22fe8d
Add some more clarity around troubleshooting guide
bryantson f912177
Added self-paced wording to coming soon
bryantson 07afa49
Added self-paced wording to coming soon
bryantson 1ab9f36
Add more context for reaching us afterward
bryantson cd28dbe
Removed GitHub emojis for pages
bryantson 511b9f0
make some change for codespace and non-codespace version
bryantson File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
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 |
---|---|---|
|
@@ -15,7 +15,7 @@ In this workshop, you'll: | |
3. Build key components of the **OctoFit Tracker** app | ||
4. Learn best practices and prompting techniques for working with **GitHub Copilot** | ||
|
||
> :blue_book: **NOTE**: Because we have only 20 minutes for the actual workshop, it is possible that we cannot complete everything. However, we will have the value of troubleshooting together, and there is also a [self-paced exercise](https://gh.io/octofit-tutorial) if you want to follow along later. | ||
> **NOTE**: Because we have only 20 minutes for the actual workshop, it is possible that we cannot complete everything. However, we will have the value of troubleshooting together. And here is [gh.io/octofit-tutorial-codespace](https://gh.io/octofit-tutorial-codespace) where you can follow along later, and there is also a non-Codespace version [self-paced exercise - Coming Soon!](https://gh.io/octofit-tutorial) if you want to follow along later. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. same comment as above |
||
|
||
### Application Features | ||
|
||
|
@@ -107,4 +107,4 @@ Join us for this exciting journey into the future of software development, where | |
|
||
In this workshop, you are going to assume to be the lead developer. You will be responsible for building the application with GitHub Copilot’s help. Good luck! | ||
|
||
[Next: Prerequisite and setup of the development environment :arrow_forward:](../2_Prerequisites/README.md) | ||
[Next: Prerequisite and setup of the development environment](../2_Prerequisites/README.md) |
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,18 +1,58 @@ | ||
# Troubleshooting guide and FAQ | ||
|
||
## Troubleshooting guide | ||
This section covers troubleshooting and frequently asked questions (FAQs) for the workshop. | ||
|
||
## Troubleshooting guide for the workshop | ||
|
||
[General troubleshooting guide](https://docs.github.com/en/copilot/using-github-copilot/troubleshooting-github-copilot) can be found here, and this more specific to the workshop. | ||
|
||
This is a list of common issues that you might encounter during the workshop. If you are stuck, please check this list. | ||
|
||
<details> | ||
<summary>I am not exactly getting the same result, so I cannot proceed to the next step. What shall I do?</summary> | ||
We put the section together at the end in a way that you can copy-and-paste the code if you want to follow along. If you are not getting the same result, please check the section where you can copy-and-paste the code. If you still cannot proceed after the workshop is over, please leave a feedback through the GitHub Discussion page: https://github.com/orgs/community/discussions/142536 | ||
</details> | ||
|
||
<details> | ||
<summary>I am getting a following error when I try to connect the front end with REST API endpoint generated with backend: Access to XMLHttpRequest has been blocked by CORS policy</summary> | ||
This is a common issue when you are trying to connect the front end with the REST API endpoint. Codespace almost exclusively through VS Code and things like port-forwarding work a lot better. Although you can follow the steps in the workshop, you might find it much easier to switch to your local environment through VS Code. If you are still having issues, please reach out to the GitHub. | ||
</details> | ||
|
||
<details> | ||
<summary>My Codespace suddenly stopped responding. What shall I do?</summary> | ||
You can stop the Codespace and start it again. If you are still having issues, please reach out to the GitHub. | ||
</details> | ||
|
||
<details> | ||
<summary>I am getting a different answer. What do I do?</summary> | ||
Please check the section where you can copy-and-paste the code if you want to follow along. | ||
<summary>I am getting a following error in the Copilot Chat: Sorry, the response matched public code so it was blocked. Please rephrase your prompt. What shall I do?</summary> | ||
This is a common issue when you are trying to get the code from the Copilot Chat. You can try to rephrase your prompt. If you are still having issues, please reach out to the GitHub. | ||
</details> | ||
|
||
## FAQs | ||
## Frequently Asked Questions (FAQs) | ||
|
||
This is a list of common questions that you might have during the workshop. If you have a question, please check this list. | ||
|
||
<details> | ||
<summary>How can I leave the feedback for the workshop or this resource?</summary> | ||
We created a GitHub Discussion page just for this! Please leave us a feedback here, and we will really appreciate: https://github.com/orgs/community/discussions/142536 | ||
</details> | ||
|
||
<details> | ||
<summary>How can I enable Copilot?</summary> | ||
For the workshop, it should be already enabled. If you need any help, please reach out to the GitHub Expert Service team. | ||
For the workshop, it should be already enabled. If you are trying on your own, please make sure that you have a Copilot license attached to your GitHub account that you are logged in with. Please visit this page to find out more: https://docs.github.com/en/copilot/about-github-copilot/subscription-plans-for-github-copilot. If you need any help, please reach out to the GitHub Expert Service team. | ||
</details> | ||
|
||
<details> | ||
<summary>Why is this not utilizing Copilot Worspace?</summary> | ||
Copilot Workspace is a new GitHub feature that helps to bootstrap a lot of boilerplate codes and generating resources within the repository. We could have started with **Copilot Workspace** but we wanted to show you how to use Copilot in a more traditional way. If you are interested in learning more about Copilot Workspace, please check out the documentation: https://docs.github.com/en/copilot/using-github-copilot/using-github-copilot-workspace. | ||
</details> | ||
|
||
<details> | ||
<summary>Would I have a same experience if I try this through an IDE?</summary> | ||
For the most part, yes. Codespace uses the same editor as Visual Studio Code, so you should have the same experience. However, there are some features that are only available in Codespace, such as the ability to run the code in the cloud. And you might encounter issue with CORS. If you are having issues, please reach out to the GitHub. | ||
</details> | ||
|
||
<details> | ||
<summary>How can I learn about or reach out about GitHub Expert Service?</summary> | ||
Please visit the following website to find out more about GitHub Expert Service: https://github.com/services | ||
</details> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I still don't think we need a separate tutorial and this ponts to the short link that already exists in our discussion https://github.com/orgs/community/discussions/142536. I feel like what we have is step by step. ex. the guy that tried to help us got to the same end result for the Django REST framework
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Even if we are doing a demo in the Codespace, it is highly likely there will be some users who cannot finish the demo using Codespace (and they might want to continue doing that way). However, for CORS issue and other things, some stuffs will be easier to work without Codespace, and some users might want to try that, hence why I think it is not a bad idea to provide a guide without Codespace. And I think redundancy does not necessarily hurt in this case but help.