Skip to content

Commit 09db0a2

Browse files
antonpirkerchargomesentrivana
authored
feat(platform): Add image cards to devdocs getting started page (#12110)
* Added awarness section to top level pages * Updated startpage * Added dev infra to start page * Update to new top level section 'backend' * Added some icons (probably the wrong way, but it kind of works) * add cardgrid * Apply suggestions from code review Co-authored-by: Ivana Kellyer <[email protected]> --------- Co-authored-by: Charly Gomez <[email protected]> Co-authored-by: Ivana Kellyer <[email protected]>
1 parent 2a285ad commit 09db0a2

File tree

12 files changed

+98
-12
lines changed

12 files changed

+98
-12
lines changed

develop-docs/getting-started/index.mdx

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,10 @@ description: This documentation serves as reference points for developing agains
44
sidebar_order: 1
55
---
66

7-
## Getting Started
7+
We recommend going through the [engineering practices](/engineering-practices) and our [development philsophy](/getting-started/philosophy/) before contributing a change to Sentry.
88

9-
We recommend going through the general documentation before contributing a change to Sentry.
109

11-
- <Link to="/getting-started/philosophy/">Development Philosophy</Link> (and <Link to="/sdk/philosophy/">SDK Development Philosophy</Link>)
12-
- <Link to="/development/commit-messages/">Commit Messages</Link>
13-
- <Link to="/development/code-review/">Code Review</Link>
14-
- <Link to="/development/environment/">Environment</Link>
15-
- <Link to="/development/workflow/">Workflow</Link>
16-
- <Link to="/application/architecture/">Application Architecture</Link>
10+
<DevDocsCardGrid />
11+
1712

1813
You can also take a glance at the [Sentry Dockerfile](https://github.com/getsentry/sentry/blob/master/self-hosted/Dockerfile) for more information on how the Sentry server is configured, including its system dependencies.

src/components/card.tsx

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,16 @@ export function Card({
1919
}) {
2020
return (
2121
<Link href={href} className={className}>
22-
<div className="flex flex-col md:flex-row shadow dark:bg-[var(--gray-4)] p-6 rounded gap-4 h-full">
23-
<Image src={image} height={64} alt={imageAlt} className="object-contain" />
22+
<div className="flex flex-col md:flex-row shadow dark:bg-[var(--gray-4)] p-6 rounded gap-4 h-full text-[var(--foreground)]">
23+
<Image
24+
src={image}
25+
height={64}
26+
alt={imageAlt}
27+
className="object-contain !border-none !shadow-none"
28+
/>
2429
<div className="flex flex-col justify-center space-y-2">
2530
<h3 className="text-xl font-medium">{title}</h3>
26-
<p>{description}</p>
31+
<p className="text-[length:--font-size-3]">{description}</p>
2732
</div>
2833
</div>
2934
</Link>

src/components/devDocsCardGrid.tsx

Lines changed: 82 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,82 @@
1+
import BackendImg from 'sentry-docs/imgs/back-end.png';
2+
import InfraImg from 'sentry-docs/imgs/dev-infra.png';
3+
import FrontendImg from 'sentry-docs/imgs/front-end.png';
4+
import IngestImg from 'sentry-docs/imgs/ingest.png';
5+
import IntegrationsImg from 'sentry-docs/imgs/integrate.png';
6+
import SkdsImg from 'sentry-docs/imgs/sdks.png';
7+
import ServicesImg from 'sentry-docs/imgs/services.png';
8+
import SelfHostedImg from 'sentry-docs/imgs/support.png';
9+
10+
import {Card} from './card';
11+
12+
export function DevDocsCardGrid() {
13+
return (
14+
<div className="flex flex-wrap gap-6 not-prose">
15+
<Card
16+
className="w-full"
17+
href="/development-infrastructure/"
18+
title="Development Infrastructure"
19+
description="How to get your local dev environment up and running."
20+
image={InfraImg}
21+
imageAlt="Development Infrastructure"
22+
/>
23+
24+
<Card
25+
className="w-full md:w-[calc(50%-12px)]"
26+
href="/backend/"
27+
title="Backend"
28+
description="The monolith that is powering Sentry."
29+
image={BackendImg}
30+
imageAlt="Backend"
31+
/>
32+
<Card
33+
className="w-full md:w-[calc(50%-12px)]"
34+
href="/frontend/"
35+
title="Frontend"
36+
description="How we write frontend code."
37+
image={FrontendImg}
38+
imageAlt="Frontend"
39+
/>
40+
<Card
41+
className="w-full md:w-[calc(50%-12px)]"
42+
href="/services/"
43+
title="Services"
44+
description="Running alongside the monolith."
45+
image={ServicesImg}
46+
imageAlt="Services"
47+
/>
48+
<Card
49+
className="w-full md:w-[calc(50%-12px)]"
50+
href="/integrations/"
51+
title="Integrations"
52+
imageAlt="Integrations"
53+
description="Connecting Sentry to other products."
54+
image={IntegrationsImg}
55+
/>
56+
<Card
57+
className="w-full md:w-[calc(50%-12px)]"
58+
href="/ingestion/"
59+
title="Ingestion"
60+
imageAlt="Ingestion"
61+
description="Receiving and processing data."
62+
image={IngestImg}
63+
/>
64+
<Card
65+
className="w-full md:w-[calc(50%-12px)]"
66+
href="/sdk/"
67+
title="SDKs"
68+
imageAlt="SDKs"
69+
description="Instrumenting user code."
70+
image={SkdsImg}
71+
/>
72+
<Card
73+
className="w-full"
74+
href="/self-hosted/"
75+
title="Self-Hosted Sentry"
76+
imageAlt="Self-Hosted Sentry"
77+
description="How you can run all of Sentry on your own server, without paying anything."
78+
image={SelfHostedImg}
79+
/>
80+
</div>
81+
);
82+
}

src/components/docPage/type.scss

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@
7878
margin-bottom: 1.75rem;
7979
}
8080

81-
h3 {
81+
h3 :not(.not-prose) {
8282
font-size: 1.125rem;
8383
}
8484

src/imgs/back-end.png

5.74 KB
Loading

src/imgs/dev-infra.png

8.11 KB
Loading

src/imgs/front-end.png

8.28 KB
Loading

src/imgs/ingest.png

4.99 KB
Loading

src/imgs/integrate.png

4.81 KB
Loading

src/imgs/sdks.png

8.03 KB
Loading

0 commit comments

Comments
 (0)