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

Update GitHub Codespaces instructions for S2L5 #85

Merged
merged 2 commits into from
Apr 4, 2024

Conversation

ariyonaty
Copy link
Contributor

Summary

Hello Maintainers!

First and foremost, thank you for Secure Code Game. It was a blast, learned a ton, and love the idea and motivation behind it.

This PR fixes and enhances a documentation issue for Season 2, Level 5 for Codespace users. While current documentation provides instructions for index.html, it is lacking for code.js, which is required. See Issue #84 for additional context.

This PR pivots the solution slightly by proposing changes which achieve same outcome for Codespace users without having to pull/copy files locally.

Changes

BLUF: Leverage Python http.server to serve directory via Codespace.

Rather than copy both index.html and code.js to local environments, documentation updated to run simple HTTP web server within the codespace and allow user to remain within the same environment.

Screenshot verifying expected behavior:
image
image

Additional change - ensure character encoding set to utf-8 to avoid issue with rendering the dollar-sign graphics.
Before/After screenshot:
image

Closes: #84

Task list

  • For workflow changes, I have verified the Actions workflows function as expected.
  • For content changes, I have reviewed the style guide.

@jkcso jkcso self-assigned this Apr 4, 2024
@jkcso jkcso merged commit e975b5d into skills:main Apr 4, 2024
4 checks passed
@ariyonaty ariyonaty deleted the fix/s2l5-patch branch April 4, 2024 20:11
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.

[Bug] Season 2 ; Level 5 - Incomplete documentation for Codespace users.
2 participants