Skip to content

Commit 1b9264b

Browse files
rafmudafrafmudaf
authored
Merge pull request NatLabRockies#8 from NREL/entry_guide
Add Entry Guide page to the docs
2 parents 31c62a7 + d328eaa commit 1b9264b

38 files changed

Lines changed: 4050 additions & 3 deletions

‎.github/workflows/deploy-pages.yaml‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ concurrency:
2828
group: "pages"
2929
cancel-in-progress: false
3030

31-
# This job installs dependencies, builds the book, and pushes it to `gh-pages`
31+
# This job installs dependencies, builds the site, and pushes it to `gh-pages`
3232
jobs:
3333
build:
3434
runs-on: ubuntu-latest
@@ -46,7 +46,15 @@ jobs:
4646
sudo apt-get install graphviz graphviz-dev
4747
pip install --upgrade pip
4848
pip install -r requirements.txt
49-
- name: Build the book
49+
# Build the Vue app first, and then move it to the docs/_static folder so that it's included
50+
# in the JupyterBook build.
51+
- name: Build the Vue app
52+
working-directory: ${{runner.workspace}}/WETOStack/entry_guide
53+
run: |
54+
npm install
55+
npm run build
56+
mv dist ../docs/_static/entry_guide
57+
- name: Build the JupyterBook
5058
working-directory: ${{runner.workspace}}/WETOStack/docs/
5159
run: |
5260
jupyter-book build .

‎docs/_toc.yml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ parts:
88
- caption: The Portfolio
99
chapters:
1010
- file: portfolio_analysis/overview
11+
- url: https://nrel.github.io/WETOStack/_static/entry_guide/index.html
12+
title: Entry Guide - Graph
1113
- file: portfolio_analysis/software_list
1214
sections:
1315
- file: portfolio_analysis/software_other
@@ -16,12 +18,13 @@ parts:
1618
- file: portfolio_analysis/map_network
1719
- file: portfolio_analysis/attributes_schema
1820

21+
1922
- caption: Software Quality
2023
chapters:
2124
- file: software_dev/rubric
2225
- file: software_dev/best_practices
2326
- file: software_dev/developer_resources
24-
27+
2528
- caption: Engagement Notes
2629
chapters:
2730
- file: activity/updates

‎entry_guide/.gitignore‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
# Logs
2+
logs
3+
*.log
4+
npm-debug.log*
5+
yarn-debug.log*
6+
yarn-error.log*
7+
pnpm-debug.log*
8+
lerna-debug.log*
9+
10+
node_modules
11+
dist
12+
dist-ssr
13+
*.local
14+
.vite/
15+
16+
# Editor directories and files
17+
.vscode/*
18+
!.vscode/extensions.json
19+
.idea
20+
.DS_Store
21+
*.suo
22+
*.ntvs*
23+
*.njsproj
24+
*.sln
25+
*.sw?

‎entry_guide/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Vue 3 + TypeScript + Vite
2+
3+
This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
4+
5+
Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).

‎entry_guide/index.html‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<!-- <link rel="icon" type="image/svg+xml" href="/vite.svg" /> -->
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>WETO Stack Entry Guide</title>
8+
</head>
9+
<body>
10+
<div id="app"></div>
11+
<script type="module" src="/src/main.ts"></script>
12+
</body>
13+
</html>

0 commit comments

Comments
 (0)