Skip to content
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
27 changes: 15 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,35 +1,38 @@
# This documentation is still in progress.

# Operaton Documentation

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
This repository contains the public documentation website for [Operaton](https://operaton.org/), built with [Docusaurus](https://docusaurus.io/).

## Requirements

- Node.js 18 or newer
- npm

### Installation
## Install

```bash
npm install
npm ci
```

### Local Development
## Local Development

```bash
npm run start
```

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
This starts a local development server. Most content and styling changes are reflected without restarting the server.

### Build
## Build

```bash
npm run build
```

This command generates static content into the `build` directory and can be served using any static contents hosting service.
The static site is generated in the `build` directory.

### Update dependencies
## Typecheck

```bash
npm update
npm run typecheck
```

This command update the dependencies from `package.json`
Run the typecheck and production build before opening a pull request.
47 changes: 0 additions & 47 deletions docs/intro.md

This file was deleted.

4 changes: 2 additions & 2 deletions src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ const FeatureList: FeatureItem[] = [
title: 'Easy to Use',
description: (
<>
Operaton as fork of Camunda 7 was designed from the ground up to be easily installed and used, helping you get your business processes up and running quickly.
Operaton builds on the Camunda 7 codebase and keeps BPMN process automation approachable for teams getting started or migrating existing workloads.
</>
),
},
Expand All @@ -35,7 +35,7 @@ const FeatureList: FeatureItem[] = [
},
];

function Feature({title, Svg, description}: FeatureItem) {
function Feature({title, description}: FeatureItem) {
return (
<div className={clsx('col col--4')}>
<div className="text--center padding-horiz--md">
Expand Down
5 changes: 0 additions & 5 deletions src/components/HomepageFeatures/styles.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,3 @@
padding: 2rem 0;
width: 100%;
}

.featureSvg {
height: 200px;
width: 200px;
}
8 changes: 2 additions & 6 deletions src/css/custom.css
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
/**
* Any CSS included here will be global. The classic template
* bundles Infima by default. Infima is a CSS framework designed to
* work well for content-centric websites.
* Global site styles and Infima theme variables.
*/

/* You can override the default Infima variables here. */
:root {
--ifm-color-primary: #0f7b9d;
--ifm-color-primary-dark: #0a607c;
Expand All @@ -18,7 +15,6 @@
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
}

/* For readability concerns, you should choose a lighter palette in dark mode. */
[data-theme='dark'] {
--ifm-color-primary: #25c2a0;
--ifm-color-primary-dark: #21af90;
Expand All @@ -42,4 +38,4 @@

.implemented td {
color: #df8a13;
}
}
3 changes: 3 additions & 0 deletions src/pages/index.module.css
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,7 @@
display: flex;
align-items: center;
justify-content: center;
gap: 1rem;
flex-wrap: wrap;
margin-top: 1.5rem;
}
12 changes: 10 additions & 2 deletions src/pages/index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ function HomepageHeader() {
{siteConfig.title}
</Heading>
<p className="hero__subtitle">{siteConfig.tagline}</p>
<div className={styles.buttons}>
<Link className="button button--secondary button--lg" to="/docs/get-started/">
Get Started
</Link>
<Link className="button button--outline button--secondary button--lg" to="/docs/documentation/">
Browse Documentation
</Link>
</div>
</div>
</header>
);
Expand All @@ -26,8 +34,8 @@ export default function Home(): ReactNode {
const {siteConfig} = useDocusaurusContext();
return (
<Layout
title={`Hello from ${siteConfig.title}`}
description="Description will go into a meta tag in <head />">
title={siteConfig.title}
description="Operaton documentation for BPMN, DMN, CMMN, installation, operations, and APIs.">
<HomepageHeader />
<main>
<HomepageFeatures />
Expand Down
20 changes: 0 additions & 20 deletions src/theme/AnnouncementBar/index.tsx

This file was deleted.

31 changes: 0 additions & 31 deletions src/theme/AnnouncementBar/styles.module.css

This file was deleted.

3 changes: 2 additions & 1 deletion tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
// This file is not used in compilation. It is here just for a nice editor experience.
"extends": "@docusaurus/tsconfig",
"compilerOptions": {
"baseUrl": "."
"baseUrl": ".",
"ignoreDeprecations": "6.0"
},
"exclude": [".docusaurus", "build"]
}