Skip to content

Commit 3f91bf0

Browse files
Merge pull request #1092 from oracle/docusuarus-bootstrap
Bootstrap docusaurus website
2 parents 109e5c3 + 1c14c30 commit 3f91bf0

23 files changed

+17993
-0
lines changed

docs-source/site/.gitignore

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

0 commit comments

Comments
 (0)