Skip to content

Commit dc8a355

Browse files
authored
Merge branch '4.0.x' into patch-32
2 parents 11d6b17 + 8a704a7 commit dc8a355

File tree

28 files changed

+740
-515
lines changed

28 files changed

+740
-515
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+

.docsearch/config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
"version": [
99
"docs",
1010
"4.0.x",
11-
"5.13.0"
11+
"5.14.0"
1212
]
1313
}
1414
}

.github/copilot-instructions.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# GitHub Copilot Instructions for Rundeck Documentation
2+
3+
You are an AI assistant helping maintain the Rundeck documentation site.
4+
5+
## Project Context
6+
- This repository contains documentation for Rundeck, an open-source job scheduler and runbook automation tool
7+
- Documentation is primarily written in Markdown and organized by product versions
8+
- Documentation follows a specific structure with product versions, features, and administration guides
9+
- Documentation is built using VuePress 2 and the Hope Theme.
10+
11+
## Key Documentation Guidelines
12+
- Use clear, concise language
13+
- Follow technical writing best practices
14+
- Include practical examples where appropriate
15+
- Ensure all code examples are properly formatted and functional
16+
- Maintain consistent terminology throughout the documentation
17+
- Use proper heading hierarchy (H1 > H2 > H3)
18+
- Include descriptive alt text for images
19+
20+
## Common Tasks
21+
- Creating new documentation pages
22+
- Updating existing documentation for new releases
23+
- Fixing formatting issues in Markdown files
24+
- Improving code examples
25+
- Enhancing clarity of technical explanations
26+
- Cross-referencing related documentation
27+
28+
## Directory Structure
29+
- `/docs/` - Main documentation content
30+
- `/docs/manual/` - Core product documentation
31+
- `/docs/administration/` - Administration guides
32+
- `/docs/api/` - API documentation
33+
- `/docs/developer/` - Developer documentation
34+
- `/docs/learning/` - Tutorials and learning resources
35+
36+
## Markdown Guidelines
37+
- Use ATX-style headers (`#` for H1, `##` for H2)
38+
- Code blocks should specify language for proper syntax highlighting
39+
- Use numbered lists for sequential steps
40+
- Use bullet points for non-sequential items
41+
- Tables should have headers and consistent column formatting

.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.

0 commit comments

Comments
 (0)