diff --git a/README.md b/README.md index a8e54c5..40a14c4 100644 --- a/README.md +++ b/README.md @@ -6,8 +6,12 @@ Welcome to a custom **Copilot** workshop prepared by the **GitHub’s Expert Ser This workshop involves several technology stacks, therefore it is essential that you need to meet prerequisites as outlined in the prerequisites getting started if you want to follow along. Otherwise, please follow along and listen to the GitHub Expert Service team's instructor demo to see how it works in practice. -> :blue_book: **NOTE**: This workshop will be conducted through **Codespace**, but you can find a full step-by-step self-paced guide that you can try later without Codespace: -[**gh.io/octofit-tutorial**](https://gh.io/octofit-tutorial) +If you want to checkout this tutorial later after the workshop, please click on the links below: + +[gh.io/octofit-tutorial-codespace](https://gh.io/octofit-tutorial-codespace) + +> **NOTE**: This workshop will be conducted through **Codespace**, but you can find a full step-by-step self-paced guide that you can try later without Codespace: +[**gh.io/octofit-tutorial - Coming Soon!**](https://gh.io/octofit-tutorial) ## Objectives and key takeaways diff --git a/docs/1_Story/README.md b/docs/1_Story/README.md index 8455904..19af09a 100644 --- a/docs/1_Story/README.md +++ b/docs/1_Story/README.md @@ -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. ### 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) diff --git a/docs/2_Prerequisites/README.md b/docs/2_Prerequisites/README.md index d74ab45..cca9bc1 100644 --- a/docs/2_Prerequisites/README.md +++ b/docs/2_Prerequisites/README.md @@ -40,4 +40,4 @@ When the codespace is created you may get the following message for the GitHub C If you ever get stuck, don't worry. Please check out the [troubleshooting guide](../9_Troubleshooting/), and GitHub Experts will be here to help you. -[:arrow_backward: Previous: The OctoFit Tracker app story](../1_Story/README.md) | [Next: Getting started - app frontend and backend creation :arrow_forward:](../3_GettingStarted/README.md) +[Previous: The OctoFit Tracker app story](../1_Story/README.md) | [Next: Getting started - app frontend and backend creation](../3_GettingStarted/README.md) diff --git a/docs/3_GettingStarted/README.md b/docs/3_GettingStarted/README.md index 5069dc9..37398b9 100644 --- a/docs/3_GettingStarted/README.md +++ b/docs/3_GettingStarted/README.md @@ -102,4 +102,4 @@ sudo service mongodb start sudo service mongodb status ``` -[:arrow_backward: Previous: Prerequisites and development environment setup](../2_Prerequisites/README.md) | [Next: Let's work on front end stuff :arrow_forward:](../4_FrontEndWork/README.md) \ No newline at end of file +[Previous: Prerequisites and development environment setup](../2_Prerequisites/README.md) | [Next: Let's work on front end stuff](../4_FrontEndWork/README.md) \ No newline at end of file diff --git a/docs/4_FrontEndWork/README.md b/docs/4_FrontEndWork/README.md index d84a0ff..d723580 100644 --- a/docs/4_FrontEndWork/README.md +++ b/docs/4_FrontEndWork/README.md @@ -154,4 +154,4 @@ npm start Check the browser at the port `8080` to see the changes. -[:arrow_backward: Previous: Getting started - app frontend and backend creation](../3_GettingStarted/README.md) | [Next: The OctoFit Tracker database and app backend creation :arrow_forward:](../5_BackendSettings/README.md) \ No newline at end of file +[Previous: Getting started - app frontend and backend creation](../3_GettingStarted/README.md) | [Next: The OctoFit Tracker database and app backend creation](../5_BackendSettings/README.md) \ No newline at end of file diff --git a/docs/5_BackendSettings/README.md b/docs/5_BackendSettings/README.md index 2d7e85e..5b8d24e 100644 --- a/docs/5_BackendSettings/README.md +++ b/docs/5_BackendSettings/README.md @@ -249,4 +249,4 @@ urlpatterns = [ #file - Choose a file in the workspace ``` -[:arrow_backward: Previous: Let's work on front end](../4_FrontEndWork/README.md) | [Next: Populate the database with sample data :arrow_forward:](../6_PopulateDBwData/README.md) +[Previous: Let's work on front end](../4_FrontEndWork/README.md) | [Next: Populate the database with sample data](../6_PopulateDBwData/README.md) diff --git a/docs/6_PopulateDBwData/README.md b/docs/6_PopulateDBwData/README.md index 19e518f..e28b5b7 100644 --- a/docs/6_PopulateDBwData/README.md +++ b/docs/6_PopulateDBwData/README.md @@ -173,4 +173,4 @@ python manage.py populate_db #file - Choose a file in the workspace ``` -[:arrow_backward: Previous: The OctoFit Tracker database and app backend creation](../5_BackendSettings/README.md) | [Next: Using the Codespace endpoint to access the Django REST Framework :arrow_forward:](../7_CodespaceDjangoRESTFramework/README.md) \ No newline at end of file +[Previous: The OctoFit Tracker database and app backend creation](../5_BackendSettings/README.md) | [Next: Using the Codespace endpoint to access the Django REST Framework](../7_CodespaceDjangoRESTFramework/README.md) \ No newline at end of file diff --git a/docs/7_CodespaceDjangoRESTFramework/README.md b/docs/7_CodespaceDjangoRESTFramework/README.md index c880d5e..2582399 100644 --- a/docs/7_CodespaceDjangoRESTFramework/README.md +++ b/docs/7_CodespaceDjangoRESTFramework/README.md @@ -110,4 +110,4 @@ python manage.py runserver #file - Choose a file in the workspace ``` -[:arrow_backward: Previous: Populate DB data](../6_PopulateDBwData) | [Next: What's next :arrow_forward:](../8_WhatsNext/README.md) \ No newline at end of file +[Previous: Populate DB data](../6_PopulateDBwData) | [Next: What's next](../8_WhatsNext/README.md) \ No newline at end of file diff --git a/docs/8_WhatsNext/README.md b/docs/8_WhatsNext/README.md index fc1f61f..46d9dee 100644 --- a/docs/8_WhatsNext/README.md +++ b/docs/8_WhatsNext/README.md @@ -4,16 +4,27 @@ You made it this far! Congraulation! ![Congratulation](https://octodex.github.com/images/hula_loop_octodex03.gif) -What's next? From here, you can continue to leverage **GitHub Copilot** to finish the rest of exercises. +What's next? From here, you can continue to leverage **GitHub Copilot** to finish the rest of exercises. We could not get far as things like... + +- Connecting the front end with the REST API endpoint through Python Django backend +- Implementing the user authentication +- Activity logging API, team management, and leader board functionality +- And probably more! + +But we hope that you have learned a lot from this workshop and you can continue to build the application with **GitHub Copilot**. + +If you want to checkout this tutorial later after the workshop, please click on the links below: + +[gh.io/octofit-tutorial-codespace](https://gh.io/octofit-tutorial-codespace) Also, be sure to checkout self-paced documentation to build the application from scratch: -[**gh.io/octofit-tutorial**](https://gh.io/octofit-tutorial) +[**gh.io/octofit-tutorial - Coming Soon!**](https://gh.io/octofit-tutorial) Make sure to leave the feedback on the workshop and the documentation by following this link: -[:speech_balloon: We want to hear from you! - **github.com/orgs/community/discussions/142536**](https://github.com/orgs/community/discussions/142536) +[:speech_balloon: We want to hear from you! - **gh.io/octofit-survey**](https://gh.io/octofit-survey) Thank you again. Happy coding with **GitHub Copilot**! -[:house_with_garden: Go back to the main page](../../README.md) +[Go back to the main page](../../README.md) diff --git a/docs/9_Troubleshooting/README.md b/docs/9_Troubleshooting/README.md index 2ac96a6..b083089 100644 --- a/docs/9_Troubleshooting/README.md +++ b/docs/9_Troubleshooting/README.md @@ -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. + +
+ I am not exactly getting the same result, so I cannot proceed to the next step. What shall I do? + 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 +
+ +
+ 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 + 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. +
+ +
+ My Codespace suddenly stopped responding. What shall I do? + You can stop the Codespace and start it again. If you are still having issues, please reach out to the GitHub. +
- I am getting a different answer. What do I do? - Please check the section where you can copy-and-paste the code if you want to follow along. + 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? + 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.
-## 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. + +
+ How can I leave the feedback for the workshop or this resource? + 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 +
How can I enable Copilot? - 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.
+
+ Why is this not utilizing Copilot Worspace? + 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. +
+
+ Would I have a same experience if I try this through an IDE? + 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. +
+
+ How can I learn about or reach out about GitHub Expert Service? + Please visit the following website to find out more about GitHub Expert Service: https://github.com/services +