docs: improve feature description

This commit is contained in:
Carlos Valente
2025-07-18 21:46:22 +02:00
committed by Carlos Valente
parent 93b2a1aece
commit ef906f43d7
4 changed files with 21 additions and 15 deletions
@@ -28,7 +28,7 @@ export default function AboutPanel() {
<ExternalLink href={buyMeACoffeeUrl}>Buy Me a Coffee</ExternalLink> <ExternalLink href={buyMeACoffeeUrl}>Buy Me a Coffee</ExternalLink>
</Panel.Paragraph> </Panel.Paragraph>
<Panel.Paragraph> <Panel.Paragraph>
And trying out our cloud service If you are looking for an online version of Ontime, consider trying out our cloud service
<ExternalLink href={websiteUrl}>www.getontime.no</ExternalLink> <ExternalLink href={websiteUrl}>www.getontime.no</ExternalLink>
</Panel.Paragraph> </Panel.Paragraph>
</Panel.Card> </Panel.Card>
@@ -1,6 +1,6 @@
import ExternalLink from '../../../../common/components/link/external-link/ExternalLink'; import ExternalLink from '../../../../common/components/link/external-link/ExternalLink';
import useAppVersion from '../../../../common/hooks-query/useAppVersion'; import useAppVersion from '../../../../common/hooks-query/useAppVersion';
import { appVersion } from '../../../../externals'; import { appVersion, isOntimeCloud } from '../../../../externals';
import * as Panel from '../../panel-utils/PanelUtils'; import * as Panel from '../../panel-utils/PanelUtils';
export default function AppVersion() { export default function AppVersion() {
@@ -17,13 +17,17 @@ export default function AppVersion() {
if (data.hasUpdates) { if (data.hasUpdates) {
return ( return (
<> <Panel.Paragraph>
<Panel.Paragraph>{`You are currently using Ontime version ${appVersion}.`}</Panel.Paragraph> {`You are currently using Ontime version ${appVersion}.`}
<Panel.Paragraph> <br />
{`A new version ${data.version} is available.`} <br />
<ExternalLink href={data.url}> Please visit the release page to download</ExternalLink> {`A new version ${data.version} is available.`} <br />
</Panel.Paragraph> {isOntimeCloud ? (
</> 'You can restart your stage to get the latest available version.'
) : (
<ExternalLink href={data.url}>Please visit the release page to download</ExternalLink>
)}
</Panel.Paragraph>
); );
} }
@@ -5,6 +5,7 @@ import { CustomField, CustomFieldKey } from 'ontime-types';
import { deleteCustomField, editCustomField, postCustomField } from '../../../../common/api/customFields'; import { deleteCustomField, editCustomField, postCustomField } from '../../../../common/api/customFields';
import Button from '../../../../common/components/buttons/Button'; import Button from '../../../../common/components/buttons/Button';
import Info from '../../../../common/components/info/Info'; import Info from '../../../../common/components/info/Info';
import AppLink from '../../../../common/components/link/app-link/AppLink';
import ExternalLink from '../../../../common/components/link/external-link/ExternalLink'; import ExternalLink from '../../../../common/components/link/external-link/ExternalLink';
import useCustomFields from '../../../../common/hooks-query/useCustomFields'; import useCustomFields from '../../../../common/hooks-query/useCustomFields';
import { customFieldsDocsUrl } from '../../../../externals'; import { customFieldsDocsUrl } from '../../../../externals';
@@ -60,7 +61,8 @@ export default function CustomFieldSettings() {
Custom fields allow for additional information to be added to an event. Custom fields allow for additional information to be added to an event.
<br /> <br />
<br /> <br />
This data can be used in the Automation feature by using the generated key. To use custom fields as a data source in an{' '}
<AppLink search='settings=automation__automations'>Automation</AppLink>, please note the generated key.
<ExternalLink href={customFieldsDocsUrl}>See the docs</ExternalLink> <ExternalLink href={customFieldsDocsUrl}>See the docs</ExternalLink>
</Info> </Info>
</Panel.Section> </Panel.Section>
@@ -72,7 +74,7 @@ export default function CustomFieldSettings() {
<th>Colour</th> <th>Colour</th>
<th>Type</th> <th>Type</th>
<th>Name</th> <th>Name</th>
<th>Key (used in Integrations)</th> <th>Key (used in Automations)</th>
<th /> <th />
</tr> </tr>
</thead> </thead>
@@ -6,12 +6,12 @@ const googleSheetDocsUrl = 'https://docs.getontime.no/features/import-spreadshee
export default function GSheetInfo() { export default function GSheetInfo() {
return ( return (
<Info> <Info>
Ontime allows you to synchronize your rundown with a Google Sheet. Ontime can import data from spreadsheets by: <br />
- importing the spreadsheet file in Ontime <br />
- synchronising your project with a Google Sheet
<br /> <br />
<br /> <br />
To enable this feature, you will need to generate tokens in your Google account and provide them to Ontime. To synchronise with a Google Sheet, you will need to allow Ontime to authenticate with your Google account.
<br />
Once set up, you will be able to synchronize data between Ontime and your Google Sheet. <br />
<ExternalLink href={googleSheetDocsUrl}>See the docs</ExternalLink> <ExternalLink href={googleSheetDocsUrl}>See the docs</ExternalLink>
</Info> </Info>
); );