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
Merged

VS Code Settings Update / Frontend Debug Documentation #4346

merged 4 commits into from
Oct 10, 2019

Conversation

nickytonline
Copy link
Contributor

@nickytonline 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 bot applied label for PR's with no review label Oct 10, 2019
@@ -4,6 +4,7 @@
"esbenp.prettier-vscode",
"donjayamanne.git-extension-pack",
"msjsdiag.debugger-for-chrome",
"msjsdiag.debugger-for-edge",
Copy link
Contributor Author

@nickytonline nickytonline Oct 10, 2019

Choose a reason for hiding this comment

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

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,
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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 @@
---
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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.

Copy link
Contributor Author

@nickytonline nickytonline Oct 10, 2019

Choose a reason for hiding this comment

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

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

@@ -4,6 +4,7 @@
"esbenp.prettier-vscode",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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
Copy link
Contributor Author

Choose a reason for hiding this comment

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

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

image

Copy link
Contributor

@jacobherrington jacobherrington left a comment

Choose a reason for hiding this comment

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

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

Happy Hacktoberfest! 🎃

@pr-triage pr-triage bot added PR: reviewed-approved bot applied label for PR's where reviewer approves changes and removed PR: unreviewed bot applied label for PR's with no review labels Oct 10, 2019
@benhalpern benhalpern merged commit cc7a3f6 into forem:master Oct 10, 2019
@pr-triage pr-triage bot added PR: merged bot applied label for PR's that are merged and removed PR: reviewed-approved bot applied label for PR's where reviewer approves changes labels Oct 10, 2019
@nickytonline nickytonline deleted the vscode-settings-update branch October 10, 2019 17:13
RakChamp25 pushed a commit to RakChamp25/dev.to that referenced this pull request Oct 15, 2019
* 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
Labels
PR: merged bot applied label for PR's that are merged
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants