Skip to content

Commit af51b53

Browse files
alegaussalegauss
committed
Add Shio CMS docs, config and CI PDF steps
Introduce a complete Shio CMS documentation section and integrate PDF generation into CI. Adds many docs under docs-shio (administration, architecture, configuration reference, content modeling, getting-started, graphql, import-export, rest-api, search-caching, security, website-development, index.mdx) and reorganizes developer-guide. Updates site config and sidebars (docusaurus.config.js/ts, sidebars-shio.ts), page/theme components (src/pages/index.tsx, src/theme/Navbar/index.tsx) and package.json. Adds PDF generation scripts (scripts/gen-pdf-shio.mjs, scripts/pdf-cover-shio.html) and updates .github/workflows/deploy.yml to build and include the Shio CMS PDF artifact. Removes obsolete docs (download.md, index.md, release-notes.md).
1 parent 019dfd2 commit af51b53

27 files changed

Lines changed: 3736 additions & 285 deletions

‎.github/workflows/deploy.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,17 +46,22 @@ jobs:
4646
run: |
4747
npx wait-on http://localhost:3000/turing/getting-started/intro --timeout 60000
4848
npx wait-on http://localhost:3000/dumont/getting-started/intro --timeout 60000
49+
npx wait-on http://localhost:3000/shio/getting-started/intro --timeout 60000
4950
5051
- name: Generate Turing ES documentation PDF
5152
run: npm run gen-pdf
5253

5354
- name: Generate Dumont DEP documentation PDF
5455
run: npm run gen-pdf-dumont
5556

57+
- name: Generate Shio CMS documentation PDF
58+
run: npm run gen-pdf-shio
59+
5660
- name: Copy PDFs into build folder
5761
run: |
5862
cp turing-es-2026.1-documentation.pdf build/
5963
cp dumont-dep-2026.1-documentation.pdf build/
64+
cp shio-cms-2026.1-documentation.pdf build/
6065
6166
- name: Upload artifact
6267
uses: actions/upload-pages-artifact@v3

‎docs-shio/administration-guide.md‎

