Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(frontend): add help info in settings pages #3558

Merged
merged 1 commit into from
Jan 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion web/src/components/Settings/DataStore/DataStore.styled.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,11 @@ export const Title = styled(Typography.Title)`
`;

export const Wrapper = styled.div`
background: ${({theme}) => theme.color.white};
border-radius: 2px;
border: ${({theme}) => `1px solid ${theme.color.borderLight}`};
display: flex;
flex-direction: column;
background: ${({theme}) => theme.color.white};
`;

export const FormContainer = styled.div`
Expand Down
32 changes: 21 additions & 11 deletions web/src/components/Settings/Demo/Demo.tsx
Original file line number Diff line number Diff line change
@@ -1,20 +1,30 @@
import {OTEL_DEMO_GITHUB, POKESHOP_GITHUB} from 'constants/Common.constants';
import DocsBanner from 'components/DocsBanner';
import {DEMO_DOCUMENTATION_URL, OTEL_DEMO_GITHUB, POKESHOP_GITHUB} from 'constants/Common.constants';
import DemoForm from './DemoForm';
import * as S from '../common/Settings.styled';

const Demo = () => (
<S.Container>
<S.Title level={2}>Demo</S.Title>
<S.Description>
Tracetest has the option to enable Test examples for our{' '}
<a href={POKESHOP_GITHUB} target="_blank">
Pokeshop Demo App
</a>{' '}
or the{' '}
<a href={OTEL_DEMO_GITHUB} target="_blank">
OpenTelemetry Astronomy Shop Demo
</a>
. You will require an instance of those applications running alongside your Tracetest server to be able to use
them. You can adjust the demo values below:
<p>
Tracetest has the option to enable Test examples for our{' '}
<a href={POKESHOP_GITHUB} target="_blank">
Pokeshop Demo App
</a>{' '}
or the{' '}
<a href={OTEL_DEMO_GITHUB} target="_blank">
OpenTelemetry Astronomy Shop Demo
</a>
. You will require an instance of those applications running alongside your Tracetest server to be able to use
them.
</p>
<DocsBanner>
Need more information about the Demos?{' '}
<a href={DEMO_DOCUMENTATION_URL} target="__blank">
Learn more in our docs
</a>
</DocsBanner>
</S.Description>
<S.FormContainer>
<DemoForm />
Expand Down
5 changes: 3 additions & 2 deletions web/src/components/Settings/Linter/Linter.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ import * as S from '../common/Settings.styled';

const Linter = () => (
<S.Container>
<S.Title level={2}>Analyzer (Beta)</S.Title>
<S.Description>
<p>
The Tracetest Analyzer is a plugin based framework used to audit OpenTelemetry traces to help teams improve
Expand All @@ -13,9 +14,9 @@ const Linter = () => (
Add to this <a href={OCTOLIINT_ISSUE_URL}>Issue</a> or call us on <a href={COMMUNITY_SLACK_URL}>Slack</a>!
</p>
<DocsBanner>
Need more information about Analyzer?{' '}
Need more information about the Analyzer?{' '}
<a href={ANALYZER_DOCUMENTATION_URL} target="_blank">
Go to our docs
Learn more in our docs
</a>
</DocsBanner>
</S.Description>
Expand Down
12 changes: 10 additions & 2 deletions web/src/components/Settings/Polling/Polling.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,19 @@
import DocsBanner from 'components/DocsBanner';
import {TRACE_POLLING_DOCUMENTATION_URL} from 'constants/Common.constants';
import PollingForm from './PollingForm';
import * as S from '../common/Settings.styled';

const Polling = () => (
<S.Container>
<S.Title level={2}>Trace Polling</S.Title>
<S.Description>
Tracetest uses polling to gather the distributed trace associated with each test run. You can adjust the polling
values below:
<p>Tracetest uses polling to gather the distributed trace associated with each test run.</p>
<DocsBanner>
Need more information about Trace Polling?{' '}
<a href={TRACE_POLLING_DOCUMENTATION_URL} target="__blank">
Learn more in our docs
</a>
</DocsBanner>
</S.Description>
<S.FormContainer>
<PollingForm />
Expand Down
7 changes: 4 additions & 3 deletions web/src/components/Settings/TestRunner/TestRunner.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,13 @@ import TestRunnerForm from './TestRunnerForm';
const TestRunner = () => {
return (
<S.Container>
<S.Title level={2}>Test Runner</S.Title>
<S.Description>
<p>The Test Runner allows you to configure the behavior used to execute your tests and generate the results</p>
<p>The Test Runner allows you to configure the behavior used to execute your tests and generate the results.</p>
<DocsBanner>
Need more information about Test Runner?{' '}
Need more information about the Test Runner?{' '}
<a href={TEST_RUNNER_DOCUMENTATION_URL} target="_blank">
Go to our docs
Learn more in our docs
</a>
</DocsBanner>
</S.Description>
Expand Down
12 changes: 10 additions & 2 deletions web/src/components/Settings/common/Settings.styled.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ import styled from 'styled-components';

export const Container = styled.div`
background: ${({theme}) => theme.color.white};
border: ${({theme}) => `1px solid ${theme.color.borderLight}`};
border-radius: 2px;
display: flex;
flex-direction: column;
margin-bottom: 24px;
padding: 16px;
padding: 24px;
`;

export const FormContainer = styled.div`
Expand All @@ -21,7 +23,7 @@ export const FooterContainer = styled.div`
border-top: 1px solid ${({theme}) => theme.color.borderLight};
`;

