From patchwork Tue Jan 9 15:56:41 2024 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Carlos Bilbao X-Patchwork-Id: 18873 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:7300:2411:b0:101:2151:f287 with SMTP id m17csp206868dyi; Tue, 9 Jan 2024 08:01:25 -0800 (PST) X-Google-Smtp-Source: AGHT+IF7q+WVt2xQUrAnSlPPScjRiw4WnjoV1bD23UbLFpZrbuQI9w1JHoWyErJtCaXIffhl7fMN X-Received: by 2002:a17:903:2ace:b0:1d4:3fb3:c3f0 with SMTP id lw14-20020a1709032ace00b001d43fb3c3f0mr3363659plb.9.1704816085307; Tue, 09 Jan 2024 08:01:25 -0800 (PST) ARC-Seal: i=2; a=rsa-sha256; t=1704816085; cv=pass; d=google.com; s=arc-20160816; b=Z9LIOEebAP9bQClJwE74ZIbR4CNNQocyt5kVZi2eiSUlAdpCtTGU5kaAp7oncfFzVH ZiN+4NbI13mmjIDzLEWDOoobtGTZvyNkGe+7uRyhsvUkHBLZV/kov7qFeGL64lRklmRC Tv3JpOyqnSn4nALWd1oWyqUmJqYdStoY6YyJSARIIfawcKSM+dJrn8Cy5c5hpoF6Vff/ amjrUS2n8Iwk7M8m1ek8juQ++0wYUxQFsELAFJwbsR0r1BNBx6htbXSNqpGnJQbN1EX1 fvZ68cQiinze4bvvLMTBVK/mlqVVW4B0xsi7BCycLwtRNBVp6tv93FWmyhnS+54b5sSJ 6Q3w== ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=content-transfer-encoding:mime-version:list-unsubscribe :list-subscribe:list-id:precedence:message-id:date:subject:cc:to :from:dkim-signature; bh=3bEOW2eYVCs06Ew/v0DfxoWVsZHrbZ7fY1D5fCUe0g0=; fh=RmTU05srhHI8cnD2/P1esN4o5bRimTiwY0ZH4TgnErU=; b=BuMsu/kLBJdmdpPBhUWBTczQwDTSV2g1MRW9mYt3EZNE0gWglEwMc2daOwww8z67r2 AF9TK/3T9vDY5ized8uYM51rHK7QQOeIvz6wyMYx8l3SEMKjBmdf6iqtCskhkt0cmc5f 9McFZY7Bm0uq1fYvP2PeSPBQIrms31QdA775pRZGypgkI1677gEXcW8fEbg59zC+U1nN aYdfwk6TF8q7tt510z+TGOa4pmF1RV8iNOUr1tvutY8aB2cUYlg/eFpxuEqlR990Oc9z W/478XM/UmkMRJuYkgdKXa7j0XgCcaAyy8YNCNog1fmHtK1TvuGCFcSmGMn68+dyncGG dNZg== ARC-Authentication-Results: i=2; mx.google.com; dkim=pass header.i=@amd.com header.s=selector1 header.b=yNeN0MjP; arc=pass (i=1 spf=pass spfdomain=amd.com dmarc=pass fromdomain=amd.com); spf=pass (google.com: domain of linux-kernel+bounces-21083-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-21083-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=amd.com Received: from sy.mirrors.kernel.org (sy.mirrors.kernel.org. [2604:1380:40f1:3f00::1]) by mx.google.com with ESMTPS id x20-20020a17090300d400b001d4bb7bf9fasi1609213plc.602.2024.01.09.08.01.24 for (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 09 Jan 2024 08:01:25 -0800 (PST) Received-SPF: pass (google.com: domain of linux-kernel+bounces-21083-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) client-ip=2604:1380:40f1:3f00::1; Authentication-Results: mx.google.com; dkim=pass header.i=@amd.com header.s=selector1 header.b=yNeN0MjP; arc=pass (i=1 spf=pass spfdomain=amd.com dmarc=pass fromdomain=amd.com); spf=pass (google.com: domain of linux-kernel+bounces-21083-ouuuleilei=gmail.com@vger.kernel.org designates 2604:1380:40f1:3f00::1 as permitted sender) smtp.mailfrom="linux-kernel+bounces-21083-ouuuleilei=gmail.com@vger.kernel.org"; dmarc=pass (p=QUARANTINE sp=QUARANTINE dis=NONE) header.from=amd.com Received: from smtp.subspace.kernel.org (wormhole.subspace.kernel.org [52.25.139.140]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by sy.mirrors.kernel.org (Postfix) with ESMTPS id A4175B24E16 for ; Tue, 9 Jan 2024 15:57:29 +0000 (UTC) Received: from localhost.localdomain (localhost.localdomain [127.0.0.1]) by smtp.subspace.kernel.org (Postfix) with ESMTP id D7CC43A27E; Tue, 9 Jan 2024 15:56:52 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dkim=pass (1024-bit key) header.d=amd.com header.i=@amd.com header.b="yNeN0MjP" Received: from NAM11-DM6-obe.outbound.protection.outlook.com (mail-dm6nam11on2084.outbound.protection.outlook.com [40.107.223.84]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by smtp.subspace.kernel.org (Postfix) with ESMTPS id EF9D938DC1; Tue, 9 Jan 2024 15:56:47 +0000 (UTC) Authentication-Results: smtp.subspace.kernel.org; dmarc=pass (p=quarantine dis=none) header.from=amd.com Authentication-Results: smtp.subspace.kernel.org; spf=fail smtp.mailfrom=amd.com ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=E/WOMWZsT54zcqNLDefDku+tk38ByP2zKWnOd0q4yRIX8mLet/pYXMw78X2J8sY4XU/CyEYTNJGWiIX+QGspWHYjW/cDMz/520YY+0xMMBvilYkIM2AdGM2Yz0PJeEysNi2Ml09GjJo4e5JbuW3Y/Rf8g0ctz5uYuYvEoiXa5CBMyhEikvI2yz4q8sF3B0EV0JpYnwZsZHKhSSQuu6zMDuyVAfRVMHWa8EtyURSK75CZ7nFtmlVRTTc9meYiJTeOTJ6oXbxrJv6RUwXHIhm2bXrVSLNfUAxce2vZbt9VUNbD5sAgQ83FVkR3khs0OqQpUrujbS6uWfPY0lbLfa3cKA== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=microsoft.com; s=arcselector9901; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-AntiSpam-MessageData-ChunkCount:X-MS-Exchange-AntiSpam-MessageData-0:X-MS-Exchange-AntiSpam-MessageData-1; bh=3bEOW2eYVCs06Ew/v0DfxoWVsZHrbZ7fY1D5fCUe0g0=; b=iSlZMh7MTy03Awdc8Vuvj0AzbvCw5hbNGyHwuO0GdlA12IWqQpKgctYvHMgsb+5zccK5pyekQHHhhsq9xmk2vqxPozTXHEvxZvyFirQ/lpfPvL3XaNq/4NHAxXaXnJrqJ1suSA4tD9HqeS4zdxLcdIEAQI54MTugu8laS6lQdOOVTHzUNBPh/v9onzXKmJxP3huUYZAzyBVS26aFR8n9Kuwi78qo42IRjs83k4FDyc7PGcqpIkjX3ndX7Y3O61OgN/Hxc0OiXQfaFi2TyNoh53I4lQBsoVfg0Py9Nnx0E6GFYcASGXAkysPSj+DCyeeFaIjjfWP8lz5v+8AC/cFdEg== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass (sender ip is 165.204.84.17) smtp.rcpttodomain=lwn.net smtp.mailfrom=amd.com; dmarc=pass (p=quarantine sp=quarantine pct=100) action=none header.from=amd.com; dkim=none (message not signed); arc=none (0) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=amd.com; s=selector1; h=From:Date:Subject:Message-ID:Content-Type:MIME-Version:X-MS-Exchange-SenderADCheck; bh=3bEOW2eYVCs06Ew/v0DfxoWVsZHrbZ7fY1D5fCUe0g0=; b=yNeN0MjPmOGiRTw2htDOLrDSLio9wWcJEB5ha19zX1XfFwFOh67qjWjKWZC/Ci52a1A1q89uXRi/htgHeS+nKEEsqmrKJUnmko9w3UngBPG5qfKJv4loqVeILumGldXcTLUHnqYMhrb/DEhMjWo4r3LQ8B5KfmWcwsf273i2HD4= Received: from SJ0PR05CA0088.namprd05.prod.outlook.com (2603:10b6:a03:332::33) by SJ1PR12MB6169.namprd12.prod.outlook.com (2603:10b6:a03:45c::16) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7159.23; Tue, 9 Jan 2024 15:56:45 +0000 Received: from CO1PEPF000044F8.namprd21.prod.outlook.com (2603:10b6:a03:332:cafe::92) by SJ0PR05CA0088.outlook.office365.com (2603:10b6:a03:332::33) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.7181.14 via Frontend Transport; Tue, 9 Jan 2024 15:56:45 +0000 X-MS-Exchange-Authentication-Results: spf=pass (sender IP is 165.204.84.17) smtp.mailfrom=amd.com; dkim=none (message not signed) header.d=none;dmarc=pass action=none header.from=amd.com; Received-SPF: Pass (protection.outlook.com: domain of amd.com designates 165.204.84.17 as permitted sender) receiver=protection.outlook.com; client-ip=165.204.84.17; helo=SATLEXMB04.amd.com; pr=C Received: from SATLEXMB04.amd.com (165.204.84.17) by CO1PEPF000044F8.mail.protection.outlook.com (10.167.241.198) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.20.7202.4 via Frontend Transport; Tue, 9 Jan 2024 15:56:44 +0000 Received: from SATLEXMB04.amd.com (10.181.40.145) by SATLEXMB04.amd.com (10.181.40.145) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.34; Tue, 9 Jan 2024 09:56:44 -0600 Received: from iron-maiden.amd.com (10.180.168.240) by SATLEXMB04.amd.com (10.181.40.145) with Microsoft SMTP Server id 15.1.2507.34 via Frontend Transport; Tue, 9 Jan 2024 09:56:43 -0600 From: Carlos Bilbao To: , , CC: , , , Carlos Bilbao Subject: [PATCH v2 0/2] docs: Include simplified link titles in main index Date: Tue, 9 Jan 2024 09:56:41 -0600 Message-ID: <20240109155643.3489369-1-carlos.bilbao@amd.com> X-Mailer: git-send-email 2.34.1 Precedence: bulk X-Mailing-List: linux-kernel@vger.kernel.org List-Id: List-Subscribe: List-Unsubscribe: MIME-Version: 1.0 X-EOPAttributedMessage: 0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: CO1PEPF000044F8:EE_|SJ1PR12MB6169:EE_ X-MS-Office365-Filtering-Correlation-Id: bf5ad3dc-33b1-40c9-8ce2-08dc112b9468 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: Lk7he11pglC/pDUUolYmZjhIYI0aSZO7JjWk6dClGmXbitvXU5tCWsVIlwtKTymleCz0G3qBIE59UxKYc1UO4fogWV+typ+IHvNxJIkaduIUchzhMbbAKMz4cbQtykOnGfpcfi2GnbbvheRZL+cXCQ8O38PVAbdV7kWn/o74oX8EjAPq5BdVjmpf3MBUImsMiOn+BagG0ypWx5B68YSWket4+UzXLExe4nOIrCfoIOieqwoAkuTtxSE57z9SgOz90ypJExH24AMwzvyG8LzrLnZKUVnun+3t4oIqCDwqSROLAXPXQzk/cxOi5WXPr9sv73jnbErXwOuhirY8ExDMHeORjT7GVOvz3zlLLu46Uu4nlDzc2+5WfqG3uAOXk7k42gnNToL3wApZznVpWZBqHT7gdFnuarnrJg80Orq+0+4wItHFY6mbso39hVBdPUTRgoPOfl3VoBg2Ti8iEhpBgYrCf6n8AtrhcBg9WpzroXLvE8719DLzfJalpkDK3KiNtzMVXmjlHluyVmpEmRuMkEwiqfDG8ZocirD95aPIhyUkQxXZcNv/1ry7Jryt0yM4lbnaAe1jpdyup/WDtQ3+tRvh9N2Q2Mb9qLlPLinZ5GDhmAV7b6qKpOMlsHDRmSVXHHX32Qf7ZYrd0SbmLY36ezhXtMBHSRFQA8W9GH0IvBts7dr8GGpZrj+7KL7dvOIzgarYmfq89Rvi4KcUOjBFZc6B8jEi9dYJdfMzDKKvT+Y= X-Forefront-Antispam-Report: CIP:165.204.84.17;CTRY:;LANG:en;SCL:1;SRV:;IPV:CAL;SFV:NSPM;H:SATLEXMB04.amd.com;PTR:InfoDomainNonexistent;CAT:NONE;SFS:(13230031)(4636009)(376002)(136003)(39860400002)(396003)(346002)(230922051799003)(64100799003)(82310400011)(186009)(451199024)(1800799012)(40470700004)(36840700001)(46966006)(426003)(336012)(83380400001)(110136005)(356005)(36860700001)(82740400003)(2906002)(47076005)(86362001)(41300700001)(36756003)(54906003)(81166007)(7696005)(316002)(70586007)(2616005)(966005)(478600001)(8936002)(5660300002)(70206006)(4326008)(26005)(1076003)(44832011)(8676002)(40460700003)(40480700001)(36900700001);DIR:OUT;SFP:1101; X-OriginatorOrg: amd.com X-MS-Exchange-CrossTenant-OriginalArrivalTime: 09 Jan 2024 15:56:44.9507 (UTC) X-MS-Exchange-CrossTenant-Network-Message-Id: bf5ad3dc-33b1-40c9-8ce2-08dc112b9468 X-MS-Exchange-CrossTenant-Id: 3dd8961f-e488-4e60-8e11-a82d994e183d X-MS-Exchange-CrossTenant-OriginalAttributedTenantConnectingIp: TenantId=3dd8961f-e488-4e60-8e11-a82d994e183d;Ip=[165.204.84.17];Helo=[SATLEXMB04.amd.com] X-MS-Exchange-CrossTenant-AuthSource: CO1PEPF000044F8.namprd21.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Anonymous X-MS-Exchange-CrossTenant-FromEntityHeader: HybridOnPrem X-MS-Exchange-Transport-CrossTenantHeadersStamped: SJ1PR12MB6169 X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1787628996651000371 X-GMAIL-MSGID: 1787629231386984152 The general consensus is that the documentation's website main entry point and its sidebar leave room for improvement. Something we can easily fix is that there's too much duplicated text. To that point, consider the titles "The Linux kernel user's and administrator's guide" and "The Linux kernel user-space API guide." We get it, it's the Linux kernel. It's assumed that everything listed pertains to the Linux kernel, given the overarching title, "The Linux Kernel documentation." Constant repetition of "Linux" and "kernel" (45 times each), "documentation" (21 times), and "guide" (18 times) are excessive and affect UX. I propose simplifying without altering actual document titles, the text linking to these documents on the main page ("link titles"). For example, "The Linux kernel user's and administrator's guide" could become "User's and Administrator's Guide," and "A guide to the Kernel Development Process" could be "Development Process". This is what my patch does. Also, I send a patch fixing the formatting of the title of admin-guide/index.rst (The Linux kernel user's and administrator's guide); a detail I noticed because the link title would not work otherwise. Thanks, Carlos Carlos Bilbao (2): docs: Correct formatting of title in admin-guide/index.rst docs: Include simplified link titles in main index --- v1 Link: https://lore.kernel.org/lkml/58e78693-82d1-451d-a546-51fb64ef6eb5@vt.edu/T/ Changes since v1: - Apply feedback: Driver implementation API -> Driver APIs Testing -> Testing guide Hacking -> Hacking guides User-space tools -> Userspace tools User-space API -> Userspace APIs CPU Architectures -> CPU architectures - Include patch fixing the title of The Linux kernel user's and administrator's guide. - Minor changes: Change "main page's index" for "main index" in commit subject. Also use my work email to sign the commits. --- Documentation/admin-guide/index.rst | 1 + Documentation/index.rst | 52 ++++++++++++++--------------- 2 files changed, 27 insertions(+), 26 deletions(-)