From: Bruce Richardson <bruce.richardson@intel.com>
To: Ferruh Yigit <ferruh.yigit@amd.com>
Cc: David Young <dave@youngcopy.com>, <dev@dpdk.org>
Subject: Re: [PATCH 0/6] docs: Unify Getting Started Guides
Date: Fri, 13 Oct 2023 17:28:38 +0100 [thread overview]
Message-ID: <ZSlwNk4SarCgYDF7@bricha3-MOBL.ger.corp.intel.com> (raw)
In-Reply-To: <c7460baa-9eb5-4891-bc24-45ab94a4aef9@amd.com>
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
prev parent reply other threads:[~2023-10-13 16:28 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-09-20 15:48 David Young
2023-09-20 15:48 ` [PATCH 1/6] Section 1: Introduction David Young
2023-09-25 11:30 ` Ferruh Yigit
2023-10-11 18:26 ` Dave Young
2023-09-20 15:48 ` [PATCH 2/6] Section 2: Install and Build DPDK David Young
2023-09-25 11:30 ` Ferruh Yigit
2023-09-25 12:20 ` Bruce Richardson
2023-09-25 16:05 ` Tyler Retzlaff
2023-10-12 18:08 ` Dave Young
2023-10-17 13:37 ` Tyler Retzlaff
2023-09-20 15:48 ` [PATCH 3/6] Section 3: Setting up a System to Run DPDK Applications David Young
2023-09-25 11:31 ` Ferruh Yigit
2023-09-25 12:22 ` Bruce Richardson
2023-10-12 17:32 ` Dave Young
2023-09-20 15:48 ` [PATCH 4/6] Section 4: Running Applications David Young
2023-09-25 11:32 ` Ferruh Yigit
2023-09-20 15:48 ` [PATCH 5/6] Section 5: Appendix David Young
2023-09-25 11:33 ` Ferruh Yigit
2023-09-25 11:52 ` Ferruh Yigit
2023-09-25 12:24 ` Bruce Richardson
2023-09-20 15:48 ` [PATCH 6/6] Section 6: Glossary David Young
2023-09-25 11:43 ` Ferruh Yigit
2023-09-22 4:15 ` [PATCH 0/6] docs: Unify Getting Started Guides Tyler Retzlaff
2023-09-22 14:47 ` David Marchand
2023-09-22 15:54 ` Bruce Richardson
2023-09-25 11:54 ` Ferruh Yigit
2023-10-11 18:34 ` Dave Young
2023-10-13 16:28 ` Bruce Richardson [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=ZSlwNk4SarCgYDF7@bricha3-MOBL.ger.corp.intel.com \
--to=bruce.richardson@intel.com \
--cc=dave@youngcopy.com \
--cc=dev@dpdk.org \
--cc=ferruh.yigit@amd.com \
/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).