#117 DRAFT: A large number of edits from Leslie S Satenstein as changes in a LibreOffice document.
Opened by mattdm. Modified
fedora-docs/ mattdm/install-guide ls_bootopts_edit  into  master

Download 117.patch

I have reformatted the relevant sections as SemBr (see previous commit).

This now includes Leslie's suggested changes.

This PR is not immediately ready to merge;
we are going to use it as a workflow proof-of-concept.

Leslie: I agree that the wording here could be more clear, but this has changed the meaning. The current text says directly that the boot options are what change the default behaviors, while the suggested text leaves that kind of vague.

I think this is even more confusing. I suggest something like

The [application]*Anaconda* installer includes a range of boot options
which you can use to change the default behavior of the installation program.
Some of these options can enable or disable certain functions,
while others provide default values or advanced configuration.

... which I think is more clear and also covers a point that's otherwise missed.

What do you think?

@lsatenstein Note that these comments have a context -- click on "5 of modules/install-guide/pages/advanced/Boot_Options.adoc" above, for example.

The usage without an article here might be system administrator slang -- "Boot from disk", "boot from USB", "boot from network" are all very common terms to me.

I think reducing jargon is good, but the meaning is slightly changed, because it isn't "the" installation media but some (appropriate) installation media.

A footnote might be a good idea, but there's a whole section (the link) describing it.

This seems to be introducing a new term, the idea that options which do not have attributes are called "keywords".

I am not familiar with that distinction, and do not see it used that way in, for example, the dracut documentation, or the systemd command line options docs

See above.

Maybe jargon again, but you don't boot media — you boot something from the media.

I agree; this in general should be changed to assume that USB is the primary installation method.

This means "the computer system onto which we are hoping to install the new OS".

The document uses second-person throughout -- let's just make this say "This option allows you to configure..."

how about: "while you are in the middle of installation"
?

I think it's pretty clear that it refers to the option being documented? But maybe

This option can be useful when using

Is this true? I mean, that the option is at the very beginning?

"phase" seems like more new terminology. I don't see it used in https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Installing_Using_Anaconda/

Very good question. The installer doesn't give you a lot of choices about Btrfs in graphical mode either, really. This should be tested.

"runtime" seems like it's going towards more jargon. How about

This mode does not allow any interaction
while the installation process is running.
All options must be specified in a Kickstart file
or on the command line.

We should be consistent with https://docs.fedoraproject.org/en-US/fedora/rawhide/install-guide/install/Installing_Using_Anaconda/#sect-installation-graphical-mode

Good question. Need to check with developers.

in-depth

I don't understand this. What is a setup password in this context?

I'm not sure of your intent here.

The name cant take any of the following forms....

We have both 64-bit (aarch64) and 32-bit (armhfp) support. However, we don't do multilib on ARM, to my knowledge, so this does not apply.

"GPT" is "GUID Partition Table", and it is in fact the table that's being written. See text right above this in the document.

Subtle difference here. I think the emphasis should be on the system, rather than that the default. That is, what it's saying is that when installation is complete, the remote system will not boot to GUI mode, but instead boot to a text prompt. That is because the assumption is that you're using VNC because you're doing a remote install to a headless machine (like for example a rack-mount server).

We should validate that this limitation is still in place with current VNC.

It's probably worth validating which ones are still available.

Right, this probably is one that is no longer valid.

I don't know if "the first time" is really the right wording, but I think the idea is: If you do a test before you even install our stuff, you may find a fault that you would attribute to Fedora if you had just installed without a test.

Actually I think we actually do distribute it, because the boot media covers both cases. It's just not shown.

Honestly, I think it should be removed until we have a better option, since UEFI is the default these days.

Maybe we could put the advice about performing a memory test elsewhere?

I think the idea was "a local ((hard drive) or (NFS server))", rather than "a (local hard drive) or (NFS server). But I think you theoretically could use a remote NFS server, if any such thing exists still these days.

In any case, "an NFS server", not "a NFS server".

I can understand the perspective, but it can take a really, really long time. Like, hours. And we don't have a good option for UEFI systems anyway.

Also, I'm not sure everything-network is where I'd make the distinction.

Let's say "from installation media"?

Metadata