From 5f1cacf09377340c3e31ac8289470dab2d05dcbe Mon Sep 17 00:00:00 2001 From: Bradley Hilton Date: Fri, 26 Feb 2021 14:38:55 -0600 Subject: [PATCH] Add targets to most of the doc links (#50) * Add targets to most of the doc links. Should fix #49 * Prettified Code! Co-authored-by: graywolf336 --- .../config/edit-instance-details.tsx | 16 +++++-- web/components/config/edit-page-content.tsx | 9 +++- web/components/config/video-latency.tsx | 8 +++- web/components/config/video-variant-form.tsx | 42 +++++++++++++++---- web/components/main-layout.tsx | 4 +- web/pages/access-tokens.tsx | 9 +++- web/pages/config-public-details.tsx | 4 +- web/pages/config-storage.tsx | 5 ++- web/pages/config-video.tsx | 8 ++-- web/pages/help.tsx | 9 +++- web/pages/offline-notice.tsx | 8 +++- web/pages/webhooks.tsx | 9 +++- 12 files changed, 108 insertions(+), 23 deletions(-) diff --git a/web/components/config/edit-instance-details.tsx b/web/components/config/edit-instance-details.tsx index b258d8a04..4c794d1d6 100644 --- a/web/components/config/edit-instance-details.tsx +++ b/web/components/config/edit-instance-details.tsx @@ -104,15 +104,25 @@ export default function EditInstanceDetails() { initialValue={instanceDetails.logo} onChange={handleFieldChange} /> - {instanceDetails.logo && uploaded logo} + {instanceDetails.logo && uploaded logo}

Increase your audience by appearing in the{' '} Owncast Directory - . This is an external service run by the Owncast project. Learn more. - {!yp.instanceUrl &&


You must set your server URL above to enable the directory.
} + + . This is an external service run by the Owncast project.{' '} + + Learn more + + . + {!yp.instanceUrl && ( +
+
+ You must set your server URL above to enable the directory. +
+ )}

diff --git a/web/components/config/edit-page-content.tsx b/web/components/config/edit-page-content.tsx index 0f07b45cf..4e2c005ab 100644 --- a/web/components/config/edit-page-content.tsx +++ b/web/components/config/edit-page-content.tsx @@ -91,7 +91,14 @@ export default function EditPageContent() {

Edit the content of your page by using simple{' '} - Markdown syntax. + + Markdown syntax + + .

For interactive live streams you may want to experiment with a lower latency, for non-interactive broadcasts you may want to increase it.{' '} - Read to learn more. + + Read to learn more. +

diff --git a/web/components/config/video-variant-form.tsx b/web/components/config/video-variant-form.tsx index 2ac63ebd0..a8550f91e 100644 --- a/web/components/config/video-variant-form.tsx +++ b/web/components/config/video-variant-form.tsx @@ -173,8 +173,10 @@ export default function VideoVariantForm({ return (

- Learn more about how each of these settings - can impact the performance of your server. + + Learn more + {' '} + about how each of these settings can impact the performance of your server.

@@ -187,7 +189,13 @@ export default function VideoVariantForm({ disabled={dataState.videoPassthrough} />

- Read more about CPU usage. + + Read more about CPU usage. +

@@ -216,7 +224,13 @@ export default function VideoVariantForm({

{selectedVideoBRnote()}

- Read more about bitrates. + + Read more about bitrates. +

@@ -231,7 +245,11 @@ export default function VideoVariantForm({ Resizing your content will take additional resources on your server. If you wish to optionally resize your content for this stream output then you should either set the width or the height to keep your aspect ratio.{' '} - + Read more about resolutions.

@@ -266,7 +284,11 @@ export default function VideoVariantForm({ used.

- + Read the documentation before enabling, as it impacts your stream.

@@ -314,7 +336,13 @@ export default function VideoVariantForm({

{selectedFramerateNote()}

- Read more about framerates. + + Read more about framerates. +

diff --git a/web/components/main-layout.tsx b/web/components/main-layout.tsx index aed1b1f23..57f0b01a3 100644 --- a/web/components/main-layout.tsx +++ b/web/components/main-layout.tsx @@ -204,7 +204,9 @@ export default function MainLayout(props) { {children} diff --git a/web/pages/access-tokens.tsx b/web/pages/access-tokens.tsx index adc2447a1..d6f82f1d6 100644 --- a/web/pages/access-tokens.tsx +++ b/web/pages/access-tokens.tsx @@ -220,7 +220,14 @@ export default function AccessTokens() { Read more about how to use these tokens, with examples, at{' '} - our documentation. + + our documentation + + . diff --git a/web/pages/config-public-details.tsx b/web/pages/config-public-details.tsx index f6b6896e1..6a813f501 100644 --- a/web/pages/config-public-details.tsx +++ b/web/pages/config-public-details.tsx @@ -14,7 +14,9 @@ export default function PublicFacingDetails() { General Settings

The following are displayed on your site to describe your stream and its content.{' '} - Learn more. + + Learn more. +

diff --git a/web/pages/config-storage.tsx b/web/pages/config-storage.tsx index 958115040..fb57d2b4f 100644 --- a/web/pages/config-storage.tsx +++ b/web/pages/config-storage.tsx @@ -11,7 +11,10 @@ export default function ConfigStorageInfo() {

Owncast supports optionally using external storage providers to distribute your video. Learn more about this by visiting our{' '} - Storage Documentation. + + Storage Documentation + + .

Configuring this incorrectly will likely cause your video to be unplayable. Double check the diff --git a/web/pages/config-video.tsx b/web/pages/config-video.tsx index a62bfb936..664a084cf 100644 --- a/web/pages/config-video.tsx +++ b/web/pages/config-video.tsx @@ -12,9 +12,11 @@ export default function ConfigVideoSettings() { Video configuration

Before changing your video configuration{' '} - visit the video documentation to learn how - it impacts your stream performance. The general rule is to start conservatively by having - one middle quality stream output variant and experiment with adding more of varied + + visit the video documentation + {' '} + to learn how it impacts your stream performance. The general rule is to start conservatively + by having one middle quality stream output variant and experiment with adding more of varied qualities.

diff --git a/web/pages/help.tsx b/web/pages/help.tsx index 5aac7875c..380e8423a 100644 --- a/web/pages/help.tsx +++ b/web/pages/help.tsx @@ -121,7 +121,14 @@ export default function Help() { {' '} FAQ {' '} - or exist in our discussions + or exist in our{' '} + + discussions +
), }, diff --git a/web/pages/offline-notice.tsx b/web/pages/offline-notice.tsx index 2c2f6da97..efe18d07e 100644 --- a/web/pages/offline-notice.tsx +++ b/web/pages/offline-notice.tsx @@ -19,7 +19,11 @@ export default function Offline({ logs = [], config }) { title: 'Use your broadcasting software', content: (
- + Learn how to point your existing software to your new server and start streaming your content. @@ -36,7 +40,7 @@ export default function Offline({ logs = [], config }) { title: 'Embed your video onto other sites', content: (
- + Learn how you can add your Owncast stream to other sites you control.
diff --git a/web/pages/webhooks.tsx b/web/pages/webhooks.tsx index 9cd3e0c91..25d85e10a 100644 --- a/web/pages/webhooks.tsx +++ b/web/pages/webhooks.tsx @@ -196,7 +196,14 @@ export default function Webhooks() { Read more about how to use webhooks, with examples, at{' '} - our documentation. + + our documentation + + .