Where can I report issues found in the documentation?

Infrastructure & Networking DOCA Getting Started & Resources
1

Hello,

I am reading DOCA Flow - NVIDIA Docs and seeing some typos and broken links. Is there any prefered way of reporting such things? Thanks in advance.

2

Hello @synalice ,

Could you please point out the typos and broken links you found in this document?

Regards,

Chen

1 Like
3

All of the issues I’ve found on this page so far:

  • In section Flow Life Cycle > Initialization Flow > Pipe Mode there are two pictures (one under the vnf bullet point and one under the switch bullet point) — vnf-mode-diagram and switch-mode-diagram. These pictures are shown as thumbnails and there is no way to view them in full. This is clearly not how it was intended to be.

  • In the same Flow Life Cycle > Initialization Flow > Pipe Mode section under the vnf bullet point there is also some code that is not formatted correctly (mono font, but no outline).

  • API section has a link to DOCA Library APIs page, that points to internal Nvidia’s Confluence instead of DOCA Library APIs - NVIDIA Docs.

  • “can cause the the application to fail”.

  • “Contorl pipe”

  • “forwarding can be s et either at creation time”

4

@synalice - Thank you for pointing this out. I’ve contacted the relevant team to correct the documentation.

Please let me know if you notice any other issues.

Regards,
Chen

1 Like
5

From documentation:

Add field value or from src

(Ctrl+F the page for “Add field value or from” text to find it)

There might be a word missing here. I’m not sure what was meant by this.

6

Also, here is the error log message I’ve found:

[23:16:05:468025][1526377][DOCA][WRN][engine_port.c:1093][engine_port_stop] Port with driver id 0 has child not be stopped

I don’t think “has child not be stopped” is a valid English. Might be a typo.

That’s DOCA 3.0.0, but I doubt the message is different in 3.1.0.