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

Reduce Windows confusion in renamed 'Install medium prep' section #1174

Merged
merged 6 commits into from
Jul 14, 2021
Merged

Reduce Windows confusion in renamed 'Install medium prep' section #1174

merged 6 commits into from
Jul 14, 2021

Conversation

dksmiffs
Copy link
Contributor

@dksmiffs dksmiffs commented Jul 8, 2021

As discussed w/ adw and deeplow here from 2021-06-27 through 06-30, and an attempted improvement to prior (now closed) PR #1168. Again, I welcome suggestions for improvement to this edit.

@dksmiffs
Copy link
Contributor Author

dksmiffs commented Jul 8, 2021

It's unclear to me why the htmlproofer check failed in the pipeline. I'm happy to fix if someone would kindly suggest how.

@andrewdavidwong
Copy link
Member

It's unclear to me why the htmlproofer check failed in the pipeline. I'm happy to fix if someone would kindly suggest how.

/home/gitlab-runner/qubesos.github.io/_utils/gitlabci.sh: line 102: 26766 Killed                  htmlproofer ./_site --disable-external --checks-to-ignore ImageCheck --file-ignore ./_site/video-tours/index.html --only_4xx --url-ignore "/qubes-issues/"

@marmarek, @fepitre: Did htmlproofer run out of memory again?

@fepitre
Copy link
Member

fepitre commented Jul 8, 2021

PipelineRetry

@andrewdavidwong
Copy link
Member

Thanks, @fepitre!

Ok, it looks like all of the failures in the CI log are accurate and specific to this PR now, @dksmiffs:

+ htmlproofer ./_site --disable-external --checks-to-ignore ImageCheck --file-ignore ./_site/video-tours/index.html --only_4xx --url-ignore /qubes-issues/
Running ["ScriptCheck", "LinkCheck"] on ["./_site"] on *.html... 
Ran on 1149 files!
- ./_site/doc/installation-troubleshooting/index.html
  *  linking to internal hash #copying-the-iso-onto-the-installation-medium that does not exist (line 380)
     <a href="/doc/installation-guide/#copying-the-iso-onto-the-installation-medium">write your ISO to a USB key</a>
  *  linking to internal hash #copying-the-iso-onto-the-installation-medium that does not exist (line 389)
     <a href="/doc/installation-guide/#copying-the-iso-onto-the-installation-medium">how to write your ISO to a USB key</a>
- ./_site/news/2019/11/03/qubes-4-0-2-rc2/index.html
  *  linking to internal hash #copying-the-iso-onto-the-installation-medium that does not exist (line 327)
     <a href="/doc/installation-guide/#copying-the-iso-onto-the-installation-medium">copying the ISO onto a sufficiently large USB drive</a>
- ./_site/news/2019/12/13/qubes-4-0-2-rc3/index.html
  *  linking to internal hash #copying-the-iso-onto-the-installation-medium that does not exist (line 328)
     <a href="/doc/installation-guide/#copying-the-iso-onto-the-installation-medium">copying the ISO onto a
sufficiently large USB drive</a>
- ./_site/news/2020/01/02/qubes-4-0-2/index.html
  *  linking to internal hash #copying-the-iso-onto-the-installation-medium that does not exist (line 347)
     <a href="/doc/installation-guide/#copying-the-iso-onto-the-installation-medium">copying the ISO onto a
sufficiently large USB drive</a>
- ./_site/news/2020/01/15/qubes-4-0-3-rc1/index.html
  *  linking to internal hash #copying-the-iso-onto-the-installation-medium that does not exist (line 344)
     <a href="/doc/installation-guide/#copying-the-iso-onto-the-installation-medium">copying the ISO onto a sufficiently large USB
drive</a>
- ./_site/news/2020/01/23/qubes-4-0-3/index.html
  *  linking to internal hash #copying-the-iso-onto-the-installation-medium that does not exist (line 330)
     <a href="/doc/installation-guide/#copying-the-iso-onto-the-installation-medium">copying the ISO onto a sufficiently large USB
drive</a>
htmlproofer 3.16.0 | Error:  HTML-Proofer found 7 failures!

dksmiffs added 3 commits July 11, 2021 13:30
Tag for commit 6eea2bf

