#444 state of cloud edition docs
Opened by chrismurphy. Modified

I don't think the docs need to be extensive, but the bad links should be replaced with ones that convey what we do want - or even removing any reference to documentation is better.

The minimal documentation might be to just let folks know the group or package listing, and that it uses cloud-init to inject the credentials needed for booting. Otherwise I'm concern folks just have no idea, and think there's a default login and password documented somewhere.

  • https://fedoraproject.org/
  • Find Fedora Cloud, click on Download Now
  • https://fedoraproject.org/cloud/download
  • Find Documentation, click on it
  • https://fedoraproject.org/wiki/Cloud_SIG (I think everything on this page might be stale; ready for retirement but uncertain of the status)
  • Scroll down to Documentation
  • First line refers to Cloud Guide, click it
  • https://docs.fedoraproject.org/en-US/Fedora_Draft_Documentation/0.1/html/Cloud_Guide/index.html
  • Page Not Found

  • https://fedoraproject.org/
  • Find Fedora Cloud, click on Learn More
  • https://fedoraproject.org/cloud/
  • Find and click on Documentation
  • https://fedoracloud.readthedocs.io/en/latest/whatis.html
  • Not much documentation here, but ended up clicking on Cloud Base Image examples on the right side UI
  • https://fedoracloud.readthedocs.io/en/latest/base.html
  • This page refers to Fedora 22, docker-storage-setup, and LVM thin pool

  • Duck Duck Go: fedora cloud documentation
  • Top hit is Fedora Cloud Documentation PDF (2016) which seems derived from the above fedoracloud.readthedocs.io/en/latest/base.html, and likewise has Cloud Base image example based on Fedora 22.

  • Google: fedora cloud documentation
  • Top hit is https://fedoracloud.readthedocs.io/en/latest/
  • This page contains references to Atomic image and Cloud Base image examples, which leads to the same Fedora 22 page mentioned above.
  • Go back to the 2nd Google hit and click that
  • https://discussion.fedoraproject.org/t/where-is-the-documentation/88114 Fedora Discussion, Where is the documentation? (2023)
  • the answers don't help

Oof. Yeah, the docs have been something I've been meaning to clean up.

I think we want to write all our docs in https://docs.fedoraproject.org/en-US/cloud/, and edit everywhere else (where we have permissions to do so) to point there. To start with, I opened https://pagure.io/fedora-cloud/docs-site/pull-request/5 so the landing page is acceptable enough to update the link at https://fedoraproject.org/cloud/ to point at it.

There is an open issue requesting information for finding archived Fedora Cloud images be included. Perhaps a link to https://archives.fedoraproject.org/pub/archive/fedora/linux/releases/ on the new documentation page would suffice?

https://gitlab.com/fedora/websites-apps/fedora-websites/fedora-websites-3.0/-/issues/317

Metadata