Lines changed: 187 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,187 @@
1+
---
2+
sidebar_position: 1
3+
title: Administration Guide
4+
description: Users, groups, roles, permissions, site properties and system settings in Viglet Shio CMS.
5+
---
6+
7+
# Administration Guide
8+
9+
This guide covers the administration features of Shio CMS — user management, permissions, site configuration, and system settings.
10+
11+
---
12+
13+
## Users
14+
15+
Administrators can **create, modify, and delete** users through the admin console. Users can access the admin console and/or protected pages on the published site.
16+
17+
### Default User
18+
19+
On first startup, Shio CMS creates a default administrator account:
20+
21+
| Field | Value |
22+
|---|---|
23+
| **Username** | `admin` |
24+
| **Password** | `admin` |
25+
26+
:::warning
27+
Change the default password immediately after first login.
28+
:::
29+
30+
### User Properties
31+
32+
Each user has:
33+
- Username and password
34+
- Email address
35+
- Full name
36+
- Group memberships
37+
38+
---
39+
40+
## Groups
41+
42+
**Groups** organize users into logical sets for permission management. You can:
43+
44+
- Create, modify, and delete groups
45+
- Add or remove users from groups
46+
- Assign groups to console or page permissions
47+
48+
---
49+
50+
## Permissions
51+
52+
Shio CMS provides two levels of permissions:
53+
54+
### Console Permissions
55+
56+
Control who can access the admin console and its features. Assign **groups and users** to console permissions to restrict access to administration functions.
57+
58+
### Page Permissions
59+
60+
Control who can view specific pages on the published site. Assign **groups and users** to page permissions to create **protected pages** that require authentication.
61+
62+
:::info
63+
Protected pages use the users defined in the Administration section for authentication. Visitors must log in with valid credentials to access protected content.
64+
:::
65+
66+
---
67+
68+
## Site Properties
69+
70+
Each site has configurable properties accessible through the admin console:
71+
72+
| Property | Description |
73+
|---|---|
74+
| **Name** | Site display name |
75+
| **Description** | Site description |
76+
| **URL** | Base URL for the published site |
77+
| **Post Type / Page Layout** | Association between Post Types and their rendering Page Layouts |
78+
| **Searchable content** | Which content is indexed for search |
79+
| **Form folder** | Folder where form submissions are saved |
80+
81+
---
82+
83+
## Site Management
84+
85+
### Creating a Site
86+
87+
1. Navigate to **Sites** in the admin console
88+
2. Click **New Site**
89+
3. Configure site properties
90+
4. Choose a pre-defined theme or create a custom one
91+
92+
### Importing a Site
93+
94+
Import a previously exported site package:
95+
1. Navigate to **Sites**
96+
2. Click **Import Site**
97+
3. Upload the site package file
98+
99+
### Downloading a Site
100+
101+
Export a site as a package for backup or migration:
102+
1. Navigate to the site in the admin console
103+
2. Click **Download Site**
104+
3. The site package includes all content, folders, themes, and configuration
105+
106+
---
107+
108+
## Content Administration
109+
110+
### Folder Management
111+
112+
- **Create folders** — organize content hierarchically
113+
- **Reorder posts** — drag-and-drop reordering with instant results on site pages
114+
- **Change folder view** — switch between List and Thumbnail views
115+
- **Navigate via breadcrumb** — browse folders through the breadcrumb navigation
116+
- **Upload files** — upload multiple files into a folder at once
117+
118+
### Spreadsheet Export
119+
120+
Generate a **spreadsheet** of a folder's contents. Each Post Type in the folder becomes a separate sheet with columns for each field. Useful for bulk content review and reporting.
121+
122+
### Version Control
123+
124+
Shio CMS integrates with **Git** for content version control. You can see all commit changes of a site and track content modifications over time.
125+
126+
Configure Git integration in the [Configuration Reference](./configuration-reference.md):
127+
128+
```properties
129+
shio.git.url=https://github.com/your-org/your-repo.git
130+
shio.git.token=YOUR_TOKEN
131+
```
132+
133+
### Workflows
134+
135+
Create **workflows** for content approval processes. Workflows define approval steps that content must pass through before publication.
136+
137+
---
138+
139+
## Configuration Console
140+
141+
The Configuration Console provides access to system-wide settings:
142+
143+
### Auth Providers
144+
145+
Configure authentication providers:
146+
147+
| Provider | Description |
148+
|---|---|
149+
| **Shio Native** | Built-in username/password authentication |
150+
| **OTDS** | OpenText Directory Service integration |
151+
152+
### Exchange Providers
153+
154+
Configure content exchange providers for import/export:
155+
156+
| Provider | Description |
157+
|---|---|
158+
| **OTCS** | OpenText Content Services — import documents |
159+
| **OTMM** | OpenText Media Management — import media files |
160+
161+
### Search Providers
162+
163+
Configure how site search works — connect to Viglet Turing ES for advanced search capabilities.
164+
165+
### Email
166+
167+
Configure the **email service** for notifications:
168+
169+
```properties
170+
spring.mail.host=smtp.example.com
171+
spring.mail.port=587
172+
spring.mail.username=shio@example.com
173+
spring.mail.password=secret
174+
```
175+
176+
---
177+
178+
## Related Pages
179+
180+
| Page | Description |
181+
|---|---|
182+
| [Security](./security.md) | Authentication and authorization details |
183+
| [Configuration Reference](./configuration-reference.md) | All application.properties settings |
184+
| [Import & Export](./import-export.md) | Exchange providers and content migration |
185+
| [Installation Guide](./installation-guide.md) | Setup and first-time configuration |
186+
187+
---

0 commit comments

Comments
 (0)