Re: front page suggestions

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]


On Thu, Dec 9, 2021 at 11:52 AM Matthew Miller <mattdm@xxxxxxxxxxxxxxxxx> wrote:
> I don't think it'd actually be harder. Look at Python documentation — the
> top level links all go to, which defaults to
> "latest", but you can choose earlier versions from the dropdown. We have
> that same thing with Antora, but two entry points.

Sure. This topic isn't worth a battle royale for me, but I do think it
would represent a regression in how we present our documentation, even
though the docs are still there and findable.

> Also though: that versioned documentation contains three things:

This is a digression, but I agree with all of it.

> Yes. Right now, once you click on
>, you're in that space,
> and is another, each with unique
> left menus. What if we put them all into one unified menu, with the edition
> names as top-level menu items on the left menu?

That would represent a pretty significant paradigm shift. We might be
able to get all of the docs to pull nav.adoc from an external repo,
but that would break local preview builds. Otherwise, we'd need to
combine all of those into a single repo, which presents its own set of

The other approach would be to reproduce all of the nav in each
module's nav.adoc. But this would require being kept in sync manually.
That content would be relatively static, so it wouldn't drift too
often, but that also means we'd probably forget about it when a new
change is made.

> > > 6. Not sure where stuff like Gaming should go.
> > Are we talking about using Games or participating in the Games SIG?
> I guess it is the later. But where would user documentation produced by that
> team go?

For the latter, it would be under Engineering Teams. For the former,
when it exists, it would go under Quick Docs or release-specific docs,
I'd say.

> > > 8. Outreachy docs should be removed, since they're not on the docs site.
> > Why does it matter if it's on the docs site? It's still documentation.
> Because we're steering people back into the wiki, perpetuating the confusion
> of our current "where are the docs" story.
> Or to put it another way: I don't think the docs.fpo front page should serve
> as an index to the wiki, even if that part of the wiki is kept up to date.

I agree with the fact that "where are the docs" is confusing. But
using docs.fp.o to point to things that are still in the wiki for
whatever reason makes it less confusing. The story is "go to docs.fp.o
and follow the link you want". If that stays on docs or sends folks to
the wiki or readthedocs or whatever other platform, that's okay. The
point is that docs.fp.o becomes _the_ front page of our documentation.

Ben Cotton
He / Him / His
Fedora Program Manager
Red Hat
docs mailing list -- docs@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to docs-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct:
List Guidelines:
List Archives:
Do not reply to spam on the list, report it:

[Index of Archives]     [Fedora Users]     [Fedora Desktop]     [Red Hat 9]     [Yosemite News]     [KDE Users]

  Powered by Linux