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

VS Code Settings Update / Frontend Debug Documentation #4346

Merged
merged 4 commits into from Oct 10, 2019

Conversation

@nickytonline
Copy link
Member

nickytonline commented Oct 10, 2019

What type of PR is this? (check all applicable)

  • Refactor
  • Feature
  • Bug Fix
  • Documentation Update

Description

This PR adds a section to the frontend documentation for debugging. It also includes a debug configuration for Edge for VS Code.

I am happy to change the wording if necessary or feel free to commit a change directly to this PR.

Related Tickets & Documents

Mobile & Desktop Screenshots/Recordings (if there are UI changes)

Added to documentation?

  • docs.dev.to
  • readme
  • no documentation needed

[optional] What gif best describes this PR or how it makes you feel?

Hackerman

@pr-triage pr-triage bot added the PR: unreviewed label Oct 10, 2019
@@ -4,6 +4,7 @@
"esbenp.prettier-vscode",
"donjayamanne.git-extension-pack",
"msjsdiag.debugger-for-chrome",
"msjsdiag.debugger-for-edge",

This comment has been minimized.

Copy link
@nickytonline

nickytonline Oct 10, 2019

Author Member

This proposes to a developer when they open Visual Studio Code if they would like to install the Edge Debugger.

"type": "edge",
"request": "attach",
"name": "Attach to Edge",
"port": 2015,

This comment has been minimized.

Copy link
@nickytonline

nickytonline Oct 10, 2019

Author Member

This is the default port that the configuration generated. There's no rhyme or reason for that particular port. If someone prefers another one, feel free to suggest the best port. 😉

@@ -0,0 +1,27 @@
---

This comment has been minimized.

Copy link
@nickytonline

nickytonline Oct 10, 2019

Author Member

I followed how the other docs are written, so I'm assuming this will generate the documentation correctly. I did not see a script to generate this on my local.

This comment has been minimized.

Copy link
@nickytonline

nickytonline Oct 10, 2019

Author Member

Found the docs for building documentation locally, https://docs.dev.to/contributing/

@@ -4,6 +4,7 @@
"esbenp.prettier-vscode",

This comment has been minimized.

Copy link
@nickytonline

nickytonline Oct 10, 2019

Author Member

There is a Firefox debugger extension for VS Code, but I have omitted for the time being because I was unable to get it running on my Mac. I will probably take a stab at this again when I have a little more time.

@@ -5,6 +5,7 @@ items:
- webpacker.md
- preact.md
- liquid-tags.md
- debugging.md

This comment has been minimized.

Copy link
@nickytonline

nickytonline Oct 10, 2019

Author Member

After I added this, I checked the Netlify preview for the documentation and it all looks good.

image

@rhymes rhymes requested a review from jacobherrington Oct 10, 2019
Copy link
Contributor

jacobherrington left a comment

This looks great @nickytonline! Thanks for making a PR to improve the docs 🤠

Happy Hacktoberfest! 🎃

@benhalpern benhalpern merged commit cc7a3f6 into thepracticaldev:master Oct 10, 2019
8 checks passed
8 checks passed
Gitpod Open an online workspace in Gitpod
Details
Travis CI - Pull Request Build Passed
Details
WIP Ready for review
Details
codeclimate All good!
Details
codeclimate/diff-coverage 100% (50% threshold)
Details
codeclimate/total-coverage 91%
Details
deploy/netlify Deploy preview ready!
Details
license/cla Contributor License Agreement is signed.
Details
@nickytonline nickytonline deleted the nickytonline:vscode-settings-update branch Oct 10, 2019
RakChamp25 added a commit to RakChamp25/dev.to that referenced this pull request Oct 15, 2019
…ev#4346)

* Added Edge debug configuration for VS Code.

* Added frontend debug documentation.

* Some copy updates.

* Added the debugging docs to the TOC.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.