[1/6] Section 1: Introduction

Message ID 20230920154817.617-2-dave@youngcopy.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series docs: Unify Getting Started Guides |

Checks

Context Check Description
ci/checkpatch warning coding style issues

Commit Message

Dave Young Sept. 20, 2023, 3:48 p.m. UTC
  ---
 doc/guides/getting_started_guide/intro.rst | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)
 create mode 100644 doc/guides/getting_started_guide/intro.rst
  

Comments

Ferruh Yigit Sept. 25, 2023, 11:30 a.m. UTC | #1
On 9/20/2023 4:48 PM, David Young wrote:
> ---
>  doc/guides/getting_started_guide/intro.rst | 16 ++++++++++++++++
>  1 file changed, 16 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..88bdd48849
> --- /dev/null
> +++ b/doc/guides/getting_started_guide/intro.rst
> @@ -0,0 +1,16 @@
> +..  SPDX-License-Identifier: BSD-3-Clause
> +    Copyright(c) 2010-2014 Intel Corporation.
> +
> +Introduction
> +============
> +
> +Welcome to the unified getting started guide for the Data Plane Development Kit (DPDK) covering Linux, FreeBSD, and Windows. DPDK is a set of libraries and
>

'unified' makes sense only with the context of this effort, for anyone
who is reading this for the first time it may not mean much, I suggest
just drop it: "Welcome to the getting started guide for ..."


> +drivers that accelerate packet processing and allow the user to create high-performance
> +networking applications.
> +
> +The guide is structured to provide basic step-by-step instructions with OS-specific instructions for each operating system where necessary. 
> +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.
> +
> +We hope this guide serves as a valuable resource as you explore the powerful
> +capabilities of DPDK.
> \ No newline at end of file

Last paragraph feels like marketing text :), I would be OK without it,
but this is personal preference.
  
Dave Young Oct. 11, 2023, 6:26 p.m. UTC | #2
Thank you for the feedback. I agree with the suggested changes to remove
"unified" and the last paragraph. These changes have been made locally. I
plan to send updated versions of all patches in this series at the same
time, so you can expect to see these adjustments in the next version.

Thanks!
David Young
Professional Copywriter/Technical Writer
Young Copy
+1 (678) 500-9550
https://www.youngcopy.com


On Mon, Sep 25, 2023 at 7:30 AM Ferruh Yigit <ferruh.yigit@amd.com> wrote:

> On 9/20/2023 4:48 PM, David Young wrote:
> > ---
> >  doc/guides/getting_started_guide/intro.rst | 16 ++++++++++++++++
> >  1 file changed, 16 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..88bdd48849
> > --- /dev/null
> > +++ b/doc/guides/getting_started_guide/intro.rst
> > @@ -0,0 +1,16 @@
> > +..  SPDX-License-Identifier: BSD-3-Clause
> > +    Copyright(c) 2010-2014 Intel Corporation.
> > +
> > +Introduction
> > +============
> > +
> > +Welcome to the unified getting started guide for the Data Plane
> Development Kit (DPDK) covering Linux, FreeBSD, and Windows. DPDK is a set
> of libraries and
> >
>
> 'unified' makes sense only with the context of this effort, for anyone
> who is reading this for the first time it may not mean much, I suggest
> just drop it: "Welcome to the getting started guide for ..."
>
>
> > +drivers that accelerate packet processing and allow the user to create
> high-performance
> > +networking applications.
> > +
> > +The guide is structured to provide basic step-by-step instructions with
> OS-specific instructions for each operating system where necessary.
> > +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.
> > +
> > +We hope this guide serves as a valuable resource as you explore the
> powerful
> > +capabilities of DPDK.
> > \ No newline at end of file
>
> Last paragraph feels like marketing text :), I would be OK without it,
> but this is personal preference.
>
>
  

Patch

diff --git a/doc/guides/getting_started_guide/intro.rst b/doc/guides/getting_started_guide/intro.rst
new file mode 100644
index 0000000000..88bdd48849
--- /dev/null
+++ b/doc/guides/getting_started_guide/intro.rst
@@ -0,0 +1,16 @@ 
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright(c) 2010-2014 Intel Corporation.
+
+Introduction
+============
+
+Welcome to the unified 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 guide is structured to provide basic step-by-step instructions with OS-specific instructions for each operating system where necessary. 
+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.
+
+We hope this guide serves as a valuable resource as you explore the powerful
+capabilities of DPDK.
\ No newline at end of file