Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Moved examples from old spec page to respective topic pages and updat… #239

Closed
wants to merge 4 commits into from
Closed

Conversation

JaimeMagiera
Copy link
Contributor

Various changes to resolve #208

Copy link
Contributor

@bgilbert bgilbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a really good cleanup. Thanks for handling it!

Remember to update existing pages linking to fcct-config.adoc.

modules/ROOT/nav.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/fcct-config.adoc Show resolved Hide resolved
modules/ROOT/pages/fcct-config.adoc Show resolved Hide resolved
modules/ROOT/pages/files.adoc Outdated Show resolved Hide resolved
@@ -60,6 +60,40 @@ An easy way to use `fcct` is to run it in a container with `podman`:
+
. Use the `example.ign` file to xref:getting-started.adoc[boot FCOS].

The following examples show how to retrieve an Ignition file from a remote source. They are both set to replace the current configuration with a remote Ignition file.

=== Downloading FCCT
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy-paste error?

Also, I'm not sure this section really belongs here. Maybe we should have a separate page explaining config merge and replace? That functionality seems to trip people up, so it'd be good to explain it more thoroughly.

Copy link
Contributor Author

@JaimeMagiera JaimeMagiera Mar 23, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Moved to a separate page. Those are replace examples. I'll add merge after addressing the outstanding issues.

storage:
disks:
-
# Mandatory. We use the World-Wide Number ID of the drive to ensure
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, the comments are substantive, but they're inconsistent with the other examples on this page...

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So, wipe all embedded comments?

NOTE: You don't need the `path` or `with_mount_unit` keys; FCOS knows that the root partition is special and will figure out how to find it and mount it.

.Defining a file system on a RAID storage device
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs a sentence or two explaining what the example does. Also, this example should get its own section, rather than being grouped under root filesystem moving.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.

Copy link
Contributor

@bgilbert bgilbert left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks like there are still some unresolved comments.

For what it's worth, you took on a fairly complex rework of the docs here, and I don't think it's fair to expect you to handle all of the details yourself. Feel free to keep working on this as much as you'd like, but if you get to a point where you want to hand off the work, let me know and I'll be happy to take over.

modules/ROOT/pages/managing-files.adoc Outdated Show resolved Hide resolved
modules/ROOT/pages/producing-ign.adoc Show resolved Hide resolved
modules/ROOT/pages/producing-ign.adoc Outdated Show resolved Hide resolved
@JaimeMagiera
Copy link
Contributor Author

Looks like there are still some unresolved comments.

For what it's worth, you took on a fairly complex rework of the docs here, and I don't think it's fair to expect you to handle all of the details yourself. Feel free to keep working on this as much as you'd like, but if you get to a point where you want to hand off the work, let me know and I'll be happy to take over.

I'm just plugging away as time permits. If folks are happy to just have it plugged away over the next week or so, I'm happy to keep plugging away. If you or anyone else wants to help or take over, that's fine too. Whatever works best.

@travier
Copy link
Member

travier commented Feb 9, 2021

I'm just plugging away as time permits. If folks are happy to just have it plugged away over the next week or so, I'm happy to keep plugging away. If you or anyone else wants to help or take over, that's fine too. Whatever works best.

That's good. I don't think we're in a hurry for this one. Feel free to comment when you think this is ready for another round of review.

@bgilbert
Copy link
Contributor

@JaimeMagiera Are you still working on this?

@travier
Copy link
Member

travier commented Mar 26, 2021

Closing in favor of #263 which is based on this one. Thanks a lot @JaimeMagiera for the initial work here.

@travier travier closed this Mar 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Delete FCC spec documentation
3 participants