From: Bruce Richardson <bruce.richardson@intel.com>
To: David Young <dave@youngcopy.com>
Cc: <dev@dpdk.org>, Aaron Conole <aconole@redhat.com>
Subject: Re: [PATCH v3 1/7] Section 1: Introduction
Date: Fri, 3 Nov 2023 13:11:22 +0000 [thread overview]
Message-ID: <ZUTxeuUb+Ps5UDWN@bricha3-MOBL.ger.corp.intel.com> (raw)
In-Reply-To: <20231103040202.2849-2-dave@youngcopy.com>
On Fri, Nov 03, 2023 at 12:01:47AM -0400, David Young wrote:
> Edited copy to be simpler based on feedback.
Thanks David,
some small comments inline below.
> ---
> doc/guides/getting_started_guide/intro.rst | 13 +++++++++++++
> 1 file changed, 13 insertions(+)
> create mode 100644 doc/guides/getting_started_guide/intro.rst
>
> diff --git a/doc/guides/getting_started_guide/intro.rst b/doc/guides/getting_started_guide/intro.rst
> new file mode 100644
> index 0000000000..538b3bacec
> --- /dev/null
> +++ b/doc/guides/getting_started_guide/intro.rst
> @@ -0,0 +1,13 @@
> +.. SPDX-License-Identifier: BSD-3-Clause
> + Copyright(c) 2010-2014 Intel Corporation.
> +
> +Introduction
> +============
> +
> +Welcome to the getting started guide for the Data Plane Development Kit (DPDK) covering Linux, FreeBSD, and Windows. DPDK is a set of libraries and
> +drivers that accelerate packet processing and allow the user to create high-performance
> +networking applications.
The line breaks are in odd places here. Since we track the documentation as
text files in our repository, like source-code, we want future changes to
minimise the lines being changed as much as possible.
Checking our contributors doc, I think our guidelines there for
documentation changes are out of date, so here are the "working guidelines"
I use for docs:
* line length can be up to ~100 chars, maybe a bit more if it makes sense
to avoid breaks
* Start each sentence on a new line (unless you have two really short ones
that both fit on one line!)
* When breaking a sentence across two lines, split at a punctuation mark,
like a comma, or before an "and" or "but" etc. Each clause should be on a
single line where possible.
> +
> +The guide is structured to provide basic step-by-step instructions with OS-specific instructions for each operating system where necessary.
should we add "got setting up and using DPDK" after "instructions"?
for the OS-specific instructions, should be say that they are "only" where
necessary, to try and emphasise we have things as common as possible?
> +By the end of this guide, you should have a solid understanding of how to implement and
> +use DPDK in your networking projects, regardless of the operating system you are using.
> \ No newline at end of file
Please fix this little warning. POSIX standard specifies that all text
files should end with a newline character. Rather than having to add it
manually, many editors have a setting to ensure it is there automatically,
so that might be worth investigating.
next prev parent reply other threads:[~2023-11-03 13:11 UTC|newest]
Thread overview: 28+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-03 4:01 [PATCH v3 0/7] docs: getting started guide consolidation David Young
2023-11-03 4:01 ` [PATCH v3 1/7] Section 1: Introduction David Young
2023-11-03 13:11 ` Bruce Richardson [this message]
2023-11-03 4:01 ` [PATCH v3 2/7] Section 2: Install and Build DPDK David Young
2023-11-03 13:55 ` Bruce Richardson
2023-11-03 4:01 ` [PATCH v3 3/7] Section 3: Setting up a System to Run DPDK Applications David Young
2023-11-03 14:17 ` Bruce Richardson
2023-11-03 4:01 ` [PATCH v3 4/7] Section 4: Running Applications David Young
2023-11-03 15:13 ` Bruce Richardson
2023-11-03 4:01 ` [PATCH v3 5/7] Section 5: Appendix David Young
2023-11-03 15:23 ` Bruce Richardson
2023-11-16 1:28 ` Dave Young
2023-11-17 13:04 ` Bruce Richardson
2023-11-03 4:01 ` [PATCH v3 6/7] Added link to Getting Started Guide in index.rst David Young
2023-11-03 13:32 ` Bruce Richardson
2023-11-03 14:22 ` Bruce Richardson
2023-11-08 1:47 ` Dave Young
2023-11-08 2:06 ` Dave Young
2023-11-03 4:01 ` [PATCH v3 7/7] Section 6: Glossary David Young
2023-11-03 15:26 ` Bruce Richardson
2023-11-23 1:26 ` [PATCH v4 0/6] docs: getting started guide consolidation David Young
2023-11-23 1:26 ` [PATCH v4 1/6] Section 1: Introduction David Young
2023-11-23 1:26 ` [PATCH v4 2/6] Section 2: Install and Build DPDK David Young
2023-11-23 1:26 ` [PATCH v4 3/6] Section 3: Setting up a System to Run DPDK Applications David Young
2023-11-23 1:26 ` [PATCH v4 4/6] Section 4: Running Applications David Young
2023-11-23 1:26 ` [PATCH v4 5/6] Section 5: Appendix David Young
2023-11-23 1:26 ` [PATCH v4 6/6] Section 6: Glossary David Young
2023-12-01 15:17 ` [PATCH v4 0/6] docs: getting started guide consolidation Thomas Monjalon
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=ZUTxeuUb+Ps5UDWN@bricha3-MOBL.ger.corp.intel.com \
--to=bruce.richardson@intel.com \
--cc=aconole@redhat.com \
--cc=dave@youngcopy.com \
--cc=dev@dpdk.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).