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

docs landing page revamp #3792

Merged
merged 27 commits into from
Jul 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
fa7f53e
hero banner changes
christinaausley May 9, 2024
632fb0d
bottom banner adjustments
christinaausley May 9, 2024
414a3b4
adjust text and icon for footer
christinaausley May 10, 2024
a778d47
Merge branch 'main' into phase-1-docs-landing-page
christinaausley May 13, 2024
6bd0cad
draft framework for cards
christinaausley May 13, 2024
5e61f47
update cards
christinaausley May 13, 2024
a050468
clean up footer
christinaausley May 13, 2024
2e8adc6
remove empty div
christinaausley May 13, 2024
c3bfa21
add url option
christinaausley May 13, 2024
7bcda7f
add links to card images
christinaausley May 13, 2024
7119375
clean up footer for funsies
christinaausley May 13, 2024
2f6097c
return component-block for hover
christinaausley May 14, 2024
9714a47
clean up css
christinaausley May 14, 2024
37bc5be
add icons8 license
christinaausley May 14, 2024
68f6f00
adjust card css
christinaausley May 17, 2024
65ff114
revert to original footer
christinaausley May 17, 2024
5696782
add clear and float
christinaausley May 17, 2024
1680589
remove image i dont need anymore
christinaausley May 17, 2024
d16c1c3
clean up icons and styling
christinaausley May 24, 2024
34c50d0
adjust footer
christinaausley May 24, 2024
d90fa40
make features grid align as 2 rows of 3
Jun 18, 2024
da8d5a8
adjust header and footer
christinaausley Jun 18, 2024
6ef457b
update release notes link
christinaausley Jun 28, 2024
0c326ca
remove .md
christinaausley Jun 28, 2024
b9fb044
correct links
christinaausley Jun 28, 2024
ba8c258
fix link to release notes
akeller Jun 28, 2024
a35ebd2
Merge branch 'main' into phase-1-docs-landing-page
akeller Jun 28, 2024
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
3 changes: 2 additions & 1 deletion docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ const latestVersion = require("./src/versions").versionMappings[0].docsVersion;

