Skip to content

Commit 0cf7195

Browse files
committed
CSPL-4237 Improve documentation pages
- Introduced a GitHub Actions workflow for previewing documentation changes. - Added configuration files for Jekyll-based documentation site. - Created a .gitignore file for the docs directory to exclude build artifacts. - Updated multiple documentation files with front matter for better organization and navigation. - Enhanced existing documentation with additional sections on deployment, health checks, and security considerations.
1 parent 72dc0e6 commit 0cf7195

34 files changed

+635
-359
lines changed

.github/workflows/docs-preview.yml

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
name: Docs Preview
2+
3+
on:
4+
pull_request:
5+
paths:
6+
- 'docs/**'
7+
- '.github/workflows/docs-preview.yml'
8+
- 'README.md'
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
concurrency:
16+
group: "pages-preview-${{ github.event.pull_request.number || github.run_id }}"
17+
cancel-in-progress: true
18+
19+
jobs:
20+
build:
21+
name: Build docs
22+
runs-on: ubuntu-latest
23+
steps:
24+
- name: Checkout
25+
uses: actions/checkout@v4
26+
- name: Setup GitHub Pages
27+
uses: actions/configure-pages@v5
28+
- name: Build with Jekyll
29+
uses: actions/jekyll-build-pages@v1
30+
with:
31+
source: ./docs
32+
destination: ./_site
33+
- name: Upload GitHub Pages artifact
34+
uses: actions/upload-pages-artifact@v3
35+
36+
deploy:
37+
name: Publish preview
38+
needs: build
39+
runs-on: ubuntu-latest
40+
environment:
41+
name: github-pages
42+
url: ${{ steps.deployment.outputs.page_url }}
43+
steps:
44+
- name: Deploy to GitHub Pages
45+
id: deployment
46+
uses: actions/deploy-pages@v4
47+
with:
48+
preview: true

README.md

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

docs/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
_site/
2+
.bundle/
3+
Gemfile.lock

docs/AppFramework.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: App Framework
3+
parent: Operate & Manage
4+
nav_order: 2
5+
---
6+
7+
18
# App Framework Resource Guide
29

310
- [About App Framework](#about-app-framework)
@@ -1647,4 +1654,4 @@ INFO initAndCheckAppInfoStatus Apps List retrieved from remote storage {"control
16471654
Keep in mind that based on the `appsRepoStatusPollIntervalSeconds`, it might take some time for the apps to get updated. Please wait the required amount of time for the app framework to poll the latest versions from storage.
16481655

16491656
### App is not correctly copying to pod
1650-
If an app is packaged on a Mac, there might be issues extracting the contents on the running pod. If there are issues installing apps that were packaged manually, ensure that they can be extracted in a Linux environment before uploading it to the remote storage.
1657+
If an app is packaged on a Mac, there might be issues extracting the contents on the running pod. If there are issues installing apps that were packaged manually, ensure that they can be extracted in a Linux environment before uploading it to the remote storage.

docs/BiasLanguageMigration.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,10 @@
1+
---
2+
title: Bias Language Migration
3+
parent: Reference
4+
nav_order: 4
5+
---
6+
7+
18
# FAQ - Biased Language Migration
29

310

0 commit comments

Comments
 (0)