mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Costa Shulyupin <costa.shul@redhat.com>,
	Mauro Carvalho Chehab <mchehab@kernel.org>,
	linux-doc@vger.kernel.org
Cc: Costa Shulyupin <costa.shul@redhat.com>,
	open list <linux-kernel@vger.kernel.org>
Subject: Re: [PATCH v2] docs: automatic redirects for moved pages
Date: Mon, 01 May 2023 07:31:23 -0600	[thread overview]
Message-ID: <87lei89o0k.fsf@meer.lwn.net> (raw)
In-Reply-To: <20230501021338.182770-1-costa.shul@redhat.com>

Costa Shulyupin <costa.shul@redhat.com> writes:

> Problems:
> - The documentation is not well-organized
> - Relocating pages disrupts external links to
>   the documentation and causes confusion for users
>
> Benefits:
> - Users can easily access relocated pages from external resources
> - Using redirects frees up options for reorganizing the documentation
>
> The solution:
> - To prevent the need for ongoing maintenance, extract renames
>   from git log since specified age
> - Input the renames into sphinx_reredirects module
>
> Signed-off-by: Costa Shulyupin <costa.shul@redhat.com>
>
> ---
>
> Changes:
> - added the extraction of renames from Git.
>
> ---
>  Documentation/Makefile                |  8 +++++++-
>  Documentation/conf.py                 | 17 ++++++++++++++++-
>  Documentation/sphinx/requirements.txt |  1 +
>  3 files changed, 24 insertions(+), 2 deletions(-)

So this adds another time-consuming process to the docs build,
generating over 2600 redirects, and breaking the build if it's not done
in a git tree.  All for a problem that still has not actually been
demonstrated to exist.

Costa, I appreciate that you are trying to help, but this is getting
worse, not better.  Please, let's wait until an actual problem arises,
then we can talk about the best way to address it.

Thanks,

jon

      reply	other threads:[~2023-05-01 13:31 UTC|newest]

Thread overview: 2+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-01  2:13 Costa Shulyupin
2023-05-01 13:31 ` Jonathan Corbet [this message]

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=87lei89o0k.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=costa.shul@redhat.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=mchehab@kernel.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

all inboxes | Powered by JetHome®