From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124]) by inbox.dpdk.org (Postfix) with ESMTP id B219243158; Fri, 13 Oct 2023 18:28:51 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 32543402CC; Fri, 13 Oct 2023 18:28:51 +0200 (CEST) Received: from mgamail.intel.com (mgamail.intel.com [134.134.136.31]) by mails.dpdk.org (Postfix) with ESMTP id 127254027D for ; Fri, 13 Oct 2023 18:28:49 +0200 (CEST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=intel.com; i=@intel.com; q=dns/txt; s=Intel; t=1697214530; x=1728750530; h=date:from:to:cc:subject:message-id:references: in-reply-to:mime-version; bh=aXaaQ3frUJUMsiYgKyxzz0vmvpSDEKx8m8zR8rVT3JY=; b=VXWvF4icxu8YbkD9578XKLZQAVULKOtNb5w1Yppkd8jBVyNIMqKauDgg pxWg3St4f5h3pYtIa7xZwAktm14Zf+D2zrJQ3FQ1ag4ia7lhzJ9VHntcD cRlXhIZcbVNm5SuUN55JO/K+3ZhXLbOo41JglhajtHTqMWnF4kcYSl+sk SRBFGlrBx74uNpBzfNQIKrRMIE16AzC6FYxjLtSqO5YtelInSw1mFFICW pohCEeUtea0Nc8azS428Sk4jrO2H8V+LUKmo7oFK3t3brLp7mQPfk9lbZ f8o6c1jR2Vl07iE0mhKgJX3FH9FQtBGfm1mX9SB51leho61n9U741NU6x Q==; X-IronPort-AV: E=McAfee;i="6600,9927,10862"; a="449406518" X-IronPort-AV: E=Sophos;i="6.03,222,1694761200"; d="scan'208";a="449406518" Received: from fmsmga005.fm.intel.com ([10.253.24.32]) by orsmga104.jf.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384; 13 Oct 2023 09:28:49 -0700 X-ExtLoop1: 1 X-IronPort-AV: E=McAfee;i="6600,9927,10862"; a="1086203987" X-IronPort-AV: E=Sophos;i="6.03,222,1694761200"; d="scan'208";a="1086203987" Received: from orsmsx602.amr.corp.intel.com ([10.22.229.15]) by fmsmga005.fm.intel.com with ESMTP/TLS/AES256-GCM-SHA384; 13 Oct 2023 09:28:48 -0700 Received: from orsmsx612.amr.corp.intel.com (10.22.229.25) by ORSMSX602.amr.corp.intel.com (10.22.229.15) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.32; Fri, 13 Oct 2023 09:28:48 -0700 Received: from orsedg603.ED.cps.intel.com (10.7.248.4) by orsmsx612.amr.corp.intel.com (10.22.229.25) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256) id 15.1.2507.32 via Frontend Transport; Fri, 13 Oct 2023 09:28:48 -0700 Received: from NAM12-BN8-obe.outbound.protection.outlook.com (104.47.55.168) by edgegateway.intel.com (134.134.137.100) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.1.2507.32; Fri, 13 Oct 2023 09:28:48 -0700 ARC-Seal: i=1; a=rsa-sha256; s=arcselector9901; d=microsoft.com; cv=none; b=JgVgCJb2lXEkPGmL8mgW8kaQxgnZtD1RdOXax0qQn64HoGZh6gT75UZXdXfj17Nc8jQ8WEw4Tj+8ijksZgNzpsCjT/lv4lm7vT33SPs6OcKiUK05JbXvqS2ymhPqirqilkV7Cs9f/CGZ7ab+K60PI55sbYOHPKoXPFAgcXw4Oa4V+uTAZ8OoGHHeVGJj7jqQCicBeecCjJrL2SDw+KHuWvHKm0pfyyYX8IAGXl2Oz9qzsySRL2VY11w/jl7cqYUUN22ADsasYuknacfRx4aWCg5maTgNq2c1E4G87YsG+8xQCn6m4Mq9GyQAytLao9BcmfXfWtk1Xsy0m7JnDns48A== 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=Ahk+cAylK3+uogupEa9rcpwCEVJHc5/YmN6UdH8mbo8=; b=Q3+Axu7+Ynb7wi203t2wrhhX7v9cxydA44GjG+aX0bbH8f1xPhhf4/KqlQk9bRtTVAwvfU0RwTtp30kfgJJUyd+XHMj7Aux4tuDxk0F1+0G2F+1ReNF5jVxNMRO9pMq65Hcu1yin6rwAUtbKHnodLLiT6T5gXPYCSyCvS15venWKv0d6FdFY9h4JdrP5r0Fii2TtGhPO4ikuFfGNA3mHFweE4enS04c7CcGeVxB2zLFesoi5q0Y0GVIOxIRhnpa2y6YDBMbHxx9tShT6737JL8Xu9PoOOq5sUMj6J8YTUZ8vCpgQZsYuASlr/21N0lVDPqGIWt46qknpl+RZJbKNRA== ARC-Authentication-Results: i=1; mx.microsoft.com 1; spf=pass smtp.mailfrom=intel.com; dmarc=pass action=none header.from=intel.com; dkim=pass header.d=intel.com; arc=none Authentication-Results: dkim=none (message not signed) header.d=none;dmarc=none action=none header.from=intel.com; Received: from DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) by BN9PR11MB5418.namprd11.prod.outlook.com (2603:10b6:408:11f::18) with Microsoft SMTP Server (version=TLS1_2, cipher=TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384) id 15.20.6863.46; Fri, 13 Oct 2023 16:28:46 +0000 Received: from DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::aa85:ead1:baa8:c652]) by DS0PR11MB7309.namprd11.prod.outlook.com ([fe80::aa85:ead1:baa8:c652%2]) with mapi id 15.20.6863.043; Fri, 13 Oct 2023 16:28:46 +0000 Date: Fri, 13 Oct 2023 17:28:38 +0100 From: Bruce Richardson To: Ferruh Yigit CC: David Young , Subject: Re: [PATCH 0/6] docs: Unify Getting Started Guides Message-ID: References: <20230920154817.617-1-dave@youngcopy.com> Content-Type: text/plain; charset="us-ascii" Content-Disposition: inline In-Reply-To: X-ClientProxiedBy: DB9PR01CA0028.eurprd01.prod.exchangelabs.com (2603:10a6:10:1d8::33) To DS0PR11MB7309.namprd11.prod.outlook.com (2603:10b6:8:13e::17) MIME-Version: 1.0 X-MS-PublicTrafficType: Email X-MS-TrafficTypeDiagnostic: DS0PR11MB7309:EE_|BN9PR11MB5418:EE_ X-MS-Office365-Filtering-Correlation-Id: 12091b19-9b72-4220-3240-08dbcc0978d4 X-MS-Exchange-SenderADCheck: 1 X-MS-Exchange-AntiSpam-Relay: 0 X-Microsoft-Antispam: BCL:0; X-Microsoft-Antispam-Message-Info: LK2krPITlPQauMAj8dfnxMWcZbeXQw4T9qk9FbBCUTFFH6WlLjiNxMDtL7r1EVxN5ZysFhYpzrkCFAaxUBE4cVZgaCMkSjO3s14fmnbbxBpYMHSIbmExk9QSwoBJMgq6r5q4T7Vh0ZeZy+7uWZZUrJPx5Uc77TH/j3YwwK7jBv38k8sGuJYEwYHBDTQq7yNhDZRpEFo9PCb2ntK2UTrpiK5TH0kCPObxsL43Xx53Rl4TQkjuqAZobncFLUz5R6wV7kzIsPyttNsIiB2P61fhLNtLcyRjzs7QB8gN/3F1gFUCgiXE6xGxAcxpqjbLFG7HYdr0VcqCiZMjXJxGRj/TbW0qg0TC9Ba116hSVyzPYgjXqJ+Oi2H3GN9tfERM9oYV1+dSy9rsNA2Q8pA9O0v5Q9lzw/ueA6VMTRm9E0rSa0zl/wqVHEWF666+OXYhja7LQ3IvBBn9LVZmulcdu0BB7ho8lBW/c3GZGffgjGYIQ3FOPNDnWF9jU8ZC1H5xc5th63lDAkJ18hZUAsCRp020idUq8cDa2WevUgc990vQBC+eNivhtsMfqZdZUazI7n4G X-Forefront-Antispam-Report: CIP:255.255.255.255; CTRY:; LANG:en; SCL:1; SRV:; IPV:NLI; SFV:NSPM; H:DS0PR11MB7309.namprd11.prod.outlook.com; PTR:; CAT:NONE; SFS:(13230031)(366004)(396003)(39860400002)(136003)(346002)(376002)(230922051799003)(186009)(1800799009)(451199024)(64100799003)(86362001)(66946007)(66556008)(66476007)(6916009)(316002)(6486002)(478600001)(6666004)(2906002)(41300700001)(8676002)(8936002)(4326008)(5660300002)(44832011)(82960400001)(26005)(83380400001)(38100700002)(53546011)(6512007)(6506007); DIR:OUT; SFP:1102; X-MS-Exchange-AntiSpam-MessageData-ChunkCount: 1 X-MS-Exchange-AntiSpam-MessageData-0: =?us-ascii?Q?ZWnBYMkGz5bBbgKy++xMwvcU7KhLL9Qp3Vg5gvkG3Q83WwB/hCUrrNSijRj1?= =?us-ascii?Q?vO5ZF6K4p6ml2ilKJSxuY4eOrjrk/PmzmmbYB5yUz5UmTQPMXjUf3ji7tFVq?= =?us-ascii?Q?zEn8CBdxNNxC/M53ALDm8jv2Uy0/dzTw1YqyJttbAhVPPT7r6rr4Bx6FlDs9?= =?us-ascii?Q?hDb6a0gAiYnG1J32esTjpheEznH9xqPxrqzMxg4/2ybsn/lgDfaUz3YQ0PO2?= =?us-ascii?Q?fYKOuuVE9SxzyF3Z9UXkIsc/7cTnCv9cSp8LiWaO7pgei9jjsAILFnRVGS+E?= =?us-ascii?Q?Y5+mKMDrU+bR6VrKSVfiCAVd9w7fscnZ8EqBInMqUBENSg8eTxdD1nUbLlxd?= =?us-ascii?Q?IkNrCTfyINCp9ytyqcTH9/CYDpv1hZzD8HWjrXIyzgx4L4vEJ2WHsQzMMsC6?= =?us-ascii?Q?ZCFihK6K0YRtSnrkaFVOP1jgLuPmyHIciQWZd+cmsNoN9blU0qJNcCjJxx9E?= =?us-ascii?Q?19Rpju3rT5LvmoLXhk4FF3Z9DXKOYwstTebSFv+WCkXrALKUFmTtWE9QhZht?= =?us-ascii?Q?IV3bZZL642H337EEftHLCV00FAwG/4vjv9f8rpEZuc4RMAZ4XY3rs+99CSgB?= =?us-ascii?Q?19bO28DgVH/sZ3JANhnOe3o8clCkdbRn4yUyZKWpHXglIG/aWRT9zmcIHFb6?= =?us-ascii?Q?Sdzsz38qTpNedxOnf4CF0aGOuxUgiClWS+OSJ6y/MAlOKGyCjGjCMXdAiRir?= =?us-ascii?Q?KO8bLTb94se9Lvugcr0eNkJtVbQLO+FWfVRY16rgZj6T7ycAADzjPy0qGJC+?= =?us-ascii?Q?r9wc7YoxRB5bn63Rr/a679YzjfXzs2CLX1sbfXWKT5low/lob8LAaESrJ+Go?= =?us-ascii?Q?SUjsss3MPJ8zEkjGDpDw8vTJa2BCr1xZ9zEqOFNgRyHpyvxqCabkkcwQEq57?= =?us-ascii?Q?AZbWD2fSEzMoWZSnfZJqRZFylAfybV28i2WxgIG2iVpeJVl/9vquLRfr+GYU?= =?us-ascii?Q?R6fdQysB8O9nVbjnbggiMzr93uO/lBFy7XoZ4wlQq017+1YCOYw0nveBPi/t?= =?us-ascii?Q?tG8DIyothuWIsuJKQlalV9RT8p38rpT3lUMiG5suS4FuoLeizPQ57OHLMud0?= =?us-ascii?Q?nguhuk6N4nyd5OZ1WQDFtW0WMCY0fhSWJRv8dGsAVGSY8JfYX6qVxZwHvj1H?= =?us-ascii?Q?57uLZvpzHB3jbLx3v4VhWmb7uZpeiwUpI2SKVFBHVzP9zzw72tfGl3hgzGBQ?= =?us-ascii?Q?tw0B5EYZKOm5j2lpMWLzbaVKHvO9udbHLvCnd1mgINOf+Qyj+4TSA1TD6x9+?= =?us-ascii?Q?eFk/fOe8HPvkOFRiwliBCvmuubLKdECif8+GpuZdTSaYnd9b1ApTh0mbsihr?= =?us-ascii?Q?E2RehbSRpVgWxaK426YztRUaOV+uNlx/+J7WSqliiViynBl5+p+aGsVLVo81?= =?us-ascii?Q?JF2K4I1Mb8itgWFd8Cstn8o+JFkCyOUaSYJniHW0xJv2yuU4GyZYIEsFT3F2?= =?us-ascii?Q?onr/09yJwRDULxijzGO6Uouu1Iyg8tILw+6SqpDWmvQwoI2flXUtOpC/IhAK?= =?us-ascii?Q?WIbieWRyf1QfLbBrz6iYFYnmmhWEXt7h5m/Hgo7Bg1htr+pTGEDgRy0CuVUC?= =?us-ascii?Q?AT9u8lAOg89SqM4HRApegKuoNDEZX2uNHTFGt/YRIrHDjfUMmuL0piFh0YD9?= =?us-ascii?Q?xw=3D=3D?= X-MS-Exchange-CrossTenant-Network-Message-Id: 12091b19-9b72-4220-3240-08dbcc0978d4 X-MS-Exchange-CrossTenant-AuthSource: DS0PR11MB7309.namprd11.prod.outlook.com X-MS-Exchange-CrossTenant-AuthAs: Internal X-MS-Exchange-CrossTenant-OriginalArrivalTime: 13 Oct 2023 16:28:45.9626 (UTC) X-MS-Exchange-CrossTenant-FromEntityHeader: Hosted X-MS-Exchange-CrossTenant-Id: 46c98d88-e344-4ed4-8496-4ed7712e255d X-MS-Exchange-CrossTenant-MailboxType: HOSTED X-MS-Exchange-CrossTenant-UserPrincipalName: 8nhhAaukKccFckHxItPbEhQP6cCE2DhodI76gr88UmGAB6143pal56rwyTYqjII5SVypV1a0jx/lhN5AzzfV3MjIssv6i/flkZ86T6VtHqU= X-MS-Exchange-Transport-CrossTenantHeadersStamped: BN9PR11MB5418 X-OriginatorOrg: intel.com X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: DPDK patches and discussions List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org On Mon, Sep 25, 2023 at 12:54:15PM +0100, Ferruh Yigit wrote: > On 9/20/2023 4:48 PM, David Young wrote: > > The separate Getting Started Guides for Linux, FreeBSD, and Windows > > have been consolidated into a single, streamlined guide to simplify the > > user experience and facilitate easier maintenance. > > > > David Young (6): Section 1: Introduction Section 2: Install and Build > > DPDK Section 3: Setting up a System to Run DPDK Applications Section 4: > > Running Applications Section 5: Appendix Section 6: Glossary > > > > Hi David, > > New documentations are not in the toctree, so they are not accessible by > the links in the left column. Sphinx generates warning for this: > WARNING: document isn't included in any toctree > > Also existing per platform documentation is not removed yet. > > I assume both above done intentionally for the development phase of this > documentation, but this is just a reminder in-case not. > > > And not all context seems moved from existing per platform getting > started guides, is there are plan to keep them around for a while as > reference, or move that context to other files? > Part of the work in consolidating these docs is to remove any unnecessary details. After all, these are Getting Started Guides, which should contain only the minimal info for getting started and not much else. The more content we have, the harder the docs become to follow. Some extra content is moved to the appendicies, but I, for one, think we should keep these docs as slim as possible. For example, we should document one way to do things in the main doc. Any alternative methods should be documented via links elsewhere. For content that is not transferred over as part of this patchset, if there are any concerns about omissions, I think we should discuss them on a case by case basis. Just because something was in the original docs does not mean it needs to go in the new one. :-) /Bruce