From e2bb29859c74a0d1223bb3aa65e652c541020719 Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Wed, 3 Jan 2024 11:10:40 -0500 Subject: [PATCH 01/13] Initial commit - config --- .gitignore | 3 ++ docs/.vitepress/config.ts | 29 +++++++++++++++++++ docs/GETTING_STARTED.md | 2 +- docs/development-guide/08-testing.md | 2 +- docs/index.md | 15 ++++++++++ docs/plugins/sidebar.ts | 40 +++++++++++++++++++++++++++ docs/public/akamai-wave.svg | 9 ++++++ docs/public/favicon.ico | Bin 0 -> 16958 bytes 8 files changed, 98 insertions(+), 2 deletions(-) create mode 100644 docs/.vitepress/config.ts create mode 100644 docs/index.md create mode 100644 docs/plugins/sidebar.ts create mode 100644 docs/public/akamai-wave.svg create mode 100644 docs/public/favicon.ico diff --git a/.gitignore b/.gitignore index 6a18d4bdabc..933adffc825 100644 --- a/.gitignore +++ b/.gitignore @@ -139,3 +139,6 @@ nohup.out packages/manager/bundle_analyzer_report.html **/manager/src/dev-tools/*.local.* + +# vitepress +docs/.vitepress/cache \ No newline at end of file diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts new file mode 100644 index 00000000000..ea31ec4e454 --- /dev/null +++ b/docs/.vitepress/config.ts @@ -0,0 +1,29 @@ +import { guides } from "../plugins/sidebar"; + +export default { + title: "Cloud Manager Docs", + description: "Akamai Cloud Manger Documentation", + srcDir: "./", + base: "/", + themeConfig: { + logo: "akamai-wave.svg", + nav: [ + { text: "Home", link: "/" }, + { text: "Getting Started", link: "/GETTING_STARTED" }, + { text: "Contributing", link: "/CONTRIBUTING" }, + ], + search: { + provider: "local", + }, + sidebar: [ + { + text: "Development Guide", + items: guides, + }, + ], + socialLinks: [ + { icon: "github", link: "https://github.com/linode/manager" }, + ], + }, + head: [["link", { rel: "icon", href: "/favicon.ico" }]], +}; diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index 0b09c94ba73..a7782f12663 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -40,7 +40,7 @@ ``` 10. Navigate to the root directory of the repository, then start Cloud Manager and the JS client with `yarn up`. -11. After installation, Cloud Manager should be running at http://localhost:3000. +11. After installation, Cloud Manager should be running at `http://localhost:3000`. ## Serving a production build of Cloud Manager diff --git a/docs/development-guide/08-testing.md b/docs/development-guide/08-testing.md index 5f817f1f662..6e8acfad960 100644 --- a/docs/development-guide/08-testing.md +++ b/docs/development-guide/08-testing.md @@ -142,7 +142,7 @@ const { getByTestId } = renderWithTheme(, { #### Mocking with Mock Service Worker -We support mocking API requests both in test suites and the browser using the [msw](https://www.npmjs.com/package/msw) library. See [07-mocking-data](07-mocking-data.md) for more details. +We support mocking API requests both in test suites and the browser using the [msw](https://www.npmjs.com/package/msw) library. See [07-mocking-data](09-mocking-data.md) for more details. These mocks are automatically enabled for tests (using `beforeAll` and `afterAll` in src/setupTests.ts, which is run when setting up the Vitest environment). diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000000..34cfad54ef4 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,15 @@ +# Akamai Cloud Manager Documentation + +## Get Started + +To setup cloud manager and get ready for development, process to the [get started docs](GETTING_STARTED.md). + +## Contributing + +If you already have your development environment set up, please read the [contributing guidelines](CONTRIBUTING.md) to get help in creating your first Pull Request. + +To report a bug or request a feature in Cloud Manager, please [open a GitHub Issue](https://github.com/linode/manager/issues/new). For general feedback, use [linode.com/feedback](https://www.linode.com/feedback/). + +## Development Guide + +Please consult our [development guide](development-guide/01-repository-structure.md) to start contributing! diff --git a/docs/plugins/sidebar.ts b/docs/plugins/sidebar.ts new file mode 100644 index 00000000000..a0aeed720e8 --- /dev/null +++ b/docs/plugins/sidebar.ts @@ -0,0 +1,40 @@ +import * as fs from "fs"; +import * as path from "path"; + +interface MarkdownInfo { + text: string; + link: string; +} + +function scanDirectory(directoryPath: string): MarkdownInfo[] { + const markdownFiles = fs + .readdirSync(directoryPath) + .filter((file) => file.endsWith(".md")); + const markdownInfoArray: MarkdownInfo[] = []; + + markdownFiles.forEach((file) => { + const filePath = path.join(directoryPath, file); + const fileContent = fs.readFileSync(filePath, "utf-8"); + + // Extract title from the Markdown file (assuming titles are specified with '#') + const titleMatch = fileContent.match(/^#\s+(.*)/m); + const title = titleMatch ? titleMatch[1] : "Untitled"; + + // Create object with "text" and "link" properties + const markdownInfo: MarkdownInfo = { + text: title, + link: `/development-guide/${file}`, // You can customize the link format as needed + }; + + markdownInfoArray.push(markdownInfo); + }); + + return markdownInfoArray; +} + +// Example usage +const directoryPath = "./docs/development-guide"; + +export const guides = scanDirectory(directoryPath); + +console.log(guides); diff --git a/docs/public/akamai-wave.svg b/docs/public/akamai-wave.svg new file mode 100644 index 00000000000..ecc82648017 --- /dev/null +++ b/docs/public/akamai-wave.svg @@ -0,0 +1,9 @@ + + + Shape + + + + + + \ No newline at end of file diff --git a/docs/public/favicon.ico b/docs/public/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..f2c712fdba4fd4e394f91f7eb8e80de2be06d3cd GIT binary patch literal 16958 zcmdskMS<;87oGE%yi%cz2Fj>~r`cMXvy^uH`G&2;; zGDE|n5Gp7VlL&j6QhFgl3(Sm&%`Kx+nzCr9X>Y%0=AO&(diUNl)83=kmH$5Hp7Xr@ z&pC7Mxo7U`I2ryG3J$-|cg9@nIA=SKGX_xQ6oJ&&erOv!ppJUQiTS;MgEJ6}2a~|< z;4ZKfbe@=ul8p+lAz(Im2J8YyfE$9H$!22DJKS2qo#2BIo;vsMXkQL4wU=FTk>DX? zy%rn=I?rJFW7?-Cmx*1^a2WtrgDMDe)vx!_KFMx&$wq_EEbvzh?|*1tm~19?y~C$J z*dD`M#$MLEVRo}iHX3{;fWtta+hOHZ$!22TJDhJb;4OVI$9{InMugJ>L+&>vn~8nz z@SbPLeTx0;l8p%OX@=ZS#W_C??s4~Z`Mj@4b`9G0Zw@X?lK2X)#uhv4EVoicU0^|gSY8@zF;RKyHVhOz+miOx0{unXz;$n zfV+I|Pq}@L^f0_WG~mD6&S=<;0&h8&)bH!Pl^5I1%uY18KWxZ&?sDR$)ysCdf=ZC(W`=xsSOa8LYp9&PmC^>cQQ!eX z{-YIt&rbSky{b#2B>x-1W)L;*(sl^6DUOuYK5@0GOQZC7yn~G6zeneX{wB{R)zAKL zcogjQxJ32AjsXANp3PdlK5b<<$Qu5w0sk$E8@lqH&(EICR#l%y35O@aL61w+_`jg| zp*sS|_d25gg{n`ZB>!gkkM+0_7jYzb(Y(q zoKMJmH-CdcQF+iF_r8{J^v^#iUjr0xUCxb)W223{WUepM@{4`P4Bdv#ztBGobZaqG zAN)q$xi)wPV-R-`koPIeK;?6NP%rEn{f5s!v3W|1qvDA??o5cf#b8NT?Eh1T&n&nB zYynlE=P|hv-`JJ{_PQ@s_Rqi3ofx6NPLGY=6+q^O_}Kt12dC>gre*9#gH9lv4+E8( zlJaae-qfGc!^ZUckDE1{H$vj8JeDdwCDDCO)0bz5_kp}0y9CSuw}R_{jOh%}0pznO zI&XtRK=}`oFVo&szedbuxH9_dJv+rU zOv?N_Px+#}!oWuS$eKMLWRz`RO8kxm^0`nsuW80V_IorR%2!YZ&qZG{uu(o_Uatig zH=F11O9a1s(j3xM*md<8)d8HL2Nbx;UIhKkzgQb z0kYQ=*#_j^A$d&(cY|laUZDKw@<-}JpLtC9iw^eFdhxBtk#dLblj{wJc0oVt`d{pi z0O^vF1_XWW| z7=!Is7W-jiSpI!c2M5#l-#dfxuG+v5Mu%ed*%qv)8oDu#jZbC1cGO0 zLEA>IW$l|4?C&J6iPs9Yg19_)p%c3PQZIi4xen|Daenl6Srp;J%K3viXDK89?^#1uzqIfW<)8wthDAbzQfT;}<{0x~w|wwac+;k~ZO53oo|%$8PQKRO;~*>T zz4ABO!59aggUA6~#{J6yt zPR=d2yT#hqH0^GwcHEJ7yRt?6EOX15691zEp`5b#!{I{?7B1uB)cUlT>yniGaZ}@{ N#?>v>8Mzga{{fCcRWkqp literal 0 HcmV?d00001 From f76f7060fc60a69d13e14f3ca8a8d0df30013f6b Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Wed, 3 Jan 2024 11:23:26 -0500 Subject: [PATCH 02/13] Add GHA --- .github/workflows/docs.yml | 47 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 00000000000..7a86a82ebe9 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,47 @@ +name: Deploy Cloud Manager Docs + +on: + push: + branches: [develop] + +permissions: + pages: write + id-token: write + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + + - name: Setup Node + uses: actions/setup-node@v3 + with: + node-version: 18 + cache: yarn + + - name: Setup Pages + uses: actions/configure-pages@v3 + + - name: Build with VitePress + run: | + npx vitepress build docs + touch docs/.vitepress/dist/.nojekyll + + - name: Upload artifact + uses: actions/upload-pages-artifact@v2 + with: + path: docs/.vitepress/dist + + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + needs: build + runs-on: ubuntu-latest + name: Deploy + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v2 \ No newline at end of file From 3d14d721e136cdee3a54e199a38cf930e94af3d6 Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Wed, 3 Jan 2024 11:49:12 -0500 Subject: [PATCH 03/13] cleanup --- docs/.vitepress/config.ts | 2 +- docs/plugins/sidebar.ts | 2 -- package.json | 3 ++- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index ea31ec4e454..2263a697a05 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -4,7 +4,7 @@ export default { title: "Cloud Manager Docs", description: "Akamai Cloud Manger Documentation", srcDir: "./", - base: "/", + base: "/manager/", themeConfig: { logo: "akamai-wave.svg", nav: [ diff --git a/docs/plugins/sidebar.ts b/docs/plugins/sidebar.ts index a0aeed720e8..da839bf38d3 100644 --- a/docs/plugins/sidebar.ts +++ b/docs/plugins/sidebar.ts @@ -36,5 +36,3 @@ function scanDirectory(directoryPath: string): MarkdownInfo[] { const directoryPath = "./docs/development-guide"; export const guides = scanDirectory(directoryPath); - -console.log(guides); diff --git a/package.json b/package.json index a4be2aceb0f..3d3884eeac7 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "changeset": "node scripts/changelog/changeset.mjs", "generate-changelogs": "node scripts/changelog/generate-changelogs.mjs", "coverage": "yarn workspace linode-manager coverage", - "coverage:summary": "yarn workspace linode-manager coverage:summary" + "coverage:summary": "yarn workspace linode-manager coverage:summary", + "docs": "npx vitepress dev docs" }, "resolutions": { "minimist": "^1.2.3", From f60611829198e957d0285133324d3c7bf54d5d03 Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Wed, 3 Jan 2024 11:53:28 -0500 Subject: [PATCH 04/13] cleanup --- docs/plugins/sidebar.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/plugins/sidebar.ts b/docs/plugins/sidebar.ts index da839bf38d3..d6ab8ce356a 100644 --- a/docs/plugins/sidebar.ts +++ b/docs/plugins/sidebar.ts @@ -16,14 +16,13 @@ function scanDirectory(directoryPath: string): MarkdownInfo[] { const filePath = path.join(directoryPath, file); const fileContent = fs.readFileSync(filePath, "utf-8"); - // Extract title from the Markdown file (assuming titles are specified with '#') const titleMatch = fileContent.match(/^#\s+(.*)/m); const title = titleMatch ? titleMatch[1] : "Untitled"; // Create object with "text" and "link" properties const markdownInfo: MarkdownInfo = { text: title, - link: `/development-guide/${file}`, // You can customize the link format as needed + link: `/development-guide/${file}`, }; markdownInfoArray.push(markdownInfo); From 390c7c408d96dd6113c77b6f51caf5225d51b10f Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Wed, 3 Jan 2024 11:54:43 -0500 Subject: [PATCH 05/13] clean comments --- docs/plugins/sidebar.ts | 2 -- 1 file changed, 2 deletions(-) diff --git a/docs/plugins/sidebar.ts b/docs/plugins/sidebar.ts index d6ab8ce356a..f3680289f0c 100644 --- a/docs/plugins/sidebar.ts +++ b/docs/plugins/sidebar.ts @@ -19,7 +19,6 @@ function scanDirectory(directoryPath: string): MarkdownInfo[] { const titleMatch = fileContent.match(/^#\s+(.*)/m); const title = titleMatch ? titleMatch[1] : "Untitled"; - // Create object with "text" and "link" properties const markdownInfo: MarkdownInfo = { text: title, link: `/development-guide/${file}`, @@ -31,7 +30,6 @@ function scanDirectory(directoryPath: string): MarkdownInfo[] { return markdownInfoArray; } -// Example usage const directoryPath = "./docs/development-guide"; export const guides = scanDirectory(directoryPath); From 7282826429b4430090ca477116b5c390f50c0d2e Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Wed, 3 Jan 2024 11:59:18 -0500 Subject: [PATCH 06/13] clean plugin --- docs/plugins/sidebar.ts | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/plugins/sidebar.ts b/docs/plugins/sidebar.ts index f3680289f0c..ac398c8e5fd 100644 --- a/docs/plugins/sidebar.ts +++ b/docs/plugins/sidebar.ts @@ -1,6 +1,8 @@ import * as fs from "fs"; import * as path from "path"; +const DEVELOPMENT_GUIDE_PATH = "./docs/development-guide"; + interface MarkdownInfo { text: string; link: string; @@ -30,6 +32,4 @@ function scanDirectory(directoryPath: string): MarkdownInfo[] { return markdownInfoArray; } -const directoryPath = "./docs/development-guide"; - -export const guides = scanDirectory(directoryPath); +export const guides = scanDirectory(DEVELOPMENT_GUIDE_PATH); From c23e5a6c978ec1bd5f348c851d3f230085415979 Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Wed, 3 Jan 2024 12:16:17 -0500 Subject: [PATCH 07/13] remove setup node --- .github/workflows/docs.yml | 6 ------ 1 file changed, 6 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 7a86a82ebe9..5c7c0d202cd 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -15,12 +15,6 @@ jobs: - name: Checkout uses: actions/checkout@v3 - - name: Setup Node - uses: actions/setup-node@v3 - with: - node-version: 18 - cache: yarn - - name: Setup Pages uses: actions/configure-pages@v3 From 586607928b683fbeec0a779d39eb7079744a4068 Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Wed, 3 Jan 2024 12:57:39 -0500 Subject: [PATCH 08/13] replace npx with bunx --- .github/workflows/docs.yml | 3 +-- package.json | 2 +- 2 files changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 5c7c0d202cd..79f3e44705d 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -20,8 +20,7 @@ jobs: - name: Build with VitePress run: | - npx vitepress build docs - touch docs/.vitepress/dist/.nojekyll + bunx vitepress@1.0.0-rc.35 build doc - name: Upload artifact uses: actions/upload-pages-artifact@v2 diff --git a/package.json b/package.json index 3d3884eeac7..6abe225524a 100644 --- a/package.json +++ b/package.json @@ -44,7 +44,7 @@ "generate-changelogs": "node scripts/changelog/generate-changelogs.mjs", "coverage": "yarn workspace linode-manager coverage", "coverage:summary": "yarn workspace linode-manager coverage:summary", - "docs": "npx vitepress dev docs" + "docs": "bunx vitepress@1.0.0-rc.35 dev docs" }, "resolutions": { "minimist": "^1.2.3", From 5cadd6747403684a0d6e47c846a1c6e476a21fed Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Wed, 3 Jan 2024 13:21:58 -0500 Subject: [PATCH 09/13] fix assets paths --- .github/workflows/docs.yml | 6 +++++- docs/.vitepress/config.ts | 4 ++-- 2 files changed, 7 insertions(+), 3 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 79f3e44705d..03a0c168797 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -18,9 +18,13 @@ jobs: - name: Setup Pages uses: actions/configure-pages@v3 + - uses: oven-sh/setup-bun@v1 + with: + bun-version: 1.0.21 + - name: Build with VitePress run: | - bunx vitepress@1.0.0-rc.35 build doc + bunx vitepress@1.0.0-rc.35 build docs - name: Upload artifact uses: actions/upload-pages-artifact@v2 diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index 2263a697a05..f39d515dc40 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -6,7 +6,7 @@ export default { srcDir: "./", base: "/manager/", themeConfig: { - logo: "akamai-wave.svg", + logo: "/akamai-wave.svg", nav: [ { text: "Home", link: "/" }, { text: "Getting Started", link: "/GETTING_STARTED" }, @@ -25,5 +25,5 @@ export default { { icon: "github", link: "https://github.com/linode/manager" }, ], }, - head: [["link", { rel: "icon", href: "/favicon.ico" }]], + head: [["link", { rel: "icon", href: "/manager/favicon.ico" }]], }; From dea3b1d08cf440ef2432c956eaa8905078ee9bd4 Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Wed, 3 Jan 2024 14:21:40 -0500 Subject: [PATCH 10/13] Added changeset: Cloud Manager Documentation microsite with vitepress --- packages/manager/.changeset/pr-10027-added-1704309699899.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 packages/manager/.changeset/pr-10027-added-1704309699899.md diff --git a/packages/manager/.changeset/pr-10027-added-1704309699899.md b/packages/manager/.changeset/pr-10027-added-1704309699899.md new file mode 100644 index 00000000000..768d2b13bbf --- /dev/null +++ b/packages/manager/.changeset/pr-10027-added-1704309699899.md @@ -0,0 +1,5 @@ +--- +"@linode/manager": Added +--- + +Cloud Manager Documentation microsite with vitepress ([#10027](https://github.com/linode/manager/pull/10027)) From 62d1f06669c0135c0f4cb45ff27643f445850c43 Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Wed, 3 Jan 2024 14:23:19 -0500 Subject: [PATCH 11/13] fix typo --- docs/development-guide/08-testing.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/development-guide/08-testing.md b/docs/development-guide/08-testing.md index 6e8acfad960..91df0ddcad1 100644 --- a/docs/development-guide/08-testing.md +++ b/docs/development-guide/08-testing.md @@ -142,7 +142,7 @@ const { getByTestId } = renderWithTheme(, { #### Mocking with Mock Service Worker -We support mocking API requests both in test suites and the browser using the [msw](https://www.npmjs.com/package/msw) library. See [07-mocking-data](09-mocking-data.md) for more details. +We support mocking API requests both in test suites and the browser using the [msw](https://www.npmjs.com/package/msw) library. See [09-mocking-data](09-mocking-data.md) for more details. These mocks are automatically enabled for tests (using `beforeAll` and `afterAll` in src/setupTests.ts, which is run when setting up the Vitest environment). From 3d97408c0025e55a0c3c110e71ab3738f34a54d7 Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Thu, 4 Jan 2024 10:05:36 -0500 Subject: [PATCH 12/13] Feedback --- docs/.vitepress/config.ts | 2 +- docs/{ => .vitepress}/plugins/sidebar.ts | 7 +++++-- docs/CONTRIBUTING.md | 4 ++++ docs/GETTING_STARTED.md | 2 +- docs/index.md | 2 +- 5 files changed, 12 insertions(+), 5 deletions(-) rename docs/{ => .vitepress}/plugins/sidebar.ts (84%) diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts index f39d515dc40..282a8016c1d 100644 --- a/docs/.vitepress/config.ts +++ b/docs/.vitepress/config.ts @@ -1,4 +1,4 @@ -import { guides } from "../plugins/sidebar"; +import { guides } from "./plugins/sidebar"; export default { title: "Cloud Manager Docs", diff --git a/docs/plugins/sidebar.ts b/docs/.vitepress/plugins/sidebar.ts similarity index 84% rename from docs/plugins/sidebar.ts rename to docs/.vitepress/plugins/sidebar.ts index ac398c8e5fd..94152e87047 100644 --- a/docs/plugins/sidebar.ts +++ b/docs/.vitepress/plugins/sidebar.ts @@ -8,7 +8,10 @@ interface MarkdownInfo { link: string; } -function scanDirectory(directoryPath: string): MarkdownInfo[] { +/** + * Aggregates the pages in the development-guide and populates the left sidebar. + */ +const scanDirectory = (directoryPath: string): MarkdownInfo[] => { const markdownFiles = fs .readdirSync(directoryPath) .filter((file) => file.endsWith(".md")); @@ -30,6 +33,6 @@ function scanDirectory(directoryPath: string): MarkdownInfo[] { }); return markdownInfoArray; -} +}; export const guides = scanDirectory(DEVELOPMENT_GUIDE_PATH); diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 92f1030604a..1d3cf06f7aa 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -38,3 +38,7 @@ Feel free to open an issue to report a bug or request a feature. `Added`, `Fixed`, `Changed`, `Removed`, `Tech Stories`, `Tests`, `Upcoming Features` Two reviews from members of the Cloud Manager team are required before merge. After approval, all pull requests are squash merged. + +## Docs + +To run the docs development server locally, [install Bun](https://bun.sh/) and start the server: `yarn docs`. diff --git a/docs/GETTING_STARTED.md b/docs/GETTING_STARTED.md index a7782f12663..f005663f28e 100644 --- a/docs/GETTING_STARTED.md +++ b/docs/GETTING_STARTED.md @@ -63,4 +63,4 @@ expose the Vite dev server, you can use the following command. ```bash yarn up:expose -``` \ No newline at end of file +``` diff --git a/docs/index.md b/docs/index.md index 34cfad54ef4..4330146c382 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ ## Get Started -To setup cloud manager and get ready for development, process to the [get started docs](GETTING_STARTED.md). +To setup Cloud Manager and get ready for development, process to the [get started docs](GETTING_STARTED.md). ## Contributing From 5bb2fda0bd418f49bd7bab6ca10d1018fa466bd5 Mon Sep 17 00:00:00 2001 From: Alban Bailly Date: Thu, 4 Jan 2024 10:16:01 -0500 Subject: [PATCH 13/13] Feedback 2 --- .github/workflows/docs.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 03a0c168797..0f73e3e58b6 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -23,8 +23,7 @@ jobs: bun-version: 1.0.21 - name: Build with VitePress - run: | - bunx vitepress@1.0.0-rc.35 build docs + run: bunx vitepress@1.0.0-rc.35 build docs - name: Upload artifact uses: actions/upload-pages-artifact@v2