linux-doc.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Randy Dunlap <rdunlap@infradead.org>, linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org,
	Thorsten Leemhuis <linux@leemhuis.info>,
	Kees Cook <keescook@chromium.org>,
	Jani Nikula <jani.nikula@linux.intel.com>
Subject: Re: [PATCH v2 2/7] docs: Rewrite the front page
Date: Fri, 23 Sep 2022 13:07:53 -0600	[thread overview]
Message-ID: <871qs19aeu.fsf@meer.lwn.net> (raw)
In-Reply-To: <f5830658-9cd7-4d44-6fd6-d031da1a3442@infradead.org>

Randy Dunlap <rdunlap@infradead.org> writes:

> Hi Jonathan,
>
> On 9/22/22 13:41, Jonathan Corbet wrote:
>> The front page is the entry point to the documentation, especially for
>> people who read it online.  It's a big mess of everything we could think to
>> toss into it.  Rewrite the page with an eye toward simplicity and making it
>> easy for readers to get going toward what they really want to find.
>> 
>> This is only a beginning, but it makes our docs more approachable than
>> before.
>> 
>> Signed-off-by: Jonathan Corbet <corbet@lwn.net>
>> ---
>>  Documentation/index.rst          | 150 +++++++++++--------------------
>>  Documentation/subsystem-apis.rst |  58 ++++++++++++
>>  2 files changed, 111 insertions(+), 97 deletions(-)
>>  create mode 100644 Documentation/subsystem-apis.rst
>
> I don't see a kernel version listed anywhere on the front page
> (maybe it depends on what theme is used?) at
> https://static.lwn.net/kerneldoc/, so I think it needs something like
> this.
>
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -18,6 +18,8 @@ documents into a coherent whole.  Please
>  documentation are welcome; join the linux-doc list at vger.kernel.org if
>  you want to help out.
>  
> +This documentation is for Linux kernel $(KERNELRELEASE).
> +

Ah, it does look like we lost that in the transition; I'll make sure it
gets put back.

Thanks,

jon

  reply	other threads:[~2022-09-23 19:07 UTC|newest]

Thread overview: 37+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-09-22 20:41 [PATCH v2 0/4] Rewrite the top-level index.rst Jonathan Corbet
2022-09-22 20:41 ` [PATCH v2 1/7] docs: promote the title of process/index.html Jonathan Corbet
2022-09-23 17:53   ` David Vernet
2022-09-23 18:31     ` Jonathan Corbet
2022-09-22 20:41 ` [PATCH v2 2/7] docs: Rewrite the front page Jonathan Corbet
2022-09-23 19:02   ` Randy Dunlap
2022-09-23 19:07     ` Jonathan Corbet [this message]
2022-09-24  2:05   ` David Vernet
2022-09-22 20:41 ` [PATCH v2 3/7] docs: reconfigure the HTML left column Jonathan Corbet
2022-09-24  2:13   ` David Vernet
2022-09-22 20:41 ` [PATCH v2 4/7] docs: remove some index.rst cruft Jonathan Corbet
2022-09-24  2:14   ` David Vernet
2022-09-22 20:41 ` [PATCH v2 5/7] docs: move asm-annotations.rst into core-api Jonathan Corbet
2022-09-23  7:45   ` Bagas Sanjaya
2022-09-24  2:10   ` kernel test robot
2022-09-24  2:20   ` David Vernet
2022-09-25  3:54   ` Bagas Sanjaya
2022-09-25 21:29     ` Jonathan Corbet
2022-09-22 20:41 ` [PATCH v2 6/7] docs: Expand the front-page CPU-architecture section Jonathan Corbet
2022-09-24  2:25   ` David Vernet
2022-09-25 21:50     ` Jonathan Corbet
2022-09-22 20:41 ` [PATCH v2 7/7] docs: put atomic*.txt and memory-barriers.txt into the core-api book Jonathan Corbet
2022-09-23  4:25   ` Bagas Sanjaya
2022-09-23 13:39     ` Jonathan Corbet
2022-09-25  3:18       ` Bagas Sanjaya
2022-09-25  3:48         ` Randy Dunlap
2022-09-25  3:52           ` Bagas Sanjaya
2022-09-23 18:44   ` Randy Dunlap
2022-09-23 19:06     ` Jonathan Corbet
2022-09-23  8:09 ` [PATCH v2 0/4] Rewrite the top-level index.rst Jani Nikula
2022-09-23  8:55 ` Thorsten Leemhuis
2022-09-23 13:45   ` Jonathan Corbet
2022-09-23 14:43     ` Thorsten Leemhuis
2022-09-23 15:03       ` Jonathan Corbet
2022-09-23 17:45         ` Kees Cook
2022-09-24  1:56         ` David Vernet
2022-09-23 18:48     ` Randy Dunlap

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=871qs19aeu.fsf@meer.lwn.net \
    --to=corbet@lwn.net \
    --cc=jani.nikula@linux.intel.com \
    --cc=keescook@chromium.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux@leemhuis.info \
    --cc=rdunlap@infradead.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;
as well as URLs for NNTP newsgroup(s).