Skip to content

Commit

Permalink
Merge pull request #145 from bgilbert/github
Browse files Browse the repository at this point in the history
docs: link to Ignition docs site, not GitHub
  • Loading branch information
bgilbert committed Oct 23, 2020
2 parents a5d93c1 + e92ec72 commit f9ee561
Show file tree
Hide file tree
Showing 6 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion docs/configuration-v1_0.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
* **path** (string): the mount-point of the filesystem while Ignition is running relative to where the root filesystem will be mounted. This is not necessarily the same as where it should be mounted in the real root, but it is encouraged to make it the same.
* **device** (string): the absolute path to the device. Devices are typically referenced by the `/dev/disk/by-*` symlinks.
* **format** (string): the filesystem format (ext4, btrfs, xfs, vfat, or swap).
* **_wipe_filesystem_** (boolean): whether or not to wipe the device before filesystem creation, see [the documentation on filesystems](https://github.com/coreos/ignition/blob/master/doc/operator-notes.md#filesystem-reuse-semantics) for more information.
* **_wipe_filesystem_** (boolean): whether or not to wipe the device before filesystem creation, see [the documentation on filesystems](https://coreos.github.io/ignition/operator-notes/#filesystem-reuse-semantics) for more information.
* **_label_** (string): the label of the filesystem.
* **_uuid_** (string): the uuid of the filesystem.
* **_options_** (list of strings): any additional options to be passed to the format-specific mkfs utility.
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration-v1_1.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
* **path** (string): the mount-point of the filesystem while Ignition is running relative to where the root filesystem will be mounted. This is not necessarily the same as where it should be mounted in the real root, but it is encouraged to make it the same.
* **device** (string): the absolute path to the device. Devices are typically referenced by the `/dev/disk/by-*` symlinks.
* **format** (string): the filesystem format (ext4, btrfs, xfs, vfat, or swap).
* **_wipe_filesystem_** (boolean): whether or not to wipe the device before filesystem creation, see [the documentation on filesystems](https://github.com/coreos/ignition/blob/master/doc/operator-notes.md#filesystem-reuse-semantics) for more information.
* **_wipe_filesystem_** (boolean): whether or not to wipe the device before filesystem creation, see [the documentation on filesystems](https://coreos.github.io/ignition/operator-notes/#filesystem-reuse-semantics) for more information.
* **_label_** (string): the label of the filesystem.
* **_uuid_** (string): the uuid of the filesystem.
* **_options_** (list of strings): any additional options to be passed to the format-specific mkfs utility.
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration-v1_2.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
* **path** (string): the mount-point of the filesystem while Ignition is running relative to where the root filesystem will be mounted. This is not necessarily the same as where it should be mounted in the real root, but it is encouraged to make it the same.
* **device** (string): the absolute path to the device. Devices are typically referenced by the `/dev/disk/by-*` symlinks.
* **format** (string): the filesystem format (ext4, btrfs, xfs, vfat, or swap).
* **_wipe_filesystem_** (boolean): whether or not to wipe the device before filesystem creation, see [the documentation on filesystems](https://github.com/coreos/ignition/blob/master/doc/operator-notes.md#filesystem-reuse-semantics) for more information.
* **_wipe_filesystem_** (boolean): whether or not to wipe the device before filesystem creation, see [the documentation on filesystems](https://coreos.github.io/ignition/operator-notes/#filesystem-reuse-semantics) for more information.
* **_label_** (string): the label of the filesystem.
* **_uuid_** (string): the uuid of the filesystem.
* **_options_** (list of strings): any additional options to be passed to the format-specific mkfs utility.
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration-v1_3-exp.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ The Fedora CoreOS configuration is a YAML document conforming to the following s
* **path** (string): the mount-point of the filesystem while Ignition is running relative to where the root filesystem will be mounted. This is not necessarily the same as where it should be mounted in the real root, but it is encouraged to make it the same.
* **device** (string): the absolute path to the device. Devices are typically referenced by the `/dev/disk/by-*` symlinks.
* **format** (string): the filesystem format (ext4, btrfs, xfs, vfat, or swap).
* **_wipe_filesystem_** (boolean): whether or not to wipe the device before filesystem creation, see [the documentation on filesystems](https://github.com/coreos/ignition/blob/master/doc/operator-notes.md#filesystem-reuse-semantics) for more information.
* **_wipe_filesystem_** (boolean): whether or not to wipe the device before filesystem creation, see [the documentation on filesystems](https://coreos.github.io/ignition/operator-notes/#filesystem-reuse-semantics) for more information.
* **_label_** (string): the label of the filesystem.
* **_uuid_** (string): the uuid of the filesystem.
* **_options_** (list of strings): any additional options to be passed to the format-specific mkfs utility.
Expand Down
4 changes: 2 additions & 2 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,6 @@ The method by which this file is provided to a Fedora CoreOS machine depends on
To see some examples for what else `fcct` can do, head over to the [examples][examples].

[spec]: specs.md
[ignition]: https://github.com/coreos/ignition
[supported-platforms]: https://github.com/coreos/ignition/blob/master/doc/supported-platforms.md
[ignition]: https://coreos.github.io/ignition/
[supported-platforms]: https://coreos.github.io/ignition/supported-platforms/
[examples]: examples.md
2 changes: 1 addition & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,6 @@ nav_order: 1
# Fedora CoreOS Config Transpiler

The Fedora CoreOS Config Transpiler (FCCT) translates human readable Fedora CoreOS Configs (FCCs)
into machine readable [Ignition](https://github.com/coreos/ignition) Configs. See the [getting
into machine readable [Ignition](https://coreos.github.io/ignition/) Configs. See the [getting
started](getting-started) guide for how to use FCCT and the [configuration specifications](specs.md)
for everything FCCs support.

0 comments on commit f9ee561

Please sign in to comment.