PR#40: Fix the RFC number for DHCP Architecture Option - fedora-docs/install-guide

		`@@ -0,0 +1,10 @@`
		`+ The text of and illustrations in this document are licensed by Red Hat`
		`+ under a Creative Commons Attribution–Share Alike 3.0 Unported license`
		`+ ("CC-BY-SA"). An explanation of CC-BY-SA is available at`
		`+ http://creativecommons.org/licenses/by-sa/3.0/. In accordance with`
		`+ CC-BY-SA, if you distribute this document or an adaptation of it, you`
		`+ must provide the URL for the original version.`
		`+`
		`+ Red Hat, as the licensor of this document, waives the right to`
		`+ enforce, and agrees not to assert, Section 4d of CC-BY-SA to the`
		`+ fullest extent permitted by applicable law.`

antora.yml

file modified

+1 -1

		`@@ -1,5 +1,5 @@`
		`---`
		`name: fedora`
		`- version: rawhide`
		`+ version: f31`
		`# Navigation is in the main 'fedora' component:`
		`# https://pagure.io/fedora-docs/release-docs-home`

build.sh

file modified

+25 -14

		`@@ -1,35 +1,46 @@`
		`#!/bin/sh`

		`- image="antora/antora"`
		`+ image="docker.io/antora/antora"`
		`cmd="--html-url-extension-style=indexify site.yml"`

		`if [ "$(uname)" == "Darwin" ]; then`
		`# Running on macOS.`
		`# Let's assume that the user has the Docker CE installed`
		`# which doesn't require a root password.`
		`+ echo ""`
		`+ echo "This build script is using Docker container runtime to run the build in an isolated environment."`
		`+ echo ""`
		`docker run --rm -it -v $(pwd):/antora $image $cmd`

		`elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then`
		`# Running on Linux.`
		`# Check whether podman is available, else faill back to docker`
		`# which requires root.`
		`+`
		`if [ -f /usr/bin/podman ]; then`
		`- runtime="podman"`
		`- else`
		`- runtime="docker"`
		`- fi`
		`- if groups \| grep -wq "docker"; then`
		`- # Check if the current user is in the "docker" group. If true, no sudo is needed.`
		`echo ""`
		`- echo "This build script is using $runtime to run the build in an isolated environment."`
		`+ echo "This build script is using Podman to run the build in an isolated environment."`
		`echo ""`
		`- $runtime run --rm -it -v $(pwd):/antora:z $image $cmd`
		`- else`
		`- # User isn't in the docker group; run the command with sudo.`
		`+ podman run --rm -it -v $(pwd):/antora:z $image $cmd`
		`+`
		`+ elif [ -f /usr/bin/docker ]; then`
		`+ echo ""`
		`+ echo "This build script is using Docker to run the build in an isolated environment."`
		`echo ""`
		`- echo "This build script is using $runtime to run the build in an isolated environment. You might be asked for your password."`
		`- echo "You can avoid this by adding your user to the 'docker' group, but be aware of the security implications. See https://docs.docker.com/install/linux/linux-postinstall/."`
		`+`
		`+ if groups \| grep -wq "docker"; then`
		`+ docker run --rm -it -v $(pwd):/antora:z $image $cmd`
		`+ else`
		`+ echo ""`
		`+ echo "This build script is using $runtime to run the build in an isolated environment. You might be asked for your password."`
		`+ echo "You can avoid this by adding your user to the 'docker' group, but be aware of the security implications. See https://docs.docker.com/install/linux/linux-postinstall/."`
		`+ echo ""`
		`+ sudo docker run --rm -it -v $(pwd):/antora:z $image $cmd`
		`+ fi`
		`+ else`
		`echo ""`
		`- sudo $runtime run --rm -it -v $(pwd):/antora:z $image $cmd`
		`+ echo "Error: Container runtime haven't been found on your system. Fix it by:"`
		`+ echo "$ sudo dnf install podman"`
		`+ exit 1`
		`fi`
		`fi`

modules/install-guide/pages/_partials/entities.adoc

file modified

