Skip to content

Commit 91f1ea9

Browse files
iamianmullinsiamianmullins
committed
Revise readthedocs content
- Minimize RTD content to serve as an appropriate starting point to improve structure. - Add documentation-link workflow which links readthedocs preview in the pr Signed-off-by: Ian Mullins <imullins@redhat.com>
1 parent 974f65b commit 91f1ea9

7 files changed

Lines changed: 80 additions & 4 deletions

File tree

‎.github/workflows/documentation-link.yaml‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Provide ReadtheDocs preview links for PRs
2+
on:
3+
pull_request:
4+
types:
5+
- opened
6+
- edited
7+
- reopened
8+
- synchronize
9+
paths:
10+
- "docs/**"
11+
12+
permissions:
13+
pull-requests: write
14+
15+
jobs:
16+
documentation-links:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- name: Post comment
20+
env:
21+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
22+
PR_NUMBER: ${{ github.event.pull_request.number }}
23+
PROJECT_SLUG: qm
24+
run: |
25+
curl -X POST -H "Authorization: Bearer $GITHUB_TOKEN" \
26+
-d '{"body":":book: Documentation preview: https://${{env.PROJECT_SLUG}}--${{env.PR_NUMBER}}.org.readthedocs.build/en/${{env.PR_NUMBER}}/ :book:"}' \
27+
"https://api.github.com/repos/${{ github.repository }}/issues/$PR_NUMBER/comments"

‎README.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -209,7 +209,7 @@ Looking for quadlet examples files? See our [docs dir](docs/quadlet-examples/).
209209

210210
## Development
211211

212-
If your looking for contribute to the project use our [development README guide](docs/devel/README.md) as start point.
212+
If you're looking to contribute to the project, use our [development README guide](docs/devel/README.md) to help you get started.
213213

214214
## Realtime
215215

‎docs/devel/experimental/SUBPACKAGES.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -212,7 +212,7 @@ hw:1,0: sound card 1, device 0
212212
213213
We recommend using the existing drop-in files as a guide and adapting them to your specific needs. However, here are the step-by-step instructions:
214214
215-
Please refer [Creating your own drop-in QM sub-package](docs/devel/README.md#creating-your-own-dropin-qm-subpackage)
215+
Please refer [Creating your own drop-in QM sub-package](/docs/devel/README.md#creating-your-own-dropin-qm-subpackage)
216216
217217
## QM sub-package ROS2
218218

‎docs/docs/getting_started/installation.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
## Installing QM
2+
3+
The first step to getting started with QM is installation.
4+
5+
Fedora or CentOS¶
6+
On Fedora and CentOS-Stream systems (with EPEL repository enabled), QM can be directly installed via:
7+
8+
```bash
9+
dnf install qm
10+
```
11+
12+
## RPM Mirrors
13+
14+
Looking for a specific version of QM?
15+
Search in the mirrors list below.
16+
17+
[CentOS Automotive SIG - qm package - noarch](https://mirror.stream.centos.org/SIGs/9-stream/automotive/aarch64/packages-main/Packages/q/)

‎docs/docs/index.md‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# QM
2+
3+
## QM is a containerized environment for running Functional Safety QM (Quality Management) software
4+
5+
The main purpose of this package is to allow users to set up an environment which
6+
prevents applications and container tools from interfering with other processes
7+
on the system. For example ASIL (Automotive Safety Integrity Level) environments.
8+
9+
The QM environment uses containerization tools like cgroups, namespaces, and
10+
security isolation to prevent accidental interference by processes in the qm.
11+
12+
The QM will run its own version of systemd and Podman to isolate not only the
13+
applications and containers launched by systemd and Podman but systemd and
14+
Podman commands themselves.
15+
16+
This package requires the Podman package to establish the containerized
17+
environment and uses quadlet to set it up.
18+
19+
Software install into the qm environment under /usr/lib/qm/rootfs will
20+
be automatically isolated from the host. But if developers want to further
21+
isolate these processes from other processes in the QM they can use container
22+
tools like Podman to further isolate.

‎docs/docs/resources.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Additional Resources
2+
3+
- [Paving the Way for Uninterrupted Car Operations - DevConf Boston 2024](https://www.youtube.com/watch?v=jTrLqpw7E6Q)
4+
- [Security - Sample Risk Analysis according to ISO26262](https://www.youtube.com/watch?v=jTrLqpw7E6Q&t=1268s)
5+
- [ASIL and QM - Simulation and Service Monitoring using bluechi and podman](https://www.youtube.com/watch?v=jTrLqpw7E6Q&t=1680s)
6+
- [Containers in a Car - DevConf.CZ 2023](https://www.youtube.com/watch?v=FPxka5uDA_4)

‎docs/mkdocs.yml‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,14 @@ site_name: QM Documentation
22

33
repo_url: https://github.com/containers/qm
44
repo_name: qm
5+
edit_uri: blob/main/docs/docs/
56

67
copyright: Copyright Contributors to the QM project
78
nav:
89
- Home: index.md
10+
- Getting Started:
11+
- Installation: getting_started/installation.md
12+
- Additional resources: resources.md
913

1014
theme:
1115
name: material
@@ -23,8 +27,8 @@ markdown_extensions:
2327
- smarty
2428
- admonition
2529
- pymdownx.snippets:
26-
base_path: ["doc"]
30+
base_path: ["docs"]
2731
check_paths: True
2832
- pymdownx.superfences:
2933
- pymdownx.tabbed:
30-
alternate_style: true
34+
alternate_style: true

0 commit comments

Comments
 (0)