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
20 changes: 20 additions & 0 deletions site/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
52 changes: 52 additions & 0 deletions site/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
# Website

This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.

Requirements:
- latest version of NodeJS

## Installation

```bash
npm
```

## Local Development

```bash
npm 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.

## Build

```bash
npm run build
```

## Versioning

```bash
npm run docusaurus docs:version 1.1.0
```

Then, add the version to the `docusaurus.config.ts` versions navbar.

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

## Deployment

Using SSH:

```bash
USE_SSH=true yarn deploy
```

Not using SSH:

```bash
GIT_USER=<Your GitHub username> yarn deploy
```

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.
8 changes: 8 additions & 0 deletions site/docs/configuration/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Configuration",
"position": 3,
"link": {
"type": "generated-index",
"description": "How to configure the Oracle Database Metrics Exporter."
}
}
4 changes: 4 additions & 0 deletions site/docs/configuration/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Configuration
sidebar_position: 1
---
8 changes: 8 additions & 0 deletions site/docs/getting-started/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Getting Started",
"position": 2,
"link": {
"type": "generated-index",
"description": "Learn the most important Oracle Database Metrics Exporter concepts."
}
}
4 changes: 4 additions & 0 deletions site/docs/getting-started/basics.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Quickstart
sidebar_position: 1
---
6 changes: 6 additions & 0 deletions site/docs/intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
sidebar_position: 1
---

# Introduction

132 changes: 132 additions & 0 deletions site/docusaurus.config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
import {themes as prismThemes} from 'prism-react-renderer';
import type {Config} from '@docusaurus/types';
import type * as Preset from '@docusaurus/preset-classic';

// This runs in Node.js - Don't use client-side code here (browser APIs, JSX...)

const config: Config = {
title: 'Oracle Database Metrics Exporter',
tagline: 'OpenTelemetry Metrics for your Oracle Database instances',
favicon: 'img/favicon-32x32.png',

// Future flags, see https://docusaurus.io/docs/api/docusaurus-config#future
future: {
v4: true, // Improve compatibility with the upcoming Docusaurus v4
},

// TODO: Set the production url of your site here
url: 'https://oracle.github.io',
// Set the /<baseUrl>/ pathname under which your site is served
// For GitHub pages deployment, it is often '/<projectName>/'
baseUrl: '/oracle-db-appdev-monitoring/',

// GitHub pages deployment config.
// If you aren't using GitHub pages, you don't need these.
organizationName: 'oracle', // Usually your GitHub org/user name.
projectName: 'oracle-db-appdev-monitoring', // Usually your repo name.

onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',

// Even if you don't use internationalization, you can use this field to set
// useful metadata like html lang. For example, if your site is Chinese, you
// may want to replace "en" with "zh-Hans".
i18n: {
defaultLocale: 'en',
locales: ['en'],
},

presets: [
[
'classic',
{
docs: {
sidebarPath: './sidebars.ts',
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl:
'https://github.com/oracle/oracle-db-appdev-monitoring/tree/main/site/',
},
theme: {
customCss: './src/css/custom.css',
},
} satisfies Preset.Options,
],
],

themeConfig: {
// Replace with your project's social card
image: 'img/logo.png',
navbar: {
title: 'Oracle Database Monitoring Exporter',
logo: {
alt: 'Oracle Database Monitoring Exporter Logo',
src: 'img/logo_home.png',
},
items: [
{
type: 'docSidebar',
sidebarId: 'tutorialSidebar',
position: 'left',
label: 'Docs',
},
{
type: 'docsVersionDropdown',
versions: ['current']
},
{
href: 'https://github.com/oracle/oracle-db-appdev-monitoring',
label: 'GitHub',
position: 'right',
},
],
},
footer: {
style: 'dark',
links: [
{
title: 'Docs',
items: [
{
label: 'Tutorial',
to: '/docs/intro',
},
],
},
{
title: 'Community',
items: [
{
label: 'Stack Overflow',
href: 'https://stackoverflow.com/questions/tagged/oracle',
},
],
},
{
title: 'More',
items: [
{
label: 'Oracle Blogs',
to: 'https://blogs.oracle.com/',
},
{
label: 'Oracle LiveLabs',
to: 'https://livelabs.oracle.com/pls/apex/r/dbpm/livelabs/home'
},
{
label: 'GitHub',
href: 'https://github.com/oracle/oracle-db-appdev-monitoring',
},
],
},
],
copyright: `Copyright © ${new Date().getFullYear()}, Oracle and/or its affiliates. Built with ❤️ using Docusaurus.`,
},
prism: {
theme: prismThemes.github,
darkTheme: prismThemes.dracula,
},
} satisfies Preset.ThemeConfig,
};

export default config;
Loading