diff mbox series

[v3,6/7] Added link to Getting Started Guide in index.rst

Message ID 20231103040202.2849-7-dave@youngcopy.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series docs: getting started guide consolidation |

Checks

Context Check Description
ci/checkpatch warning coding style issues

Commit Message

Dave Young Nov. 3, 2023, 4:01 a.m. UTC 
  ---
 doc/guides/index.rst | 1 +
 1 file changed, 1 insertion(+)

Comments

Bruce Richardson Nov. 3, 2023, 1:32 p.m. UTC | #1 
On Fri, Nov 03, 2023 at 12:01:52AM -0400, David Young wrote:
> ---
>  doc/guides/index.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/doc/guides/index.rst b/doc/guides/index.rst
> index 244b99624c..51a47d3a51 100644
> --- a/doc/guides/index.rst
> +++ b/doc/guides/index.rst
> @@ -7,6 +7,7 @@ DPDK documentation
>  .. toctree::
>     :maxdepth: 1
>  
> +   getting_started_guide/index
>     linux_gsg/index
>     freebsd_gsg/index
>     windows_gsg/index

Rather than having this as a separte patch, just include this change in
patch 1 of the set, so the GSG doc is getting built from the start. It
allows us to build-check each patch for issues as we apply it.
Bruce Richardson Nov. 3, 2023, 2:22 p.m. UTC | #2 
On Fri, Nov 03, 2023 at 12:01:52AM -0400, David Young wrote:
> ---
>  doc/guides/index.rst | 1 +
>  1 file changed, 1 insertion(+)
> 
> diff --git a/doc/guides/index.rst b/doc/guides/index.rst
> index 244b99624c..51a47d3a51 100644
> --- a/doc/guides/index.rst
> +++ b/doc/guides/index.rst
> @@ -7,6 +7,7 @@ DPDK documentation
>  .. toctree::
>     :maxdepth: 1
>  
> +   getting_started_guide/index

Maybe I am missing something, but what patch is getting_started_guide/index
added in? Ideally it should be added with just the intro entry in patch 1,
and then each subsequent patch adds lines to the file as we add sections.

/Bruce
Dave Young Nov. 8, 2023, 1:47 a.m. UTC | #3 
I can have it added in patch 1. In the v3 patchset it's added in
0006-Added-link-to-Getting-Started-Guide-in-index.rst.patch

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


On Fri, Nov 3, 2023 at 10:22 AM Bruce Richardson <bruce.richardson@intel.com>
wrote:

> On Fri, Nov 03, 2023 at 12:01:52AM -0400, David Young wrote:
> > ---
> >  doc/guides/index.rst | 1 +
> >  1 file changed, 1 insertion(+)
> >
> > diff --git a/doc/guides/index.rst b/doc/guides/index.rst
> > index 244b99624c..51a47d3a51 100644
> > --- a/doc/guides/index.rst
> > +++ b/doc/guides/index.rst
> > @@ -7,6 +7,7 @@ DPDK documentation
> >  .. toctree::
> >     :maxdepth: 1
> >
> > +   getting_started_guide/index
>
> Maybe I am missing something, but what patch is getting_started_guide/index
> added in? Ideally it should be added with just the intro entry in patch 1,
> and then each subsequent patch adds lines to the file as we add sections.
>
> /Bruce
>
Dave Young Nov. 8, 2023, 2:06 a.m. UTC | #4 
Hi Bruce,

Disregard my previous email. It looks like getting_started_guide/index was
somehow deleted but I've added it back.

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


On Tue, Nov 7, 2023 at 8:47 PM Dave Young <dave@youngcopy.com> wrote:

> I can have it added in patch 1. In the v3 patchset it's added in
> 0006-Added-link-to-Getting-Started-Guide-in-index.rst.patch
>
> Thanks!
> David Young
> Professional Copywriter/Technical Writer
> Young Copy
> +1 (678) 500-9550
> https://www.youngcopy.com
>
>
> On Fri, Nov 3, 2023 at 10:22 AM Bruce Richardson <
> bruce.richardson@intel.com> wrote:
>
>> On Fri, Nov 03, 2023 at 12:01:52AM -0400, David Young wrote:
>> > ---
>> >  doc/guides/index.rst | 1 +
>> >  1 file changed, 1 insertion(+)
>> >
>> > diff --git a/doc/guides/index.rst b/doc/guides/index.rst
>> > index 244b99624c..51a47d3a51 100644
>> > --- a/doc/guides/index.rst
>> > +++ b/doc/guides/index.rst
>> > @@ -7,6 +7,7 @@ DPDK documentation
>> >  .. toctree::
>> >     :maxdepth: 1
>> >
>> > +   getting_started_guide/index
>>
>> Maybe I am missing something, but what patch is
>> getting_started_guide/index
>> added in? Ideally it should be added with just the intro entry in patch 1,
>> and then each subsequent patch adds lines to the file as we add sections.
>>
>> /Bruce
>>
>
diff mbox series

Patch

diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index 244b99624c..51a47d3a51 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -7,6 +7,7 @@  DPDK documentation
 .. toctree::
    :maxdepth: 1
 
+   getting_started_guide/index
    linux_gsg/index
    freebsd_gsg/index
    windows_gsg/index