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 1148942369; Wed, 11 Oct 2023 20:34:32 +0200 (CEST) Received: from mails.dpdk.org (localhost [127.0.0.1]) by mails.dpdk.org (Postfix) with ESMTP id 8FA37400EF; Wed, 11 Oct 2023 20:34:31 +0200 (CEST) Received: from mail-ej1-f47.google.com (mail-ej1-f47.google.com [209.85.218.47]) by mails.dpdk.org (Postfix) with ESMTP id 9C97F400D7 for ; Wed, 11 Oct 2023 20:34:30 +0200 (CEST) Received: by mail-ej1-f47.google.com with SMTP id a640c23a62f3a-9ae65c0e46fso4154066b.0 for ; Wed, 11 Oct 2023 11:34:30 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=youngcopy-com.20230601.gappssmtp.com; s=20230601; t=1697049270; x=1697654070; darn=dpdk.org; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:from:to:cc:subject:date:message-id:reply-to; bh=vBPBZi7pZKOzyFi4jzQ37QOOo22hf31fWAz364a3A00=; b=EdJQRROeD4uGhXldSxiieqA7UAdEvjTPWexYuSapzcwAhTzaRqAaa5FyvooRd0Yqw9 Uq9pibQrT7OAE5JnIQyY+40MO7nGZ7Be06G2tu0rgHUFVjf6FP5aXIpgX5WtqLmkUTg7 bpaZDDBNCgHLmnBd6dDiJ89w49LFm9aBzSok92Rsl6jss+y/Wb0CQCYLLI0CnQhzYncC wOG+/HbaXAXKzImRY+MbgiAR+yLtZvX9iHsROUGMd/pSKHKxXdaJW9EmMdkf2BSstfm9 wGoXOMY25xd9ZDfa7L7TIsRmcWC33WlzvpuJd9uFxgR4yHPxam0kBjjsZjoyhdmWesGV yACQ== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1697049270; x=1697654070; h=cc:to:subject:message-id:date:from:in-reply-to:references :mime-version:x-gm-message-state:from:to:cc:subject:date:message-id :reply-to; bh=vBPBZi7pZKOzyFi4jzQ37QOOo22hf31fWAz364a3A00=; b=JFjQ8h+hdB3ht2oU+Q6m3CnmwdZuA67sKhi/G8rN/N2PulrD3jVo6aoqdR5mfI08se 4Ff0AXjmu4uW0D7AGuKcB+aci6yR+5DseNOfnbB0lvHnx1Rq1s1MsDY4fFGc48UOVfX4 4kYy+Wr+RzuGpn4ql84KynJA2WiVFM3/eoxq3OUR4ebtFIDUVzT3ZC32ZFXLMSweL0+L Tag1BepubQ/7HRPgktDelMsMslo9H0oN4bmIWojwUT2yOSUsnAjFsyqtyNJRjIM/wjbk wUV/ZodzGWCwH4scaUIZLCZBXfC4MsM748YmgHYvtn40RDP/mPB+/5GhLRo2UE7YwHZj BwQA== X-Gm-Message-State: AOJu0YzEP4csQrsR3IcCeb96eGkePHqeqM4DJSGZf6iD2s4zemwQdXCk Dxtz578p0YEVA9U6bwsLX8xevvMAkqfdL7S1BPQHFQ== X-Google-Smtp-Source: AGHT+IEqxUMkEocHha64u+5ivw8RGdCHXeyD5+nLfzRkrqBPNcV6mxscTqtIrRlh+0gkfC+BIeGXxyG5LWG2F3vRYZ4= X-Received: by 2002:a17:906:ce:b0:9b2:bf2d:6b66 with SMTP id 14-20020a17090600ce00b009b2bf2d6b66mr15025025eji.7.1697049270094; Wed, 11 Oct 2023 11:34:30 -0700 (PDT) MIME-Version: 1.0 References: <20230920154817.617-1-dave@youngcopy.com> In-Reply-To: From: Dave Young Date: Wed, 11 Oct 2023 14:34:18 -0400 Message-ID: Subject: Re: [PATCH 0/6] docs: Unify Getting Started Guides To: Ferruh Yigit Cc: dev@dpdk.org, Bruce Richardson Content-Type: multipart/alternative; boundary="000000000000e9251206077512fb" 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 --000000000000e9251206077512fb Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable Thank you for reviewing the patches and for your feedback. 1. Regarding the toctree, I've added the new Getting Started Guide so that it's accessible via the links in the left column. I've tested this on my local version, and the warning should disappear once the patch is submitted= . 2. As for the existing per-platform documentation, it has not been removed yet because I'm still in the process of developing the consolidated Getting Started Guide. The existing documentation will remain in place for the time being. 3. About the context not yet moved from the existing per-platform guides, I'm considering how best to integrate this information into the new guide. Bruce, do you have any thoughts on whether these should be kept around for reference or moved to other files? I plan to send updated versions of all patches in this series at the same time, incorporating all the feedback received. Thank you again for your time and input. Thanks! David Young Professional Copywriter/Technical Writer Young Copy +1 (678) 500-9550 https://www.youngcopy.com On Mon, Sep 25, 2023 at 7:54=E2=80=AFAM Ferruh Yigit = wrote: > On 9/20/2023 4:48 PM, David Young wrote: > > The separate Getting Started Guides for Linux, FreeBSD, and Windows hav= e > 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? > > > Thanks, > ferruh > > --000000000000e9251206077512fb Content-Type: text/html; charset="UTF-8" Content-Transfer-Encoding: quoted-printable
Thank you for reviewing the patches and for your feedback.=

1. Regarding the toctree, I've added the new Getting Started Gu= ide so that it's accessible via the links in the left column. I've = tested this on my local version, and the warning should disappear once the = patch is submitted.

2. As for the existing per-platform documentatio= n, it has not been removed yet because I'm still in the process of deve= loping the consolidated Getting Started Guide. The existing documentation w= ill remain in place for the time being.

3. About the context not yet= moved from the existing per-platform guides, I'm considering how best = to integrate this information into the new guide. Bruce, do you have any th= oughts on whether these should be kept around for reference or moved to oth= er files?

I plan to send updated versions of all patches in this ser= ies at the same time, incorporating all the feedback received.

= Thank you again for your time and input.

Thanks!
David Young
Profession= al Copywriter/Technical Writer
Young Copy
+1 (678) 500-955= 0


On Mo= n, Sep 25, 2023 at 7:54=E2=80=AFAM Ferruh Yigit <ferruh.yigit@amd.com> wrote:
On 9/20/2023 4:48 PM, David Young wrot= e:
> The separate Getting Started Guides for Linux, FreeBSD, and Windows ha= ve been
> consolidated into a single, streamlined guide to simplify the user exp= erience
> and facilitate easier maintenance.
>
> David Young (6):
>=C2=A0 =C2=A0Section 1: Introduction
>=C2=A0 =C2=A0Section 2: Install and Build DPDK
>=C2=A0 =C2=A0Section 3: Setting up a System to Run DPDK Applications >=C2=A0 =C2=A0Section 4: Running Applications
>=C2=A0 =C2=A0Section 5: Appendix
>=C2=A0 =C2=A0Section 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?


Thanks,
ferruh

--000000000000e9251206077512fb--