From 2dfebd79150bf7866c5456c779c9926cfdf261b0 Mon Sep 17 00:00:00 2001 From: Thilo Billerbeck Date: Tue, 29 Dec 2020 15:54:05 +0100 Subject: [PATCH 1/7] created help page, added help page to nav --- web/pages/components/main-layout.tsx | 8 ++ web/pages/help.tsx | 142 +++++++++++++++++++++++++++ 2 files changed, 150 insertions(+) create mode 100644 web/pages/help.tsx diff --git a/web/pages/components/main-layout.tsx b/web/pages/components/main-layout.tsx index 6d2f9fcaf..1139d679c 100644 --- a/web/pages/components/main-layout.tsx +++ b/web/pages/components/main-layout.tsx @@ -13,6 +13,7 @@ import { ToolOutlined, PlayCircleFilled, MinusSquareFilled, + QuestionCircleOutlined } from '@ant-design/icons'; import classNames from 'classnames'; import { upgradeVersionAvailable } from "../../utils/apis"; @@ -140,6 +141,13 @@ export default function MainLayout(props) { + } + title="Help" + > + Help + diff --git a/web/pages/help.tsx b/web/pages/help.tsx new file mode 100644 index 000000000..ba8b21f7f --- /dev/null +++ b/web/pages/help.tsx @@ -0,0 +1,142 @@ +import { Button, Card, Col, Divider, Row } from 'antd' +import Meta from 'antd/lib/card/Meta' +import Title from 'antd/lib/typography/Title' +import { + BugTwoTone, + CameraTwoTone, + DatabaseTwoTone, + DislikeTwoTone, + EditTwoTone, + FireFilled, + FireOutlined, + Html5TwoTone, + QuestionCircleFilled, + SettingTwoTone, + SlidersTwoTone, + VideoCameraTwoTone +} from '@ant-design/icons'; +import React from 'react' + +interface Props { } + +export default function Help(props: Props) { + const questions = [ + { + icon: , + title: "I want to configure my owncast instance", + content: ( +
+ Learn more +
+ ) + }, + { + icon: , + title: "I need help configuring my broadcasting software", + content: ( +
+ Learn more +
+ ) + }, + { + icon: , + title: "I want to embed my stream into another site", + content: ( +
+ Learn more +
+ ) + }, + { + icon: , + title: "I want to customize my website", + content: ( + + ) + }, + { + icon: , + title: "I want to tweak my encoding", + content: ( + + ) + }, + { + icon: , + title: "I want to offload my video to an external storage provider", + content: ( + + ) + }, + ] + + const otherResources = [ + { + icon: , + title: "I found a bug", + content: ( +
+ If you found a bug, then report it in our + Github Issues +
+ ) + } + ] + + return ( +
+ How can we help you? + + + Having issues with owncast? + + + + Having any questions about owncast? + + + + + Common tasks + + { + questions.map(question => ( + + + + + + )) + } + + + Other + + { + otherResources.map(question => ( + + + + + + )) + } + +
+ ) +} From 14c6b3bed27777c3a913b5dc8ec2c88e837b5a9b Mon Sep 17 00:00:00 2001 From: Thilo Billerbeck Date: Tue, 29 Dec 2020 17:59:30 +0100 Subject: [PATCH 2/7] updated layout --- web/pages/help.tsx | 72 +++++++++++++++++++++++++++++++++------------- 1 file changed, 52 insertions(+), 20 deletions(-) diff --git a/web/pages/help.tsx b/web/pages/help.tsx index ba8b21f7f..0d7344493 100644 --- a/web/pages/help.tsx +++ b/web/pages/help.tsx @@ -2,6 +2,10 @@ import { Button, Card, Col, Divider, Row } from 'antd' import Meta from 'antd/lib/card/Meta' import Title from 'antd/lib/typography/Title' import { + AlertOutlined, + AlertTwoTone, + ApiTwoTone, + BookOutlined, BugTwoTone, CameraTwoTone, DatabaseTwoTone, @@ -10,68 +14,71 @@ import { FireFilled, FireOutlined, Html5TwoTone, + LinkOutlined, QuestionCircleFilled, + QuestionCircleTwoTone, SettingTwoTone, SlidersTwoTone, VideoCameraTwoTone } from '@ant-design/icons'; import React from 'react' +import Text from 'antd/lib/typography/Text'; interface Props { } export default function Help(props: Props) { const questions = [ { - icon: , + icon: , title: "I want to configure my owncast instance", content: ( ) }, { - icon: , + icon: , title: "I need help configuring my broadcasting software", content: ( ) }, { - icon: , + icon: , title: "I want to embed my stream into another site", content: ( ) }, { - icon: , + icon: , title: "I want to customize my website", content: ( ) }, { - icon: , + icon: , title: "I want to tweak my encoding", content: ( ) }, { - icon: , + icon: , title: "I want to offload my video to an external storage provider", content: ( ) }, @@ -79,7 +86,7 @@ export default function Help(props: Props) { const otherResources = [ { - icon: , + icon: , title: "I found a bug", content: (
@@ -87,20 +94,45 @@ export default function Help(props: Props) { Github Issues
) + }, + { + icon: , + title: "I have a general question", + content: ( +
+ Most general questions are answered in our + FAQ +
+ ) + }, + { + icon: , + title: "I want to use the API", + content: ( +
+ You can view the API documentation for either the + latest + or + development + release. +
+ ) } ] return (
- How can we help you? + How can we help you? - - Having issues with owncast? - + + + Troubleshooting + - - Having any questions about owncast? - + + + Documentation + From 1f41441765aa0027f79e9c7d451c45afcc08cb7c Mon Sep 17 00:00:00 2001 From: Thilo Billerbeck Date: Tue, 29 Dec 2020 22:39:32 +0100 Subject: [PATCH 3/7] changed help graphics --- web/pages/help.tsx | 15 ++++----------- 1 file changed, 4 insertions(+), 11 deletions(-) diff --git a/web/pages/help.tsx b/web/pages/help.tsx index 0d7344493..20a297059 100644 --- a/web/pages/help.tsx +++ b/web/pages/help.tsx @@ -1,28 +1,21 @@ -import { Button, Card, Col, Divider, Row } from 'antd' +import { Button, Card, Col, Divider, Result, Row } from 'antd' import Meta from 'antd/lib/card/Meta' import Title from 'antd/lib/typography/Title' import { AlertOutlined, - AlertTwoTone, ApiTwoTone, BookOutlined, BugTwoTone, CameraTwoTone, DatabaseTwoTone, - DislikeTwoTone, EditTwoTone, - FireFilled, - FireOutlined, Html5TwoTone, LinkOutlined, - QuestionCircleFilled, QuestionCircleTwoTone, SettingTwoTone, SlidersTwoTone, - VideoCameraTwoTone -} from '@ant-design/icons'; +} from '@ant-design/icons' import React from 'react' -import Text from 'antd/lib/typography/Text'; interface Props { } @@ -125,12 +118,12 @@ export default function Help(props: Props) { How can we help you? - + Troubleshooting - + Documentation From fbff547bae418410b09598a9f90b957717574fb0 Mon Sep 17 00:00:00 2001 From: Thilo Billerbeck Date: Wed, 30 Dec 2020 14:31:20 +0100 Subject: [PATCH 4/7] fixed links --- web/pages/help.tsx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/web/pages/help.tsx b/web/pages/help.tsx index 20a297059..7a11fbe82 100644 --- a/web/pages/help.tsx +++ b/web/pages/help.tsx @@ -71,7 +71,7 @@ export default function Help(props: Props) { title: "I want to offload my video to an external storage provider", content: ( ) }, @@ -84,7 +84,7 @@ export default function Help(props: Props) { content: (
If you found a bug, then report it in our - Github Issues + Github Issues
) }, @@ -94,7 +94,7 @@ export default function Help(props: Props) { content: (
Most general questions are answered in our - FAQ + FAQ
) }, @@ -125,7 +125,7 @@ export default function Help(props: Props) { Documentation - + From 5a345e1d52a37a6f44e85ee1eca1ddc335a10d2e Mon Sep 17 00:00:00 2001 From: Thilo Billerbeck Date: Wed, 30 Dec 2020 14:41:29 +0100 Subject: [PATCH 5/7] open button links in new tab --- web/pages/help.tsx | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/web/pages/help.tsx b/web/pages/help.tsx index 7a11fbe82..d7589bdc9 100644 --- a/web/pages/help.tsx +++ b/web/pages/help.tsx @@ -110,7 +110,7 @@ export default function Help(props: Props) { release.
) - } + } ] return ( @@ -120,12 +120,12 @@ export default function Help(props: Props) { Troubleshooting - + Documentation - + From 470d987551b4d355ecf57b2126f23bc50648509f Mon Sep 17 00:00:00 2001 From: Thilo Billerbeck Date: Thu, 31 Dec 2020 15:14:25 +0100 Subject: [PATCH 6/7] added basic responsiveness --- web/pages/help.tsx | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/web/pages/help.tsx b/web/pages/help.tsx index d7589bdc9..0f3eefaf3 100644 --- a/web/pages/help.tsx +++ b/web/pages/help.tsx @@ -117,12 +117,12 @@ export default function Help(props: Props) {
How can we help you? - + Troubleshooting - + Documentation @@ -133,7 +133,7 @@ export default function Help(props: Props) { { questions.map(question => ( - + { otherResources.map(question => ( - + Date: Sun, 3 Jan 2021 13:58:56 +0100 Subject: [PATCH 7/7] changed some code formatting spaces for text formatting to nbsp --- web/pages/help.tsx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/web/pages/help.tsx b/web/pages/help.tsx index 0f3eefaf3..218007561 100644 --- a/web/pages/help.tsx +++ b/web/pages/help.tsx @@ -104,9 +104,9 @@ export default function Help(props: Props) { content: (
You can view the API documentation for either the - latest +  latest  or - development +  development  release.
)