Skip to content

Commit

Permalink
docs(getstarted): revamp overview
Browse files Browse the repository at this point in the history
  • Loading branch information
adnanrahic committed Oct 22, 2024
1 parent d7de9ab commit 5ab5685
Show file tree
Hide file tree
Showing 3 changed files with 54 additions and 27 deletions.
31 changes: 14 additions & 17 deletions docs/docs/getting-started/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,24 @@ There are three ways to set up your development environment and install Tracetes
<TracetestCoreGettingStartedGuideCardsRow />
```

## Cloud-based Managed Tracetest and Enterprise Self-hosted Tracetest
## Open-source vs Commercial Tracetest

**We recommend using [Cloud-based Managed Tracetest](https://app.tracetest.io/)**. It's the easiest way to test web apps, APIs, microservices, and distributed apps with OpenTelemetry distributed traces. Tracetest provides managed infrastructure, [collaboration for teams](/concepts/environments), [RBAC](/concepts/roles-and-permissions), [organizations](/concepts/organizations), [dependency-free config](/concepts/agent), [agentless serverless config](/concepts/cloud-agent), and much more.
- **We recommend using [Cloud-based Managed Tracetest](https://app.tracetest.io/)**. It's the easiest way to test web apps, APIs, microservices, and distributed apps with OpenTelemetry distributed traces. Tracetest provides managed infrastructure, [collaboration for teams](/concepts/environments), [RBAC](/concepts/roles-and-permissions), [organizations](/concepts/organizations), [dependency-free config](/concepts/agent), [agentless serverless config](/concepts/cloud-agent), and much more.

If your organization requires you to keep data on-prem, you can use **[Enterprise Self-hosted Tracetest](https://tracetest.io/on-prem-installation) and deploy it in your own infrastructure**. It contains the same features as Cloud-based Managed Tracetest.
- If your organization requires you to keep data on-prem, you can use **[Enterprise Self-hosted Tracetest](https://tracetest.io/on-prem-installation) and deploy it in your own infrastructure**. It contains the same features as Cloud-based Managed Tracetest.

- **[Tracetest Core](https://github.com/kubeshop/tracetest) is the open-source hobbyist trace-based testing tool for non-production workloads**. It's a cloud-native application, packaged and distributed as a Docker image and designed to run in a containerized environment.

You can view [examples and many other supported use cases, here](/examples-tutorials/recipes).

### Features Available in Cloud-based Managed Tracetest and Enterprise Self-hosted Tracetest
## Features Available in Open-source Tracetest Core

- [Open-Source Features](https://github.com/kubeshop/tracetest?tab=readme-ov-file#-features)
- Test triggers: HTTP/GRPC, Trace ID, Kafka
- Test specifications: Selector language + Assertions
- Test automation options: CLI + Deep Link

## Features Available in Cloud-based Managed Tracetest and Enterprise Self-hosted Tracetest

#### All Tracetest Core features, plus...

Expand All @@ -49,16 +58,4 @@ You can view [examples and many other supported use cases, here](/examples-tutor
- Secrets management: Obfuscate values in variable sets.
- Synthetic monitoring: Run your existing trace-based tests and test suites on a schedule and get alerted with your favorite alerting tools when they fail.
- Playwright engine trigger: Run your existing Playwright tests as part of the Tracetest platform and enhance them with trace-based testing.

## Hobby Self-hosted Open-source Tracetest Core

Tracetest Core is a cloud-native application, packaged and distributed as a Docker image and designed to run in a containerized environment.

### Features Available in Open-source Tracetest Core

#### Tracetest Core functionality

- [Open-Source Features](https://github.com/kubeshop/tracetest?tab=readme-ov-file#-features)
- Test triggers: HTTP/GRPC, Trace ID, Kafka
- Test specifications: Selector language + Assertions
- Test automation options: CLI + Deep Link
- Trace mode: Ingest traces and automatically build trace-based tests from ingested traces.
11 changes: 1 addition & 10 deletions docs/src/components/WelcomeGuide/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,6 @@ import Link from '@docusaurus/Link';
import Heading from '@theme/Heading';

const WelcomeGuides = [
// { // Changed June 17 2024 to try redirecting users to recipes.
// name: '👇 Getting Started',
// url: './getting-started/overview',
// description: (
// <Translate >
// Set up Tracetest and start trace-based testing your distributed system.
// </Translate>
// ),
// },
{
name: '👉 Getting Started',
url: './getting-started/overview',
Expand Down Expand Up @@ -62,7 +53,7 @@ interface Props {
function WelcomeGuideCard({name, url, description}: Props) {
return (
<div className="col col--6 margin-bottom--lg">
<div className="gs__card">
<div className="w__card">
<div className="card">
<Link to={url}>
<div className="card__body">
Expand Down
39 changes: 39 additions & 0 deletions docs/src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,45 @@ html[data-theme='dark'] div[class^='gs__card'] .card:hover {
box-shadow: none;
}

/* Welcome to Tracetest Docs */

div[class^='w__card'] .card {
background-color: var(--ifm-background-surface-color);
color: var(--ifm-font-color-base);
border: 1px solid var(--ifm-color-emphasis-300);
transition: border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default);
/* box-shadow: 0 1px 2px 0 rgba(0, 0, 0, 0.1); */
box-shadow: none;
}

div[class^='w__card'] .card:hover {
border: 1px solid var(--ifm-color-primary);
/* box-shadow: 0 4px 8px 0 rgba(0, 0, 0, 0.1), 0 6px 20px 0 rgba(0, 0, 0, 0.1); */
box-shadow: none;
}

div[class^='w__card'] .card a {
color: var(--ifm-font-color-base);
text-decoration: inherit;
}

div[class^='w__card'] .card a:hover {
color: var(--ifm-font-color-base);
text-decoration: inherit;
}

html[data-theme='dark'] div[class^='w__card'] .card {
background-color: #2e1623;
border: 1px solid var(--ifm-color-emphasis-300);
/* box-shadow: 0 1px 2px 0 rgba(255, 255, 255, 0.1); */
box-shadow: none;
}
html[data-theme='dark'] div[class^='w__card'] .card:hover {
border: 1px solid var(--ifm-color-primary);
/* box-shadow: 0 4px 8px 0 rgba(255, 255, 255, 0.1), 0 6px 20px 0 rgba(255, 255, 255, 0.1); */
box-shadow: none;
}

/* nav sign in */

.sign-in-button {
Expand Down

0 comments on commit 5ab5685

Please sign in to comment.