owncast/web/pages/help.tsx

168 lines
6.5 KiB
TypeScript
Raw Normal View History

2020-12-29 22:39:32 +01:00
import { Button, Card, Col, Divider, Result, Row } from 'antd'
import Meta from 'antd/lib/card/Meta'
import Title from 'antd/lib/typography/Title'
import {
2020-12-29 17:59:30 +01:00
AlertOutlined,
ApiTwoTone,
BookOutlined,
BugTwoTone,
CameraTwoTone,
DatabaseTwoTone,
EditTwoTone,
Html5TwoTone,
2020-12-29 17:59:30 +01:00
LinkOutlined,
QuestionCircleTwoTone,
SettingTwoTone,
SlidersTwoTone,
2020-12-29 22:39:32 +01:00
} from '@ant-design/icons'
import React from 'react'
interface Props { }
export default function Help(props: Props) {
const questions = [
{
2020-12-29 17:59:30 +01:00
icon: <SettingTwoTone style={{ fontSize: '24px' }} />,
title: "I want to configure my owncast instance",
content: (
<div>
2020-12-29 17:59:30 +01:00
<a href="https://owncast.online/docs/configuration/" target="_blank" rel="noopener noreferrer"><LinkOutlined/> Learn more</a>
</div>
)
},
{
2020-12-29 17:59:30 +01:00
icon: <CameraTwoTone style={{ fontSize: '24px' }} />,
title: "I need help configuring my broadcasting software",
content: (
<div>
2020-12-29 17:59:30 +01:00
<a href="https://owncast.online/docs/broadcasting/" target="_blank" rel="noopener noreferrer"><LinkOutlined/> Learn more</a>
</div>
)
},
{
2020-12-29 17:59:30 +01:00
icon: <Html5TwoTone style={{ fontSize: '24px' }} />,
title: "I want to embed my stream into another site",
content: (
<div>
2020-12-29 17:59:30 +01:00
<a href="https://owncast.online/docs/embed/" target="_blank" rel="noopener noreferrer"><LinkOutlined/> Learn more</a>
</div>
)
},
{
2020-12-29 17:59:30 +01:00
icon: <EditTwoTone style={{ fontSize: '24px' }} />,
title: "I want to customize my website",
content: (
<div>
2020-12-29 17:59:30 +01:00
<a href="https://owncast.online/docs/website/" target="_blank" rel="noopener noreferrer"><LinkOutlined/> Learn more</a>
</div>
)
},
{
2020-12-29 17:59:30 +01:00
icon: <SlidersTwoTone style={{ fontSize: '24px' }} />,
title: "I want to tweak my encoding quality or performance",
content: (
<div>
2020-12-29 17:59:30 +01:00
<a href="https://owncast.online/docs/encoding/" target="_blank" rel="noopener noreferrer"><LinkOutlined/> Learn more</a>
</div>
)
},
{
2020-12-29 17:59:30 +01:00
icon: <DatabaseTwoTone style={{ fontSize: '24px' }} />,
title: "I want to offload my video to an external storage provider",
content: (
<div>
2020-12-30 14:31:20 +01:00
<a href="https://owncast.online/docs/s3/" target="_blank" rel="noopener noreferrer"><LinkOutlined/> Learn more</a>
</div>
)
},
]
const otherResources = [
{
2020-12-29 17:59:30 +01:00
icon: <BugTwoTone style={{ fontSize: '24px' }} />,
title: "I found a bug",
content: (
<div>
If you found a bug, then please
<a href="https://github.com/owncast/owncast/issues/new/choose" target="_blank" rel="noopener noreferrer"> let us know</a>
</div>
)
2020-12-29 17:59:30 +01:00
},
{
icon: <QuestionCircleTwoTone style={{ fontSize: '24px' }} />,
title: "I have a general question",
content: (
<div>
Most general questions are answered in our
<a href="https://owncast.online/docs/faq/" target="_blank" rel="noopener noreferrer"> FAQ</a> or exist in our <a href="https://github.com/owncast/owncast/discussions">discussions</a>
2020-12-29 17:59:30 +01:00
</div>
)
},
{
icon: <ApiTwoTone style={{ fontSize: '24px' }} />,
title: "I want to use the API",
content: (
<div>
You can view the API documentation for either the
<a href="https://owncast.online/api/latest" target="_blank" rel="noopener noreferrer">&nbsp;latest&nbsp;</a>
2020-12-29 17:59:30 +01:00
or
<a href="https://owncast.online/api/development" target="_blank" rel="noopener noreferrer">&nbsp;development&nbsp;</a>
2020-12-29 17:59:30 +01:00
release.
</div>
)
2020-12-30 14:41:29 +01:00
}
]
return (
<div>
2020-12-29 17:59:30 +01:00
<Title style={{textAlign: 'center'}}>How can we help you?</Title>
<Row gutter={[16, 16]} justify="space-around" align="middle">
2020-12-31 15:14:25 +01:00
<Col xs={24} lg={12} style={{textAlign: 'center'}}>
2020-12-29 22:39:32 +01:00
<Result status="500" />
2020-12-29 17:59:30 +01:00
<Title level={2}>Troubleshooting</Title>
2020-12-30 14:41:29 +01:00
<Button target="_blank" rel="noopener noreferrer" href="https://owncast.online/docs/troubleshooting/" icon={<LinkOutlined/>} type="primary">Read Troubleshoting</Button>
</Col>
2020-12-31 15:14:25 +01:00
<Col xs={24} lg={12} style={{textAlign: 'center'}}>
2020-12-29 22:39:32 +01:00
<Result status="404" />
2020-12-29 17:59:30 +01:00
<Title level={2}>Documentation</Title>
2020-12-30 14:41:29 +01:00
<Button target="_blank" rel="noopener noreferrer" href="https://owncast.online/" icon={<LinkOutlined/>} type="primary">Read the Docs</Button>
</Col>
</Row>
<Divider />
<Title level={2}>Common tasks</Title>
<Row gutter={[16, 16]}>
{
questions.map(question => (
2020-12-31 15:14:25 +01:00
<Col xs={24} lg={12}>
<Card key={question.title}>
<Meta
avatar={question.icon}
title={question.title}
description={question.content}
/>
</Card>
</Col>
))
}
</Row>
<Divider />
<Title level={2}>Other</Title>
<Row gutter={[16, 16]}>
{
otherResources.map(question => (
2020-12-31 15:14:25 +01:00
<Col xs={24} lg={12}>
<Card key={question.title}>
<Meta
avatar={question.icon}
title={question.title}
description={question.content}
/>
</Card>
</Col>
))
}
</Row>
</div>
)
}