# -----BEGIN PGP SIGNATURE-----
#
# iQIzBAABCgAdFiEE4R0VxtIENXaf+qRWjOE3NSoBmhcFAmDqGVAACgkQjOE3NSoB
# mhcsdg/6A2zT+GvdR0XtnGxyJoI1WDTHrTSt9e0BiVOWorCs1OoL85leR0jvzWgO
# hcXeIxiQK7EnG/QKQC1UMY3gSfL+t8bkaGlXVqcNPFdbVIiHqg/w0KuMaA1pq4mQ
# slGtcZyQjjWLLm8RiL4KxshnqVZWqokQwOg3GwL72bNvVxOGb5nJAI9VIyq9+C6N
# rqE3qUg3CkzVUxjEFh8kNjGGc/SrpWRlXDHr/6+L5BgGKGcXjhy3S480yRNHU5LI
# V/xqkFa+QJaA5F0E+2CIX+fuHSQGl8HrupdXltBRT4VYTibLICGAPsiibpETSrNX
# f0lPXUfJAQINw9MAWEvypuFhCHc21xwV/KHVymGuUsbLVFsSUDFrAimb9zBxvqRC
# MNAnIBcwrvgxBBg2P4XVTLaV6fKe8vGf3fuiV0Rlxpjk/5oq8KKwCc9LeSd1Q+Sq
# hHV72j/yOpXe/FJ10eWMJQLoOGUk/aMu8gAhpjSMBzuDV9kmwp3H2eNNrTrU3hxW
# UAvSaNTCK+klmNTWfiPKDaQCtJFhrBqglzo/yNo0JUBhpP6azZ41ISU9pd9lamc5
# kbBWioRjeb6hQ+aBgU6W2UY+q9S6gyvITpfB+PmjU+HzCUqoxpKKe2epQnnm63Tn
# 46eceH/DdlFWZcRP0Zi2aMsdyylwRaGVoRASwb90JKRtfVSEd58=
# =gYJ6
# -----END PGP SIGNATURE-----
# gpg: Signature made 7/10/2021 5:04:00 PM Central Daylight Time
# gpg:                using RSA key E11D15C6D20435769FFAA4568CE137352A019A17
# gpg: Can't check signature: No public key
<b>Note:</b> If you do this on Windows 10, you can only install Qubes
without MediaTest, which is not recommended.
<b>Note:</b> Choosing this Windows+Rufus method means that you
[won't be able](https://github.com/QubesOS/qubes-issues/issues/2051) to choose
Copy link
Member

Choose a reason for hiding this comment

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

Markdown syntax won't work here, because you're inside of an alert. Has to be HTML.

@andrewdavidwong
Copy link
Member

I actually still don't even know what MediaTest is. Should that be explained somewhere? Is it just an odd way of referring to the option in the Qubes installer to test the installation medium? (I say "odd" because I don't recall the term MediaTest being used, but my memory often fails me.)

@unman
Copy link
Member

unman commented Jul 12, 2021 via email

@dksmiffs
Copy link
Contributor Author

@andrewdavidwong yes, made even more confusing by the CamelCase usage, which leads the reader to believe it might be an intentional thing (I agree with @unman, I think it should not be). This one odd reference was the origin of this PR for me.

@dksmiffs
Copy link
Contributor Author

/home/gitlab-runner/qubesos.github.io/_utils/gitlabci.sh: line 102: 26891 Killed                  htmlproofer ./_site --disable-external --checks-to-ignore ImageCheck --file-ignore ./_site/video-tours/index.html --only_4xx --url-ignore "/qubes-issues/"

Appears to be the same failure that @andrewdavidwong commented on above on 7/8.

@fepitre
Copy link
Member

fepitre commented Jul 12, 2021

PipelineRetry

@fepitre
Copy link
Member

fepitre commented Jul 12, 2021

Ok so it looks like we still have an issue with one of the runner. I've retried with the failing runner disabled. Sorry for the problem.

Comment on lines +85 to +86
installation medium of your choice, such as a USB drive, dual-layer DVD,
or Blu-ray disc. The size of each Qubes ISO is available on the
Copy link
Member

Choose a reason for hiding this comment

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

Reordered list to put most common and recommended medium first.

Comment on lines 124 to 129
<div class="alert alert-info" role="alert">
<i class="fa fa-info-circle"></i>
<b>Note:</b> Using Rufus to create the installation medium means that you
<a href="https://github.com/QubesOS/qubes-issues/issues/2051">won't be able</a>
to choose the "Test this media & install Qubes" option recommended in the
Installation section below. Instead, you'll only be able to choose the
"Install Qubes" option.
to choose the "Test this media and install Qubes OS" option mentioned in the
example below. Instead, choose the "Install Qubes OS" option.
Copy link
Member

@andrewdavidwong andrewdavidwong Jul 13, 2021

Choose a reason for hiding this comment

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

This doesn't deserve "warning" (as opposed to "info"), because the "test this media" option isn't being "recommended" below. As it states at the beginning of that section, it's simply showing you an example with the most common settings.

The previous wording is likely to get users worried over nothing. This alert still might. Many users still won't understand it at all and become terribly confused. I'm of half a mind to remove it, but it's reasonable to let users know that using Rufus will disallow the test option, since they might care about it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@andrewdavidwong I like your wording better, and I agree with you about not getting users worried over nothing. I think your wording definitely lessens potential worry.

@andrewdavidwong
Copy link
Member

@fepitre:

Ok so it looks like we still have an issue with one of the runner. I've retried with the failing runner disabled. Sorry for the problem.

Seems like there's no CI check at all now. Is that expected?

@fepitre
Copy link
Member

fepitre commented Jul 14, 2021

PipelineRetry

@fepitre
Copy link
Member

fepitre commented Jul 14, 2021

@fepitre:

Ok so it looks like we still have an issue with one of the runner. I've retried with the failing runner disabled. Sorry for the problem.

Seems like there's no CI check at all now. Is that expected?

No. Unfortunately, there is some recent random issue with Gitlab/Github CI events that we catch to report status. I still don't find why there is such failure yet.

@andrewdavidwong andrewdavidwong merged commit 392c994 into QubesOS:master Jul 14, 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.

4 participants