+3 -3

		`@@ -5,12 +5,12 @@`

		`:HOLDER: Red Hat, Inc. and others`

		`- :NEXTVER: 31`
		`+ :NEXTVER: 32`

		`- :PREVVER: 29`
		`+ :PREVVER: 30`

		`:PRODUCT: Fedora`

		`- :PRODVER: 30`
		`+ :PRODVER: 31`

		`:YEAR: 2019`

modules/install-guide/pages/advanced/Network_based_Installations.adoc

file modified

+1 -2

		`@@ -1,4 +1,3 @@`
		`-`
		`:experimental:`
		`include::{partialsdir}/entities.adoc[]`

		`@@ -78,7 +77,7 @@`
		. Add entries to point clients to their bootloader and the server that provides it to your subnet configuration in `/etc/dhcp/dhcpd.conf`. Because DHCP clients provide the server with identifying information along with their address request, BIOS clients and UEFI clients can each be directed to the correct bootloader.
		`+`
		`----`
		`- # refer to RFC4758 for possible arch option values`
		`+ # refer to RFC4578 for possible arch option values`
		`option arch code 93 = unsigned integer 16;`

		`subnet 192.168.1.0 netmask 255.255.255.0 {`

modules/install-guide/pages/install/Preparing_for_Installation.adoc

file modified

+3 -3

		`@@ -163,12 +163,12 @@`

		Because transmission errors or other problems may corrupt the Fedora image you have downloaded, it is important to verify the file's integrity. After the images are created, an operation is performed on the file that produces a value called a `checksum` using a complex mathematical algorithm. The operation is sufficiently complex that any change to the original file will produce a different checksum.

		- By calculating the image's `checksum` on your own computer and comparing it to the original `checksum`, you can verify the image has not been tampered with or corrupted. The original checksum values are provided at link:++https://fedoraproject.org/verify++[], and are [command]#gpg# signed to demonstrate their integrity.
		+ By calculating the image's `checksum` on your own computer and comparing it to the original `checksum`, you can verify the image has not been tampered with or corrupted. The original checksum values are provided at link:++https://getfedora.org/security/++[], and are [command]#gpg# signed to demonstrate their integrity.

		`[[sect-verifying-windows]]`
		`==== Verifying checksums on Windows systems`

		`- . Download the Fedora image of your choice from link:++https://fedoraproject.org/get-fedora++[] and the corresponding checksum file from link:++https://fedoraproject.org/verify++[]`
		`+ . Download the Fedora image of your choice from link:++https://fedoraproject.org/get-fedora++[] and the corresponding checksum file from link:++https://getfedora.org/security/++[]`

		`. Open a [command]#powershell# session.`

		`@@ -219,7 +219,7 @@`
		`[[sect-verifying-nix]]`
		`==== Verifying checksums on Linux and OSX systems`

		`- . Download the Fedora image of your choice from link:++https://fedoraproject.org/get-fedora++[] and the corresponding checksum file from link:++https://fedoraproject.org/verify++[]`
		`+ . Download the Fedora image of your choice from link:++https://fedoraproject.org/get-fedora++[] and the corresponding checksum file from link:++https://getfedora.org/security/++[]`

		`. Open a terminal window, and navigate to the directory with the downloaded files.`
		`+`

preview.sh

file modified