module.exports = {
title: "Camunda 8 Docs",
tagline: "Documentation for all components of Camunda 8",
tagline:
"Orchestrate complex process flows, automate across people, systems, and devices, and transform your organization.",
// url: "https://camunda-cloud.github.io",
url: process.env.DOCS_SITE_URL || "https://docs.camunda.io",
// baseUrl: "/camunda-cloud-documentation/",
Expand Down
11 changes: 11 additions & 0 deletions src/css/custom.css
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,11 @@ navbar .navbar .navbar__link[href*="self-managed"] {

.component-block {
transition: all 0.3s ease;
background-color: #000;
color: white;
border-radius: 25px;
box-shadow: 4px 4px 4px 1px lightgray;
margin: 2px;
}

.component-block:hover {
Expand Down Expand Up @@ -472,3 +477,9 @@ span.callout + p::after {
margin-left: 4px;
color: transparent;
}

/* Revamping docs homepage */

.hero--primary {
background-image: url("https://d3bql97l1ytoxn.cloudfront.net/be68f16b-99af-464f-ab93-8cf545c121bc/a5089b42-b94e-4061-bead-4275b38d9af6.png");
}
139 changes: 47 additions & 92 deletions src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,100 +8,62 @@ import styles from "./styles.module.css";

const features = [
{
title: "Guides",
imageUrl: "img/guides.png",
title: "I'm new here, and want to get started",
imageUrl: "img/confused-person.png",
url: "/docs/guides",
description: (
<>
Step-by-step content to strengthen your knowledge of Camunda 8, its
components, and its features.
</>
),
description:
"Visit our guides section to learn more about creating an account, modeling your first process, orchestrating human and service tasks, and more!",
},
{
title: "Components",
imageUrl: "img/components.png",
title: "I'm looking for a particular component",
imageUrl: "img/homegrown-workflow.png",
url: "/docs/components/",
description: (
<>
Conceptualize the cornerstones of Camunda 8 and learn more about its
supporting components.
</>
),
description:
"Find product manual content for each component in Camunda 8. Together, these components comprise the Camunda 8 SaaS experience.",
},
{
title: "APIs & Tools",
imageUrl: "img/apisclients.png",
title: "I want to host Camunda 8 myself",
imageUrl: "img/Camunda-self-managed.png",
url: "/docs/self-managed/about-self-managed/",
description:
"As an alternative to using Camunda 8 through SaaS, you can host it yourself. We call this setup Camunda 8 Self-Managed!",
},
{
title: "I'm an API advocate",
imageUrl: "img/customer-success.png",
url: "/docs/apis-tools/working-with-apis-tools/",
description: (
<>
Programmatically interact with your automated processes, and learn how
to build your own frontend applications.
</>
),
description:
"Deploy processes, activate jobs, and more using Zeebe client libraries, learn about Camunda components and their APIs, or check out community clients turned SDKs!",
},
];

const features2 = [
{
title: "Self-Managed",
imageUrl: "img/self-managed.png",
url: "/docs/self-managed/about-self-managed/",
description: (
<>
A self-hosted Camunda 8 alternative, offering everything you need to
download, configure, and work with each component.
</>
),
title: "I want to level up with Best Practices",
imageUrl: "img/education.png",
url: "/docs/components/best-practices/best-practices-overview/",
description:
"Sift through conceptual and practical guidance to level up your BPMN and DMN skills, incorporating insights from consulting, community feedback, and more.",
},
{
title: "Reference",
imageUrl: "img/reference.png",
title: "I'm looking for general reference material",
imageUrl: "img/handbook.png",
url: "/docs/reference/",
description: (
<>
Supporting material to strengthen your understanding of supported
environments, releases, dependencies, and more.
</>
),
description:
"Take a closer look at release notes, announcements, supported environments, licenses, and more in our reference documentation!",
},
];

function Feature({ imageUrl, url, title, description }) {
const imgUrl = useBaseUrl(imageUrl);
return (
<div className={clsx("col col--4 component-block", styles.feature)}>
<div className={clsx("col component-block", styles.feature)}>
{imgUrl && (
<div className="text--center">
<Link to={useBaseUrl(url)}>
<img className={styles.featureImage} src={imgUrl} alt={title} />
</Link>
</div>
)}
<h3 className="component-title">{title}</h3>
<p className="component-desc">{description}</p>
</div>
);
}

function Feature2({ imageUrl, url, title, description }) {
const imgUrl = useBaseUrl(imageUrl);
return (
<div
className={clsx(
"col col--offset-1 col--4 component-block",
styles.feature
)}
>
{imgUrl && (
<div className="text--center">
<Link to={useBaseUrl(url)}>
<img className={styles.featureImage} src={imgUrl} alt={title} />
</Link>
</div>
)}
<h3 className="component-title">{title}</h3>
<p className="component-desc">{description}</p>
<h3>{title}</h3>
<p>{description}</p>
</div>
);
}
Expand All @@ -112,7 +74,7 @@ function Home() {
return (
<Layout
title={`${siteConfig.title}`}
description="Documentation for all the components of Camunda 8."
description="Orchestrate complex process flows, automate across people, systems, and devices, and transform your organization."
>
<header className={clsx("hero hero--primary", styles.heroBanner)}>
<div className="container">
Expand All @@ -127,7 +89,7 @@ function Home() {
)}
to={useBaseUrl("docs/guides/")}
>
Explore Guides
What's Camunda 8?
</Link>
</div>
<div className={clsx("col col--3", styles.buttons)}>
Expand All @@ -140,7 +102,7 @@ function Home() {
"https://signup.camunda.com/accounts?utm_source=docs.camunda.io&utm_medium=referral"
)}
>
Sign Up
Sign up
</Link>
</div>
</div>
Expand All @@ -150,56 +112,49 @@ function Home() {
{features && features.length > 0 && (
<section className={styles.features}>
<div className="container">
<div className="row">
<div className={styles.featuresGrid}>
{features.map((props, idx) => (
<Feature key={idx} {...props} />
))}
</div>
</div>
</section>
)}
{features2 && features2.length > 0 && (
<section className={styles.features2}>
<div className="container">
<div className="row">
{features2.map((props, idx) => (
<Feature2 key={idx} {...props} />
))}
</div>
</div>
</section>
)}
<div className={clsx("hero hero--secondary", styles.heroBanner)}>
<div className="container">
<h2 className="hero__title">Unsure where to begin?</h2>
<p className="hero__subtitle">Try one of our use case guides</p>
<h2 className="hero__title">Want to know what's new?</h2>
<p className="hero__subtitle">
Check out some of our latest features
</p>
<div className={styles.buttons}>
<Link
className={clsx(
"button button--outline button--secondary button--lg button--hero get-started-use-case",
styles.getStarted
)}
to={useBaseUrl("docs/guides/orchestrate-microservices/")}
to={useBaseUrl(
"docs/apis-tools/spring-zeebe-sdk/getting-started/"
)}
>
Microservice Orchestration
Spring Zeebe SDK
</Link>
<Link
className={clsx(
"button button--outline button--secondary button--lg button--hero get-started-use-case get-started-use-case-2",
styles.getStarted
)}
to={useBaseUrl("docs/guides/orchestrate-human-tasks/")}
to={useBaseUrl("docs/reference/release-notes/")}
>
Human Task Orchestration
Release notes
</Link>
<Link
className={clsx(
"button button--outline button--secondary button--lg button--hero get-started-use-case get-started-use-case-2",
styles.getStarted
)}
to={useBaseUrl("docs/guides/orchestrate-apis/")}
to={useBaseUrl("docs/apis-tools/node-js-sdk/")}
>
API Endpoint Orchestration
Node.js SDK
</Link>
</div>
</div>
Expand Down
7 changes: 7 additions & 0 deletions src/pages/styles.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -35,3 +35,10 @@
height: 130px;
width: 130px;
}

.featuresGrid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(360px, 1fr));
grid-auto-rows: 330px;
gap: 4px;
}
Binary file added static/img/Camunda-self-managed.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/confused-person.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/customer-success.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/education.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/handbook.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/img/homegrown-workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading