Skip to content

[ENH] - Render advanced config docs from nebari's JSON schema models #453

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.

Sign up for GitHub

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

Draft
wants to merge 14 commits into
base: main
Choose a base branch
from
Draft

[ENH] - Render advanced config docs from nebari's JSON schema models #453

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
2e811af
add URL download and render templated mdx
viniciusdc May 6, 2024
574e539
update component logic
viniciusdc May 6, 2024
7d56656
update schema rendering & support for local run
viniciusdc May 7, 2024
df316ff
Update schema mdx render components
viniciusdc May 7, 2024
b2b4873
update schema rendering
viniciusdc May 7, 2024
9f19620
add toc back and some fixes
viniciusdc May 8, 2024
ca249b5
enable PR preview
viniciusdc May 8, 2024
a20b780
udpate react component for better grouping and nested anyOf properties
viniciusdc May 9, 2024
217aed1
updates
viniciusdc May 9, 2024
b8a2456
update to render example & better defaults
viniciusdc May 31, 2024
73aebb8
Delete docs/static/nebari-config-schema.json
viniciusdc May 31, 2024
9e9ab04
Include right-side toc
viniciusdc Jun 3, 2024
61a4d9b
Merge branch 'main' into nebari-config-schema
viniciusdc Jun 3, 2024
ab3d893
disable schema local import
viniciusdc Jun 3, 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
12 changes: 12 additions & 0 deletions docs/docs/explanations/nebari-yaml-schema.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
---
title: 'Configuring nebari-config.yaml'
id: nebari-yaml-schema
---

# Configuration Schema

This section includes the Nebari configuration schema loaded dynamically below:

import NebariConfig from '@site/src/components/NebariSchemaLoader';

<NebariConfig toc={toc} />
5 changes: 4 additions & 1 deletion docs/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,16 @@
"@docusaurus/core": "2.0.0-beta.20",
"@docusaurus/preset-classic": "2.0.0-beta.20",
"@mdx-js/react": "^1.6.22",
"@stoplight/json-ref-resolver": "^3.1.6",
"clsx": "^1.1.1",
"docusaurus-lunr-search": "^2.1.15",
"docusaurus-plugin-sass": "^0.2.2",
"prism-react-renderer": "^1.3.5",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"sass": "^1.52.1"
"sass": "^1.52.1",
"react-markdown": "^8.0.7",
"remark-gfm": "^4.0.0"
},
"devDependencies": {
"@babel/eslint-parser": "^7.18.2",
Expand Down
1 change: 1 addition & 0 deletions docs/sidebars.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,7 @@ module.exports = {
"explanations/custom-overrides-configuration",
"explanations/config-best-practices",
"explanations/infrastructure-architecture",
"explanations/nebari-yaml-schema",
],
},
{
Expand Down
Loading