+6 -24

		`@@ -9,28 +9,10 @@`

		`elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then`
		`# Running on Linux.`
		`- # Check whether podman is available, else faill back to docker`
		`- # which requires root.`
		`- if [ -f /usr/bin/podman ]; then`
		`- runtime="podman"`
		`- else`
		`- runtime="docker"`
		`- fi`
		`- if groups \| grep -wq "docker"; then`
		`- # Check if the current user is in the "docker" group. If true, no sudo is needed.`
		`- echo ""`
		`- echo "This build script is using $runtime to run the build in an isolated environment."`
		`- echo "The preview will be available at http://localhost:8080/"`
		`- echo ""`
		`- $runtime run --rm -v $(pwd):/antora:ro,z -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro,z -p 8080:80 nginx`
		`- else`
		`- # User isn't in the docker group; run the command with sudo.`
		`- echo ""`
		`- echo "This build script is using $runtime to run the build in an isolated environment. You might be asked for your password."`
		`- echo "You can avoid this by adding your user to the 'docker' group, but be aware of the security implications. See https://docs.docker.com/install/linux/linux-postinstall/."`
		`- echo ""`
		`- echo "The preview will be available at http://localhost:8080/"`
		`- echo ""`
		`- sudo $runtime run --rm -v $(pwd):/antora:ro,z -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro,z -p 8080:80 nginx`
		`- fi`
		`+ # Fedora Workstation has python3 installed as a default, so using that`
		`+ echo ""`
		`+ echo "The preview is available at http://localhost:8080"`
		`+ echo ""`
		`+ cd ./public`
		`+ python3 -m http.server 8080`
		`fi`

site.yml

file modified

+1 -1

		`@@ -6,7 +6,7 @@`
		`- url: .`
		`branches: HEAD`
		`- url: https://pagure.io/fedora-docs/release-docs-home.git`
		`- branches: master`
		`+ branches: f31`
		`ui:`
		`bundle:`
		`url: https://asamalik.fedorapeople.org/ui-bundle.zip`

owendelong commented 4 years ago

Most of the changes shown below are not my changes. I merely changed the RFC number on line 10 of Network_based_Installations.adoc

Not sure why the fork was based to an earlier version that what I was reading when I clicked fork.

In any case, the correct RFC for Architecture is 4578. 4758 is some cryptographic token protocol.

pbokoc commented 4 years ago

@owendelong The fork is based on branch F31 while you're trying to merge to master - that's not what we want to do, there are release-specific differences between each branch (as you can see by the list of changes in this PR). You'll need to:

Close this PR - unfortunately you can't change the target branch after the PR is created, so this one won't be of any use.
Open a new one, and make sure you're merging from your fork's branch f31 to the upstream's branch f31. Ideally, run git pull --rebase on your local branch f31 first to make sure it's up to date.
This commit should also go to branch master; that way it'll make its way to subsequent releases (new release branches are always created off of master). If you want, you can cherry pick the same commit to your local master (git cherry-pick -1 <hash>, where <hash> is the commit hash), push it to your fork, and then create another PR from there, this time from your fork's master to upstream master. Again, run git pull --rebase first to make sure your fork is up to date.

If you don't do the last step, I'll just cherry-pick it myself.

owendelong commented 4 years ago

I=E2=80=99ll tell you what=E2=80=A6 The docs are wrong. I hope someone =
will choose to fix them.

I=E2=80=99ve pointed out the error.

I=E2=80=99ve jumped through a lot of hoops to try and fix the error.

I=E2=80=99m not jumping through more.

Owen

On Feb 6, 2020, at 04:27 , Petr Bokoc pagure@pagure.io wrote:
=20
=20
pbokoc commented on the pull-request: Fix the RFC number for DHCP = Architecture Option that you are following:
@owendelong The fork is based on branch F31 while you're trying to = merge to master - that's not what we want to do, there are = release-specific differences between each branch (as you can see by the = list of changes in this PR). You'll need to: =20 * Close this PR - unfortunately you can't change the target branch = after the PR is created, so this one won't be of any use. * Open a new one, and make sure you're merging from your fork's branch = `f31` to the upstream's branch `f31`. Ideally, run `git pull --rebase` = on your local branch `f31` first to make sure it's up to date. * This commit should also go to branch `master`; that way it'll make = its way to subsequent releases (new release branches are always created = off of `master`). If you want, you can cherry pick the same commit to = your local `master` (`git cherry-pick -1 <hash>`, where `<hash>` is the = commit hash), push it to your fork, and then create another PR from = there, this time from your fork's `master` to upstream `master`. Again, = run `git pull --rebase` first to make sure your fork is up to date. =20 If you don't do the last step, I'll just cherry-pick it myself.
=20
To reply, visit the link below or just reply to this email
https://pagure.io/fedora-docs/install-guide/pull-request/40