Skip to content

Commit a895f6d

Browse files
committed
Merge branch '4.0.x' into RUN-3601-CVE-2025-48924
2 parents d6dc28e + e038910 commit a895f6d

21 files changed

+583
-395
lines changed

.circleci/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ jobs:
66
build:
77
docker:
88
# specify the version you desire here
9-
- image: cimg/node:18.19.0
9+
- image: cimg/node:22.12.0
1010
environment:
1111
NODE_OPTIONS="--max-old-space-size=6144"
1212
resource_class: medium+

.nvmrc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
18.19.0
1+
22.12.0

README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Rundeck Documentation
22
Rundeck Documentation project.
33

4-
## Getting starting
4+
## Getting Started
55

66
### Dependencies
7-
* NodeJS `lts/hydrogen` or version `18.19.0` is the currently supported and only version that should be used.
7+
* NodeJS version `22.12.0` is the currently supported and only version that should be used.
88
* NVM is helpful in making sure your machine is using the currently supported versions as we upgrade in the future.
99

1010
### Recommended setup steps
@@ -18,10 +18,7 @@ After setting the proper Node version, run this `npm` command before the first y
1818
npm install
1919
```
2020

21-
## API Documentation Guidelines
22-
23-
Our API Documentation is now handled by OpenAPI spec and presented using Swagger UI.
24-
21+
>Note: It may be helpful to delete any existing `node_modules` folder and the `package-lock.json` file before running npm install.
2522
2623
# How To
2724

@@ -78,6 +75,13 @@ git checkout -b 3.2.8
7875
git push origin
7976
```
8077

78+
## Documentation Structure
79+
80+
The documentation is organized as follows:
81+
- `/docs/` - Main documentation content
82+
- `/docs/.vuepress/` - VuePress configuration
83+
- `/docs/.vuepress/public/assets/img/` - Images Folder
84+
8185
# How to Create Release Notes
8286

8387
Rundeck Core PRs are included by default.

docs/.vuepress/client.ts

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
import { defineClientConfig } from '@vuepress/client'
22
import '@docsearch/css'
3+
import Layout from "./layouts/Layout.vue";
4+
import NotFound from "./layouts/NotFound.vue";
35

46
declare const VERSION: string;
57
declare const VERSION_FULL: string;
@@ -11,6 +13,10 @@ declare const CLI_VERSION: string;
1113

1214

1315
export default defineClientConfig({
16+
layouts: {
17+
Layout,
18+
NotFound,
19+
},
1420
enhance({ app, router, siteData }) {
1521
Object.defineProperties(app.config.globalProperties, {
1622
$rundeckVersion: { get: () => VERSION },

docs/.vuepress/components/CustomNavBar.vue

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/.vuepress/components/HomePageAnnounce.vue

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/.vuepress/components/SidebarAnnounce.vue

Lines changed: 0 additions & 14 deletions
This file was deleted.

docs/.vuepress/components/notFoundCustom.vue

Lines changed: 0 additions & 19 deletions
This file was deleted.

docs/.vuepress/config.ts

Lines changed: 1 addition & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@ import { registerComponentsPlugin } from '@vuepress/plugin-register-components';
99
import { dateSorter } from "@vuepress/helper";
1010
import { googleAnalyticsPlugin } from '@vuepress/plugin-google-analytics';
1111
import { removePwaPlugin } from '@vuepress/plugin-remove-pwa';
12-
import { prismjsPlugin } from '@vuepress/plugin-prismjs';
1312

1413
// sidebars
1514
import sidebarAdmin from './sidebar-menus/administration'
@@ -97,7 +96,7 @@ export default defineUserConfig({
9796

9897
//Theme Config
9998
theme: hopeTheme({
100-
debug: true,
99+
debug: process.env.NODE_ENV === 'development',
101100
logo: '/images/RundeckbyPagerDuty.svg',
102101
repo: 'rundeck/docs',
103102
docsDir: 'docs',
@@ -322,24 +321,6 @@ export default defineUserConfig({
322321
},
323322
{ custom: true },
324323
),
325-
alias: {
326-
"@theme-hope/components/HomePage": path.resolve(
327-
__dirname,
328-
"./components/HomePageAnnounce.vue",
329-
),
330-
"@theme-hope/modules/sidebar/components/Sidebar": path.resolve(
331-
__dirname,
332-
"./components/SidebarAnnounce.vue",
333-
),
334-
"@theme-hope/layouts/NotFound": path.resolve(
335-
__dirname,
336-
"./components/notFoundCustom.vue",
337-
),
338-
"@theme-hope/modules/navbar/components/Navbar": path.resolve(
339-
__dirname,
340-
"./components/CustomNavBar.vue",
341-
),
342-
},
343324
//Plugins Config
344325
plugins: [
345326
removePwaPlugin({

docs/.vuepress/layouts/Layout.vue

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
<script setup lang="ts">
2+
import { Layout } from "vuepress-theme-hope/client";
3+
import { usePageData } from "@vuepress/client";
4+
import { computed } from "vue";
5+
6+
const pageData = usePageData();
7+
const isHomePage = computed(() => pageData.value.frontmatter.home === true);
8+
</script>
9+
10+
<template>
11+
<Layout>
12+
<!-- Adding announcement before content (works on all pages) -->
13+
<template #heroAfter>
14+
<div v-if="isHomePage"class="homepage-announce">
15+
<p>
16+
<b>The <i>resources.rundeck.com</i> site has been consolidated here! Check our our <a href='/learning/solutions/'>Solutions</a> page for Automation use cases. </b>
17+
</p>
18+
</div>
19+
</template>
20+
21+
<!-- Adding announcement to sidebar -->
22+
<template #sidebarTop>
23+
<div v-if="!isHomePage" class="sidebar-announce">
24+
<p>
25+
<b>Process Automation On Prem</b> is now <b>Runbook Automation Self-Hosted</b>
26+
</p>
27+
</div>
28+
</template>
29+
</Layout>
30+
</template>

0 commit comments

Comments
 (0)