Skip to content
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
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Conversation

bryantson
Copy link
Contributor

Updated the troubleshooting guide to add more relevant context

This pull request enhances the troubleshooting and FAQ sections in the docs/9_Troubleshooting/README.md file for the workshop. The changes include adding more detailed troubleshooting steps and expanding the FAQ section to cover additional common questions.

@bryantson bryantson requested a review from arilivigni October 30, 2024 03:46
Copy link
Collaborator

@arilivigni arilivigni left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like it all but the pointing to the tutorial especially since there is nothing to point atm that is any different than what it points to today.

Can we remove that for now and discuss to add after the sandbox session?

[**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)
Copy link
Collaborator

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

Copy link
Contributor Author

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.

@@ -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.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same comment as above

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants