Skip to content

Commit 554de30

Browse files
anders-swansonanders-swanson
committed
Bootstrap docusaurus website
Signed-off-by: Anders Swanson <[email protected]>
1 parent 109e5c3 commit 554de30

File tree

21 files changed

+451
-0
lines changed

21 files changed

+451
-0
lines changed

‎docs-source/site/.gitignore‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Dependencies
2+
/node_modules
3+
4+
# Production
5+
/build
6+
7+
# Generated files
8+
.docusaurus
9+
.cache-loader
10+
11+
# Misc
12+
.DS_Store
13+
.env.local
14+
.env.development.local
15+
.env.test.local
16+
.env.production.local
17+
18+
npm-debug.log*
19+
yarn-debug.log*
20+
yarn-error.log*

‎docs-source/site/README.md‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# Website
2+
3+
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4+
5+
The `content` directory contains the built, static site.
6+
7+
Requirements:
8+
- latest version of NodeJS
9+
10+
## Installation
11+
12+
```bash
13+
npm i
14+
```
15+
16+
## Local Development
17+
18+
```bash
19+
npm start
20+
```
21+
22+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
23+
24+
## Versioning
25+
26+
```bash
27+
npm run docusaurus docs:version 1.1.0
28+
```
29+
30+
Then, add the version to the `docusaurus.config.ts` versions navbar.
31+
32+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
33+
34+
## Deployment
35+
36+
Using SSH:
37+
38+
```bash
39+
USE_SSH=true yarn deploy
40+
```
41+
42+
Not using SSH:
43+
44+
```bash
45+
GIT_USER=<Your GitHub username> yarn deploy
46+
```
47+
48+
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

‎docs-source/site/docs/intro.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
sidebar_position: 1
3+
---
4+
5+
# Oracle Backend for Microservices and AI
6+
7+
Oracle Backend for Microservices and AI allows developers to build microservices in Helidon and/or Spring Boot and provisions a “backend as a service” with Oracle Database and other infrastructure components that operate on multiple clouds. Oracle Backend for Microservices and AI vastly simplifies the task of building, testing, and operating microservices platforms for reliable, secure, and scalable enterprise applications.
8+
9+
**Content TBD**

‎docs-source/site/docs/setup/_category_.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Setup",
3+
"position": 1,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "OBaaS setup and installation."
7+
}
8+
}

‎docs-source/site/docs/setup/go-runtime.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: Installing OBaaS
3+
sidebar_position: 1
4+
---
5+
6+
**Content TBD**

‎docs-source/site/docusaurus.config.ts‎

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
import {themes as prismThemes} from 'prism-react-renderer';
2+
import type {Config} from '@docusaurus/types';
3+
import type * as Preset from '@docusaurus/preset-classic';
4+
5+
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
6+
7+
const config: Config = {
8+
title: 'Oracle Backend for Microservices and AI',
9+
tagline: 'Deploy AI microservices using a “backend as a service” with Oracle Database and other infrastructure components',
10+
favicon: 'img/favicon-32x32.png',
11+
12+
// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
13+
future: {
14+
v4: true, // Improve compatibility with the upcoming Docusaurus v4
15+
},
16+
17+
// TODO: Set the production url of your site here
18+
url: 'https://oracle.github.io',
19+
// Set the /<baseUrl>/ pathname under which your site is served
20+
// For GitHub pages deployment, it is often '/<projectName>/'
21+
baseUrl: '/microservices-datadriven/',
22+
23+
// GitHub pages deployment config.
24+
// If you aren't using GitHub pages, you don't need these.
25+
organizationName: 'oracle', // Usually your GitHub org/user name.
26+
projectName: 'microservices-datadriven', // Usually your repo name.
27+
28+
onBrokenLinks: 'throw',
29+
onBrokenMarkdownLinks: 'warn',
30+
31+
// Even if you don't use internationalization, you can use this field to set
32+
// useful metadata like html lang. For example, if your site is Chinese, you
33+
// may want to replace "en" with "zh-Hans".
34+
i18n: {
35+
defaultLocale: 'en',
36+
locales: ['en'],
37+
},
38+
39+
presets: [
40+
[
41+
'classic',
42+
{
43+
docs: {
44+
sidebarPath: './sidebars.ts',
45+
// Please change this to your repo.
46+
// Remove this to remove the "edit this page" links.
47+
editUrl:
48+
'https://github.com/oracle/microservices-datadriven/tree/main/docs-source/site/',
49+
},
50+
theme: {
51+
customCss: './src/css/custom.css',
52+
},
53+
} satisfies Preset.Options,
54+
],
55+
],
56+
57+
themeConfig: {
58+
// Replace with your project's social card
59+
image: 'img/logo.png',
60+
navbar: {
61+
title: 'Oracle Backend for Microservices and AI',
62+
logo: {
63+
alt: 'Oracle Backend for Microservices and AI Logo',
64+
src: 'img/logo_home.png',
65+
},
66+
items: [
67+
{
68+
type: 'docSidebar',
69+
sidebarId: 'tutorialSidebar',
70+
position: 'left',
71+
label: 'Docs',
72+
},
73+
{
74+
type: 'docsVersionDropdown',
75+
versions: ['current' ]
76+
},
77+
{
78+
href: 'https://github.com/oracle/microservices-datadriven',
79+
label: 'GitHub',
80+
position: 'right',
81+
},
82+
],
83+
},
84+
footer: {
85+
style: 'dark',
86+
links: [
87+
{
88+
title: 'Docs',
89+
items: [
90+
{
91+
label: 'Tutorial',
92+
to: '/docs/intro',
93+
},
94+
],
95+
},
96+
{
97+
title: 'Community',
98+
items: [
99+
{
100+
label: 'Stack Overflow',
101+
href: 'https://stackoverflow.com/questions/tagged/oracle',
102+
},
103+
],
104+
},
105+
{
106+
title: 'More',
107+
items: [
108+
{
109+
label: 'Oracle Blogs',
110+
to: 'https://blogs.oracle.com/',
111+
},
112+
{
113+
label: 'Oracle LiveLabs',
114+
to: 'https://livelabs.oracle.com/pls/apex/r/dbpm/livelabs/home'
115+
},
116+
{
117+
label: 'GitHub',
118+
href: 'https://github.com/oracle/microservices-datadriven',
119+
},
120+
],
121+
},
122+
],
123+
copyright: `Copyright © ${new Date().getFullYear()}, Oracle and/or its affiliates. Built with ❤️ using Docusaurus.`,
124+
},
125+
prism: {
126+
theme: prismThemes.github,
127+
darkTheme: prismThemes.dracula,
128+
},
129+
} satisfies Preset.ThemeConfig,
130+
};
131+
132+
export default config;

‎docs-source/site/sidebars.ts‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
2+
3+
// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)
4+
5+
/**
6+
* Creating a sidebar enables you to:
7+
- create an ordered group of docs
8+
- render a sidebar for each doc of that group
9+
- provide next/previous navigation
10+
11+
The sidebars can be generated from the filesystem, or explicitly defined here.
12+
13+
Create as many sidebars as you want.
14+
*/
15+
const sidebars: SidebarsConfig = {
16+
// By default, Docusaurus generates a sidebar from the docs folder structure
17+
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
18+
19+
// But you can create a sidebar manually
20+
/*
21+
tutorialSidebar: [
22+
'intro',
23+
'hello',
24+
{
25+
type: 'category',
26+
label: 'Tutorial',
27+
items: ['tutorial-basics/create-a-document'],
28+
},
29+
],
30+
*/
31+
};
32+
33+
export default sidebars;

