Skip to content

Commit df95415

Browse files
committed
Fix broken links and update docusaurus config
1 parent 3a6f6ee commit df95415

File tree

8 files changed

+16
-13
lines changed

8 files changed

+16
-13
lines changed

docs/developer/index.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -157,5 +157,3 @@ make deploy-e2e-extras
157157
```
158158
159159
The Prometheus web UI is then accessible on `http://localhost:9090`
160-
161-
For detailed information about the metrics system architecture, see [Metrics Architecture](architecture/metrics.md).

docs/developer/service-quadlets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ The RPM upgrade process includes:
265265
> Database migration dry-run can be enabled/disabled by editing `/etc/flightctl/flightctl-services-install.conf` and setting `FLIGHTCTL_MIGRATION_DRY_RUN=1`. This is recommended to catch potential migration issues before they affect production.
266266
267267
> [!NOTE]
268-
> Downgrades are not supported. Be sure to back up your system before upgrading. If an upgrade fails, follow the [Flight Control Restore Operations](restore.md#flight-control-restore-operations).
268+
> Downgrades are not supported. Be sure to back up your system before upgrading. If an upgrade fails, follow the [Flight Control Restore Operations](../user/restore.md).
269269
270270
### Running the Services Container
271271

docs/user/building-images.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ At a high level, the image building process for bootc works as follows:
2020
4. Build, publish, and sign an **OS disk image** using `bootc-image-builder` (bib) and `skopeo`.
2121

2222
<picture>
23-
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/flightctl/flightctl/main/docs/images/image-building.svg">
24-
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/flightctl/flightctl/main/docs/images/image-building-dark.svg">
25-
<img alt="Diagram of image building process" src="https://raw.githubusercontent.com/flightctl/flightctl/main/docs/images/image-building.svg">
23+
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/flightctl/flightctl/main/docs/images/image-building.svg"/>
24+
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/flightctl/flightctl/main/docs/images/image-building-dark.svg"/>
25+
<img alt="Diagram of image building process" src="https://raw.githubusercontent.com/flightctl/flightctl/main/docs/images/image-building.svg"/>
2626
</picture>
2727

2828
The OS disk image is used to image (or "flash") a device when it is provisioned. For subsequent device updates, only the OS image (bootc) is required. This is because bootc is a *file system* image, that is it contains just the files in the file system including their attributes, but the disk layout (partitions, volumes) and file systems need to have been created first. The OS disk image includes everything, the disk layout, bootloader, file systems, and the files in the OS image (bootc). It can therefore be written verbatim to the device's drive.

docs/user/getting-started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -174,7 +174,7 @@ FC_API_URL=<API_URL>
174174

175175
```
176176

177-
For managing ongoing Flight Control deployments including upgrades, rollbacks, and monitoring, refer to the [Helm Chart Documentation](../../deploy/helm/flightctl/README.md#upgrade-chart).
177+
For managing ongoing Flight Control deployments including upgrades and monitoring, refer to the [Helm Chart Documentation](https://github.com/flightctl/flightctl/blob/main/deploy/helm/flightctl/README.md).
178178

179179
## Installing the Flight Control CLI
180180

docs/user/index.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Welcome to the Flight Control user documentation.
1818
* [Considerations for Specific Target Platforms](building-images.md#considerations-for-specific-target-platforms)
1919
* [Red Hat OpenShift Virtualization](building-images.md#red-hat-openshift-virtualization)
2020
* [VMware vSphere](building-images.md#vmware-vsphere)
21-
* [Best Practices](building-images.md#best-practices)
21+
* [Best Practices](building-images.md#best-practices-when-building-images)
2222
* **[Provisioning Devices](provisioning-devices.md)** - How to provision a device with an OS image.
2323
* [Testing an OS image on a developer machine](provisioning-devices.md#testing-an-os-image-on-a-developer-machine)
2424
* [Provisioning Physical Devices](provisioning-devices.md#provisioning-physical-devices)
@@ -42,7 +42,6 @@ Welcome to the Flight Control user documentation.
4242
* [Selecting Devices into a Fleet](managing-fleets.md#selecting-devices-into-a-fleet)
4343
* [Defining Device Templates](managing-fleets.md#defining-device-templates)
4444
* [Defining Rollout Policies](managing-fleets.md#defining-rollout-policies)
45-
* [Managing Fleets Using GitOps](managing-fleets.md#managing-fleets-using-gitops)
4645
* **Solving Specific Use Cases** - How to solve specific use cases in Flight Control.
4746
* [Auto-Registering Devices with MicroShift into ACM](registering-microshift-devices-acm.md)
4847
* [Adding Device Observability](device-observability.md)

docs/user/managing-devices.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ NAME APPROVAL APPROVER APPROV
4040

4141
Once approved, the device will get issued its initial management certificate and get registered to the device inventory and is now ready to be managed.
4242

43-
## Viewing and Customizing the Device System Information
43+
## Viewing the Device Inventory and Device Details
4444

4545
Flight Control automatically gathers system information from each device to help identify its hardware, OS, and environment. This data is shown in the `status.systemInfo` field. Fields can optionally be promoted to labels during the enrollment process, this must be done manually or through external automation. Promoting fields to labels enables powerful grouping and querying capabilities, such as filtering devices by region or OS version. You can also define your own fields in `status.systemInfo.customInfo`, allowing the agent to collect user-defined metadata through custom commands.
4646

@@ -947,7 +947,7 @@ Each schedule supports:
947947
| `timeZone` | (Optional) The time zone used to evaluate the schedule. Defaults to the device’s local system time zone. Must be a valid [IANA time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). |
948948
| `startGraceDuration` | (Optional) A duration string that extends the allowed start time window after a schedule trigger. Follows the [Go duration format](https://pkg.go.dev/time#ParseDuration), such as `"1h"` or `"45m"`. |
949949

950-
The Flight Control agent evaluates these schedules during its control loop to determine whether each policy is currently allowed to proceed. While the device waits for the update window the device status will read `OutOfDate`. For more details please see [Device API Statuses](device-api-statuses.md#device-api-statuses).
950+
The Flight Control agent evaluates these schedules during its control loop to determine whether each policy is currently allowed to proceed. While the device waits for the update window the device status will read `OutOfDate`. For more details please see [Device API Statuses](device-api-statuses.md).
951951

952952
>[!TIP]
953953
> Use [crontab guru](https://crontab.guru/) to create and test cron expressions interactively.

docs/user/tpm-authentication.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ The Flight Control API server needs TPM manufacturer CA certificates to validate
6767

6868
### TPM Manufacturer CA Certificates
6969

70-
Several [well-known](https://trustedcomputinggroup.org/membership/certification/tpm-certified-products/) discrete [TPM manufacturer certificates](../../tpm-manufacturer-certs) have been downloaded for use. They are provided in PEM format to be directly compatible with Flight Control services, and contain metadata indicating their download URL and when they were downloaded.
70+
Several [well-known](https://trustedcomputinggroup.org/membership/certification/tpm-certified-products/) discrete [TPM manufacturer certificates](https://github.com/flightctl/flightctl/tree/main/tpm-manufacturer-certs) have been downloaded for use. They are provided in PEM format to be directly compatible with Flight Control services, and contain metadata indicating their download URL and when they were downloaded.
7171

7272
- **Infineon**
7373
- [TPM Product Page](https://www.infineon.com/products/security-smart-card-solutions/optiga-embedded-security-solutions/optiga-tpm). Each product's documents were inspected and individual intermediate certificates were pulled. Root certificates were obtained via following the AIA chain in the intermediate certs.

docusaurus.config.js

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,6 @@ const config = {
2626
projectName: "flightctl.github.io", // Usually your repo name.
2727

2828
onBrokenLinks: "throw",
29-
onBrokenMarkdownLinks: "warn",
3029

3130
// Even if you don't use internationalization, you can use this field to set
3231
// useful metadata like html lang. For example, if your site is Chinese, you
@@ -36,6 +35,13 @@ const config = {
3635
locales: ["en"],
3736
},
3837

38+
markdown: {
39+
hooks: {
40+
onBrokenMarkdownLinks: 'warn',
41+
onBrokenMarkdownImages: 'throw',
42+
}
43+
},
44+
3945
presets: [
4046
[
4147
"classic",

0 commit comments

Comments
 (0)