[PATCH 0/6] docs: Unify Getting Started Guides

[Dave Young]

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 AM Ferruh Yigit <ferruh.yigit at amd.com> 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?
>
>
> Thanks,
> ferruh
>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://mails.dpdk.org/archives/dev/attachments/20231011/1d4ca216/attachment.htm>