export const Description = styled(Typography.Text)`
export const Description = styled(Typography.Paragraph)`
&& {
color: ${({theme}) => theme.color.textSecondary};
}
Expand Down Expand Up @@ -50,3 +52,9 @@ export const SwitchLabel = styled.label<{$disabled?: boolean}>`
cursor: ${({$disabled}) => ($disabled ? 'not-allowed' : 'pointer')};
margin-bottom: 24px;
`;

export const Title = styled(Typography.Title)`
&& {
margin-bottom: 16px;
}
`;
5 changes: 4 additions & 1 deletion web/src/constants/Common.constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,11 @@ export const TEST_RUNNER_DOCUMENTATION_URL = 'https://docs.tracetest.io/configur
export const ANALYZER_RULES_DOCUMENTATION_URL = 'https://docs.tracetest.io/analyzer/rules';
export const EXPRESSIONS_DOCUMENTATION_URL = 'https://docs.tracetest.io/concepts/expressions';
export const VARIABLE_SET_DOCUMENTATION_URL = 'https://docs.tracetest.io/concepts/variable-sets';
export const GITHUB_ACTION_URL = 'https://github.com/kubeshop/tracetest-github-action/tree/main/examples/tracetest-cli-with-tracetest-core';
export const GITHUB_ACTION_URL =
'https://github.com/kubeshop/tracetest-github-action/tree/main/examples/tracetest-cli-with-tracetest-core';
export const CLI_DOCS_URL = 'https://docs.tracetest.io/cli/cli-installation-reference';
export const TRACE_POLLING_DOCUMENTATION_URL = 'https://docs.tracetest.io/configuration/trace-polling/';
export const DEMO_DOCUMENTATION_URL = 'https://docs.tracetest.io/configuration/demo/';

export const SELECTOR_LANGUAGE_CHEAT_SHEET_URL = `${process.env.PUBLIC_URL}/SL_cheat_sheet.pdf`;

Expand Down
2 changes: 1 addition & 1 deletion web/src/constants/TracetestAttributes.constants.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ export default {
},
'tracetest.span.type': {
description:
'Tracetest attribute based on the [OTel Trace Semantic Conventions](https://github.com/open-telemetry/opentelemetry-specification/tree/main/specification/trace/semantic_conventions)',
'Tracetest attribute based on the [OTel Trace Semantic Conventions](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/README.md)',
note: '',
tags: ['general', 'http', 'database', 'rpc', 'messaging', 'faas', 'exception'],
},
Expand Down
Loading