#46 Enhancements to coreos download page
Merged by codeblock. Opened by rfairley.
fedora-web/ rfairley/websites rfairley-enhancements  into  master

Download 46.patch

Requires: https://pagure.io/fedora-web/websites/pull-request/44 (first commit here is the same as in PR #44).

Verified locally in the Flask development server.

Adds a few enhancements:
- tidy-ups to the code, including indentation and variable naming
- link AMI IDs to AWS console launch page
- link to the Fedora signing keys on download page
- add steps for verifying each artifact

In the steps for verifying each artifact, a -CHECKSUM file is generated per artifact to use in the verification steps (originally suggested in discussion in https://github.com/coreos/fedora-coreos-tracker/issues/187). This uses encodeURIComponent to synthesize a downloadable file. As far as I could tell, this should be compatible with the CSP.

I did wonder about generating one -CHECKSUM file that lists checksums for all of the downloadable files, however with the current structure of code it was easiest to generate one file per listed artifact. I also think it's nice having steps with filenames dynamically generated, so that just copying the commands into the terminal is needed. An alternative is generating one -CHECKSUM file and writing general verification steps at the beginning of the Bare Metal & Virtualized and For Cloud Operators sections.

Uploaded a .zip with rendered HTML, and a screenshot: https://rfairley.fedorapeople.org/websites-review/coreos-download-pr-46-1.zip

cc @bgilbert, @sanja, @jlebon, @sinnykumari - if you could have a quick look at the rendered page or code that'd be great (and anyone else feel free to review!).

Minor: s/detatched/detached/

Hmm, the scrollbars for the verification instructions in the bare metal section is kind of unfortunate though. Could we just not make those columns anymore, and just have separate "Bare Metal" and "Virtualized" sections instead? That way we have enough space for the verification steps.

Also WDYT about that verification area being instead something like (using markdown here):

SHA256: <hash>
[Checksum file](<link to generated checksum file>)
[Signature](<link to sig>)
To verify your download:
...

?

(I.e. avoids the "Click this link: download" feel)

4 new commits added

  • coreos-download: link to getting started docs
  • coreos-download: drop unused copyToClipboard function
  • fixup! coreos: link to the Fedora signing keys on download page
  • fixup! coreos: add steps for verifying each artifact

1 new commit added

  • fixup! coreos-download: link to getting started docs

Minor: s/detatched/detached/

Thanks, fixed!

Hmm, the scrollbars for the verification instructions in the bare metal section is kind of unfortunate though. Could we just not make those columns anymore, and just have separate "Bare Metal" and "Virtualized" sections instead? That way we have enough space for the verification steps.

SGTM, made them full page-width columns. Later, we could make this a tab menu to lessen the scrolling needed.

Also WDYT about that verification area being instead something like (using markdown here):

SGTM, this does look neater. Updated!

Keeping the changes as fixup commits for now, will rebase before this is merged.

Screenshot and HTML files with recent changes: https://rfairley.fedorapeople.org/websites-review/coreos-download-pr-46-2.zip

Nice, LGTM!

7 new commits added

  • coreos-download: link to getting started docs
  • coreos-download: drop unused copyToClipboard function
  • coreos: add steps for verifying each artifact
  • coreos: link to the Fedora signing keys on download page
  • coreos: link AMI IDs to AWS console launch page
  • coreos-download: code tidyups
  • coreos: use Vue render function instead of templating

Squashed the fixups!

@codeblock - do you think this could be merged (once rebased)?

Although the plan is to rework this page to us a theme like [1] (tracked in [2]), with a more maintainable code structure, I think for now this gives improvements worth having online (links to AMI IDs, verification instructions and link to Fedora signing keys).

To avoid the current code structure (calls to createElement() to render the page), a quick option for getting these enhancements onto the website could be to restructure the code to use a Vue template in the current App.vue file. But if doing that, it may be more efficient to fully rework the theme while at it, with a different approach/framework to render the page.

I'd be happy with either way (merge this, or wait and add the enhancements in with the overall rework) - but would like there to be agreement on either option on how to proceed. In the latter case, this PR can be closed, and efforts can be concentrated on the theme rework.

In my opinion, it'd be okay to merge this, since we know we will be reworking it in the near future. From then on, the focus before making other changes would be on rework of the theme and code, carrying forward any enhancements to the new theme.

cc @abai, @dustymabe, @bgilbert

[1] https://pagure.io/fedora-websites/issue/964#comment-576026
[2] https://github.com/coreos/fedora-coreos-tracker/issues/192

@rfairley rebase and I'll merge :)

rebased onto bf54659adf94794f82ee5a2372c72b55db3e1f3b

@codeblock Thank you, rebased!

Pull-Request has been merged by codeblock

Thanks @rfairley @codeblock !

Metadata