diff --git a/Troubleshooting-issues-with-samples.md b/Troubleshooting-issues-with-samples.md index 944bb19..5f977a6 100644 --- a/Troubleshooting-issues-with-samples.md +++ b/Troubleshooting-issues-with-samples.md @@ -4,7 +4,7 @@ This article should help you resolve the majority of issues, starting with the m Once you have performed the steps in this article, you can proceed with creating an issue -- but make sure to read [how to create good issues](How-to-create-good-issues) first, because the people who support these samples are all volunteers, and we certainly want to be respectful of their time, *don't we*? -Items marked with a :link: can be found in the [useful links](#useful-links) section. +Items marked with a :link: can be found on this page. ![Troubleshooting](./assets/troubleshooting1.svg) @@ -12,23 +12,9 @@ Items marked with a :link: can be found in the [useful links](#useful-links) sec Please note that warnings will rarely prevent the solution from working; We only worry about errors. -```mermaid -graph TD - A([Run npm install]) - A --> B{Errors?} - B --> |No| Z([Try gulp build]) - B --> |Yes| C{Are you in root of project?} --> |No| D["Change directory to root of project #128279;"] --> |Retry|A - C --> |Yes| E{Running on Windows?} - E --> |Yes| F{Path too long?} --> |Yes| H[Move project to shorter path] --> |Retry|A - E --> |No| K["Run spfx doctor #128279;"] - K --> J{Any reported issues?} --> |Yes| L[Fix compatibility issues] --> |Retry|A - K --> |No| M{Did you change
versions of nodejs
after downloading sample?} --> |Yes| N[Run npm rebuild node-sass] --> |Retry|A - M --> |No| O(["Before you open a new issue #128279;"]) - click K "https://github.com/pnp/sp-dev-fx-webparts/wiki/Troubleshooting-issues-with-samples#run-spfx-doctor" - click D "https://github.com/pnp/sp-dev-fx-webparts/wiki/Troubleshooting-issues-with-samples#change-directory-to-root-of-project" - click O "https://github.com/pnp/sp-dev-fx-webparts/wiki/Before-you-open-an-issue" - style A fill:#2da44e,color:#fff,stroke:#1b1f2426 -``` +Items marked with a :link: can be found on this page. + +![Troubleshooting npm install](./assets/troubleshooting2.svg) ### Change directory to root of project diff --git a/assets/troubleshooting2.svg b/assets/troubleshooting2.svg new file mode 100644 index 0000000..f77fa9e --- /dev/null +++ b/assets/troubleshooting2.svg @@ -0,0 +1,1262 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+
+
+ + + + +
No +
+
+
+
+ + + + +
Yes +
+
+
+
+ + + + +
No +
+
+
+
+ + + + +
Retry +
+
+
+
+ + + + +
Yes +
+
+
+
+ + + + +
Yes +
+
+
+
+ + + + +
Yes +
+
+
+
+ + + + +
Retry +
+
+
+
+ + + + +
No +
+
+
+
+ + + + +
+
+
+
+
+ + + + +
Yes +
+
+
+
+ + + + +
Retry +
+
+
+
+ + + + +
No +
+
+
+
+ + + + +
Yes +
+
+
+
+ + + + +
Retry +
+
+
+
+ + + + +
No +
+
+
+
+
+ + + + + + +
Run npm install
+
+
+
+
+ + + + + +
Errors?
+
+
+
+
+ + + + + +
Try gulp build
+
+
+
+
+ + + + + +
Are you in root of project? +
+
+
+
+
+ + + + + +
Change directory to root of + project 🔗
+
+
+
+
+ + + + + +
Running on Windows?
+
+
+
+
+ + + + + +
Path too long?
+
+
+
+
+ + + + + +
Move project to shorter path +
+
+
+
+
+ + + + + + +
Run spfx doctor 🔗
+
+
+
+
+ + + + + +
Any reported issues?
+
+
+
+
+ + + + + +
Fix compatibility issues
+
+
+
+
+ + + + + +
Did you change
versions of + nodejs
after downloading sample?
+
+
+
+
+ + + + + +
Run npm rebuild node-sass
+
+
+
+
+ + + + + +
Before you open a new issue + 🔗
+
+
+
+
+
+
+
+
\ No newline at end of file diff --git a/troubleshooting2.mmd b/troubleshooting2.mmd new file mode 100644 index 0000000..762df22 --- /dev/null +++ b/troubleshooting2.mmd @@ -0,0 +1,15 @@ +graph TD + A([Run npm install]) + A --> B{Errors?} + B --> |No| Z([Try gulp build]) + B --> |Yes| C{Are you in root of project?} --> |No| D["Change directory to root of project #128279;"] --> |Retry|A + C --> |Yes| E{Running on Windows?} + E --> |Yes| F{Path too long?} --> |Yes| H[Move project to shorter path] --> |Retry|A + E --> |No| K["Run spfx doctor #128279;"] + K --> J{Any reported issues?} --> |Yes| L[Fix compatibility issues] --> |Retry|A + K --> |No| M{Did you change
versions of nodejs
after downloading sample?} --> |Yes| N[Run npm rebuild node-sass] --> |Retry|A + M --> |No| O(["Before you open a new issue #128279;"]) + click K "https://github.com/pnp/sp-dev-fx-webparts/wiki/Troubleshooting-issues-with-samples#run-spfx-doctor" + click D "https://github.com/pnp/sp-dev-fx-webparts/wiki/Troubleshooting-issues-with-samples#change-directory-to-root-of-project" + click O "https://github.com/pnp/sp-dev-fx-webparts/wiki/Before-you-open-an-issue" + style A fill:#2da44e,color:#fff,stroke:#1b1f2426 \ No newline at end of file