From d57297ded1af938b7946884457d88770ccf07950 Mon Sep 17 00:00:00 2001 From: keikari <34790748+keikari@users.noreply.github.com> Date: Fri, 16 Jul 2021 22:32:05 +0300 Subject: [PATCH 1/5] Create how-to-troubleshoot-website.md General "how to report an issue". --- content/faq/how-to-troubleshoot-website.md | 39 ++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 content/faq/how-to-troubleshoot-website.md diff --git a/content/faq/how-to-troubleshoot-website.md b/content/faq/how-to-troubleshoot-website.md new file mode 100644 index 000000000..c5feb628c --- /dev/null +++ b/content/faq/how-to-troubleshoot-website.md @@ -0,0 +1,39 @@ +--- +title: Odysee.com troubleshooting +category: troubleshooting +order: 2 +--- + +# General troubleshooting +## How to gather general troubleshooting info on desktop?{#desktop} +Clear reports about problems with detailed info, help us to solve problems faster. When you want to report about issue, send email to help@odysee.com including following details: + +- What's the issue, does it show any error messages +- How to reproduce +- Link to any content issue was experienced with +- Operating system used +- Browsers tested with (If possible test with more than one browser) +- Does disabling ad blocker affect issue (mainly related to issues with site loading or trouble with video player) +- **Screenshots of the output in browser's console and network tab** (See below for how to) + +### How to find info from web developer tools? +_Note:_ The outlook of web developer tools may differ by browser, instructions should still apply for most of them. +1. On most browsers you can open web developer tools by pressing "Ctrl + Shift + i" or "Option + Shift + j". (Optionally click 3-dot menu in the top-right corner and choose "More" --> "Developer tools", this may vary slightly for each browser) +1. For better readability, move developer tools next to the browser or its own window, by clicking "3-dot menu" in the top-right corner of the developer tools and choosing "Dock to right". + ![dock-to-right](https://spee.ch/7/7171f9bebf42a12f.png) +1. While developer tools are open, reload the page and reproduce the issue. +1. Near the top, in the developer tool window, you can see row of tabs. Take screenshot of the output in "console" and "network" tabs. (Some errors/warnings here are normal) +If you have issue with the video player or with other content delivery, filter output of the network tab by "lbryplayer". +![console-network-tabs](https://spee.ch/1/e772d979c27f94e8.png) +![network-filter](https://spee.ch/f/7eff5e00ffeff411.png) + +## How to gather general troubleshooting info on mobile?{#mobile} + +It's more difficult to get error reports from mobile browsers, but providing following info is helpful to us. + +- What's the issue, does it show any error messages +- How to reproduce +- Link to any content issue was experienced with +- Device used +- Operating system and version +- Browsers tested with (If possible test with more than one browser) From a3604565a1d6c96b829df23ad30fe682fea4d647 Mon Sep 17 00:00:00 2001 From: keikari <34790748+keikari@users.noreply.github.com> Date: Tue, 20 Jul 2021 17:28:51 +0300 Subject: [PATCH 2/5] Ask to send "logs" instead of screenshots Importing logs as files when possible, may be easier than trying to take good screenshots. --- content/faq/how-to-report-an-issue.md | 47 ++++++++++++++++++++++ content/faq/how-to-troubleshoot-website.md | 39 ------------------ 2 files changed, 47 insertions(+), 39 deletions(-) create mode 100644 content/faq/how-to-report-an-issue.md delete mode 100644 content/faq/how-to-troubleshoot-website.md diff --git a/content/faq/how-to-report-an-issue.md b/content/faq/how-to-report-an-issue.md new file mode 100644 index 000000000..709152f40 --- /dev/null +++ b/content/faq/how-to-report-an-issue.md @@ -0,0 +1,47 @@ +--- +title: Odysee.com troubleshooting +category: troubleshooting +order: 2 +--- + +# General issue reporting + +Clear reports about problems with detailed info help us to solve problems faster. When you want to report about issue, send email to help@odysee.com with following details.(See [mobile](#mobile) section for mobile version of the site) + +## What to include when reporting issue on desktop version of the site? {#desktop} +- What's the issue, does it show any error messages +- How to reproduce +- Link to any content issue was experienced with +- Operating system used +- Browsers tested with (If possible test with more than one browser, this will help us to understand the cause of the issue) +- Does disabling ad blocker affect issue (Mainly related to issues with site loading or trouble with video player) +- What's your network bandwidth and where are you roughly located +- Odysee's network and console logs (Instrutctions below) **<- IMPORTANT!** + +### How to get logs from the browser's web developer tools? {#browser-logs} +1. On most browsers you can open web developer tools by pressing "Ctrl + Shift + i" or "Option + Shift + j". (Optionally click 3-dot menu in the top-right corner and choose "More" --> "Developer tools", this may vary slightly for each browser) +1. While developer tools are open, reload the page and reproduce the issue. +1. Near the top, in the developer tool window, you can see row of tabs. Choose "Console" tab. In most browser's you can right-click any message and save the console output to a file. (See screenshots belove for chrome/brave/firefox) +1. Next select "Network" tab and choose "import/save to HAR" (See screenshots belove for chrome/brave/firefox) +1. Attach the created files to the email + +Screenshots for chrome/brave +Console: +![chrome-console](https://spee.ch/c/bcd3de66da4ac40b.png) +Network: +![chrome-export-har](https://spee.ch/7/b7ff68da2cb8b616.png) + +Screenshots for firefox +Console: +![firefox-console](https://spee.ch/d/249ce9c0ac0ea8e7.png) +Network: +![firefox-export-har](https://spee.ch/b/cb5032faaf6b42ad.png) + +## What to include when reporting issue on mobile version of the site? {#mobile} +- What's the issue, does it show any error messages +- How to reproduce +- Link to any content issue was experienced with +- Device used +- Operating system and version +- Browsers tested with (If possible test with more than one browser, this will help us to understand the cause of the issue) +- What's your network bandwidth and where are you roughly located diff --git a/content/faq/how-to-troubleshoot-website.md b/content/faq/how-to-troubleshoot-website.md deleted file mode 100644 index c5feb628c..000000000 --- a/content/faq/how-to-troubleshoot-website.md +++ /dev/null @@ -1,39 +0,0 @@ ---- -title: Odysee.com troubleshooting -category: troubleshooting -order: 2 ---- - -# General troubleshooting -## How to gather general troubleshooting info on desktop?{#desktop} -Clear reports about problems with detailed info, help us to solve problems faster. When you want to report about issue, send email to help@odysee.com including following details: - -- What's the issue, does it show any error messages -- How to reproduce -- Link to any content issue was experienced with -- Operating system used -- Browsers tested with (If possible test with more than one browser) -- Does disabling ad blocker affect issue (mainly related to issues with site loading or trouble with video player) -- **Screenshots of the output in browser's console and network tab** (See below for how to) - -### How to find info from web developer tools? -_Note:_ The outlook of web developer tools may differ by browser, instructions should still apply for most of them. -1. On most browsers you can open web developer tools by pressing "Ctrl + Shift + i" or "Option + Shift + j". (Optionally click 3-dot menu in the top-right corner and choose "More" --> "Developer tools", this may vary slightly for each browser) -1. For better readability, move developer tools next to the browser or its own window, by clicking "3-dot menu" in the top-right corner of the developer tools and choosing "Dock to right". - ![dock-to-right](https://spee.ch/7/7171f9bebf42a12f.png) -1. While developer tools are open, reload the page and reproduce the issue. -1. Near the top, in the developer tool window, you can see row of tabs. Take screenshot of the output in "console" and "network" tabs. (Some errors/warnings here are normal) -If you have issue with the video player or with other content delivery, filter output of the network tab by "lbryplayer". -![console-network-tabs](https://spee.ch/1/e772d979c27f94e8.png) -![network-filter](https://spee.ch/f/7eff5e00ffeff411.png) - -## How to gather general troubleshooting info on mobile?{#mobile} - -It's more difficult to get error reports from mobile browsers, but providing following info is helpful to us. - -- What's the issue, does it show any error messages -- How to reproduce -- Link to any content issue was experienced with -- Device used -- Operating system and version -- Browsers tested with (If possible test with more than one browser) From 34f925121922ab8d176547a93c4b73be7a30195c Mon Sep 17 00:00:00 2001 From: keikari <34790748+keikari@users.noreply.github.com> Date: Tue, 20 Jul 2021 17:32:07 +0300 Subject: [PATCH 3/5] Changed title --- content/faq/how-to-report-an-issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/faq/how-to-report-an-issue.md b/content/faq/how-to-report-an-issue.md index 709152f40..af50251e3 100644 --- a/content/faq/how-to-report-an-issue.md +++ b/content/faq/how-to-report-an-issue.md @@ -1,5 +1,5 @@ --- -title: Odysee.com troubleshooting +title: How to report an issue on Odysee.com category: troubleshooting order: 2 --- From cc050b0c3282c142b720f1a47f8650473a4ebb4c Mon Sep 17 00:00:00 2001 From: keikari <34790748+keikari@users.noreply.github.com> Date: Tue, 20 Jul 2021 17:37:14 +0300 Subject: [PATCH 4/5] Typo --- content/faq/how-to-report-an-issue.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/faq/how-to-report-an-issue.md b/content/faq/how-to-report-an-issue.md index af50251e3..6924da6e2 100644 --- a/content/faq/how-to-report-an-issue.md +++ b/content/faq/how-to-report-an-issue.md @@ -22,7 +22,7 @@ Clear reports about problems with detailed info help us to solve problems faster 1. On most browsers you can open web developer tools by pressing "Ctrl + Shift + i" or "Option + Shift + j". (Optionally click 3-dot menu in the top-right corner and choose "More" --> "Developer tools", this may vary slightly for each browser) 1. While developer tools are open, reload the page and reproduce the issue. 1. Near the top, in the developer tool window, you can see row of tabs. Choose "Console" tab. In most browser's you can right-click any message and save the console output to a file. (See screenshots belove for chrome/brave/firefox) -1. Next select "Network" tab and choose "import/save to HAR" (See screenshots belove for chrome/brave/firefox) +1. Next select "Network" tab and choose "export/save to HAR" (See screenshots belove for chrome/brave/firefox) 1. Attach the created files to the email Screenshots for chrome/brave From 1c91e3a1c6d4c0b6085e0ab4f7296b4456d44deb Mon Sep 17 00:00:00 2001 From: keikari <34790748+keikari@users.noreply.github.com> Date: Wed, 21 Jul 2021 02:09:55 +0300 Subject: [PATCH 5/5] Added instruction: Filter network tab output by "XHR" when exporting Seems like it will make small files, but still likely to have the useful info. --- content/faq/how-to-report-an-issue.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/content/faq/how-to-report-an-issue.md b/content/faq/how-to-report-an-issue.md index 6924da6e2..54bb35c6f 100644 --- a/content/faq/how-to-report-an-issue.md +++ b/content/faq/how-to-report-an-issue.md @@ -22,20 +22,21 @@ Clear reports about problems with detailed info help us to solve problems faster 1. On most browsers you can open web developer tools by pressing "Ctrl + Shift + i" or "Option + Shift + j". (Optionally click 3-dot menu in the top-right corner and choose "More" --> "Developer tools", this may vary slightly for each browser) 1. While developer tools are open, reload the page and reproduce the issue. 1. Near the top, in the developer tool window, you can see row of tabs. Choose "Console" tab. In most browser's you can right-click any message and save the console output to a file. (See screenshots belove for chrome/brave/firefox) -1. Next select "Network" tab and choose "export/save to HAR" (See screenshots belove for chrome/brave/firefox) +1. Next select "Network" tab, make sure that you set filtering to "XHR" and choose "export/save to HAR" (See screenshots belove for chrome/brave/firefox) +_Note_: Don't let videos play while the dev tools are open, exporting output in "network" tab will create an un-necessary large file. 1. Attach the created files to the email Screenshots for chrome/brave Console: ![chrome-console](https://spee.ch/c/bcd3de66da4ac40b.png) Network: -![chrome-export-har](https://spee.ch/7/b7ff68da2cb8b616.png) +![chrome-export-har](https://spee.ch/1/a01e1b428ab85344.png) Screenshots for firefox Console: ![firefox-console](https://spee.ch/d/249ce9c0ac0ea8e7.png) Network: -![firefox-export-har](https://spee.ch/b/cb5032faaf6b42ad.png) +![firefox-export-har](https://spee.ch/b/cc6c5a91740c544a.png) ## What to include when reporting issue on mobile version of the site? {#mobile} - What's the issue, does it show any error messages