‎docs-source/site/src/components/HomepageFeatures/index.tsx‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
import type {ReactNode} from 'react';
2+
import clsx from 'clsx';
3+
import Heading from '@theme/Heading';
4+
import styles from './styles.module.css';
5+
6+
type FeatureItem = {
7+
title: string;
8+
Svg: React.ComponentType<React.ComponentProps<'svg'>>;
9+
description: ReactNode;
10+
};
11+
12+
const FeatureList: FeatureItem[] = [
13+
{
14+
title: 'Build Enterprise-Ready Microservices Fast',
15+
Svg: require('@site/static/img/logo.svg').default,
16+
description: (
17+
<>
18+
Simplify development and deployment of secure Spring Boot and Helidon microservices with built-in Oracle Database support—ready for multi-cloud environments and production use.
19+
</>
20+
),
21+
},
22+
{
23+
title: 'AI-Driven Backend as a Service',
24+
Svg: require('@site/static/img/logo.svg').default,
25+
description: (
26+
<>
27+
Empower your applications with advanced AI, real-time messaging, and automated observability—integrated APIs, gateways, and enterprise infrastructure out of the box.
28+
</>
29+
),
30+
},
31+
{
32+
title: 'Simple DevOps Experience',
33+
Svg: require('@site/static/img/logo.svg').default,
34+
description: (
35+
<>
36+
Accelerate project delivery with out-of-the-box service discovery, monitoring, and transactional consistency for modern microservices architectures.
37+
</>
38+
),
39+
},
40+
];
41+
42+
function Feature({title, Svg, description}: FeatureItem) {
43+
return (
44+
<div className={clsx('col col--4')}>
45+
<div className="text--center">
46+
<Svg className={styles.featureSvg} role="img" />
47+
</div>
48+
<div className="text--center padding-horiz--md">
49+
<Heading as="h3">{title}</Heading>
50+
<p>{description}</p>
51+
</div>
52+
</div>
53+
);
54+
}
55+
56+
export default function HomepageFeatures(): ReactNode {
57+
return (
58+
<section className={styles.features}>
59+
<div className="container">
60+
<div className="row">
61+
{FeatureList.map((props, idx) => (
62+
<Feature key={idx} {...props} />
63+
))}
64+
</div>
65+
</div>
66+
</section>
67+
);
68+
}

‎docs-source/site/src/components/HomepageFeatures/styles.module.css‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
.features {
2+
display: flex;
3+
align-items: center;
4+
padding: 2rem 0;
5+
width: 100%;
6+
}
7+
8+
.featureSvg {
9+
height: 200px;
10+
width: 200px;
11+
}

‎docs-source/site/src/css/custom.css‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
/**
2+
* Any CSS included here will be global. The classic template
3+
* bundles Infima by default. Infima is a CSS framework designed to
4+
* work well for content-centric websites.
5+
*/
6+
7+
/* You can override the default Infima variables here. */
8+
:root {
9+
--ifm-color-primary: #590000;
10+
--ifm-color-primary-dark: #b32c2c;
11+
--ifm-color-primary-darker: #b12929;
12+
--ifm-color-primary-darkest: #751717;
13+
--ifm-color-primary-light: #b64f4f;
14+
--ifm-color-primary-lighter: #bf7676;
15+
--ifm-color-primary-lightest: #b85e5e;
16+
--ifm-code-font-size: 95%;
17+
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.1);
18+
}
19+
20+
/* For readability concerns, you should choose a lighter palette in dark mode. */
21+
[data-theme='dark'] {
22+
--ifm-color-primary: #25c2a0;
23+
--ifm-color-primary-dark: #21af90;
24+
--ifm-color-primary-darker: #1fa588;
25+
--ifm-color-primary-darkest: #1a8870;
26+
--ifm-color-primary-light: #29d5b0;
27+
--ifm-color-primary-lighter: #32d8b4;
28+
--ifm-color-primary-lightest: #4fddbf;
29+
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
30+
}

0 commit comments

Comments
 (0)