Yocto Project Documentation
 help / color / mirror / Atom feed
From: Trevor Woerner <twoerner@gmail.com>
To: docs@lists.yoctoproject.org
Subject: linking externally to the latest branch
Date: Sun, 19 Dec 2021 18:28:01 -0500	[thread overview]
Message-ID: <20211219232801.GA38509@localhost> (raw)

Hi,

The Mender documentation links into the Yocto Project documentation to allow
users an easy path for performing additional research as they work through
the Mender documentation while working on getting Mender working in the Yocto
builds. Many of those links (from Mender's docs) link to the Yocto Project's
old docs site, so I was thinking of updating some of those links. However,
Mender only officially supports Dunfell (3.1.x) with their free offering,
so when a user clicks on the old links they are forwarded to the new Yocto
Project documentation, referencing the "latest" docs release. This will
inevitably confuse users since Mender is based on Dunfell, not master.

The Yocto Project's documentation site conveniently provides a drop-down which
allows users to switch to the documentation for a given release, but these
releases are specific to the exact point release of a given branch.

For example to link to the Dunfell documentation regarding read-only rootfs I
could update the link on:
	https://docs.mender.io/system-updates-yocto-project/image-customization/read-only-root-filesystem
which currently points to:
	https://www.yoctoproject.org/docs/latest/mega-manual/mega-manual.html#creating-a-read-only-root-filesystem?target=_blank
to point to:
	https://docs.yoctoproject.org/3.1.12/singleindex.html#creating-a-read-only-root-filesystem
but that's specific to 3.1.12 exactly.

Is there a way to replace the "3.1.12" in the above URL with something that
means "the latest 3.1.x"?

Best regards,
	Trevor


                 reply	other threads:[~2021-12-19 23:28 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20211219232801.GA38509@localhost \
    --to=twoerner@gmail.com \
    --cc=docs@lists.yoctoproject.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox