Fixes broken links in Documentation #40

jeevantelukula · 2024-11-14T08:35:48Z

Fix broken links in the documentation for Migration Guides, How to Guides, Examples and Demos, Foundational Components Sections.

github-actions · 2024-11-14T08:36:42Z

New warnings found with rstcheck:

source/linux/Examples_and_Demos/_Hands_on_with_QT.rst:2: (INFO/1) Hyperlink target "hands-on-with-qt" is not referenced.
source/linux/Overview/Program_EVM.rst:6: (INFO/1) Enumerated list start value not ordinal-1: "2" (ordinal 2)
source/linux/Foundational_Components/Kernel/Kernel_Drivers/UFS.rst:4: (INFO/1) Duplicate implicit target name: "ufs".
source/linux/Foundational_Components/U-Boot/UG-SATA.rst:1: (INFO/1) Hyperlink target "ug-sata" is not referenced.

StaticRocket

A lot of these changes are useful. Thanks for taking the time to hilight these issues. Would you mind changing some of the inter-document links you added to use rst built in linking?

source/common/PRU-ICSS/PRU-Hands-on-Labs.rst

source/devices/AM335X/linux/Release_Specific_Migration_Guide.rst

source/linux/Foundational_Components/U-Boot/UG-SATA.rst

github-actions · 2024-11-20T10:37:29Z

New warnings found with rstcheck:

source/linux/Examples_and_Demos/_Hands_on_with_QT.rst:2: (INFO/1) Hyperlink target "hands-on-with-qt" is not referenced.

github-actions · 2024-11-20T11:15:44Z

New warnings found with rstcheck:

source/linux/Examples_and_Demos/_Hands_on_with_QT.rst:2: (INFO/1) Hyperlink target "hands-on-with-qt" is not referenced.

github-actions · 2024-11-20T11:22:31Z

New warnings found with rstcheck:

source/linux/Examples_and_Demos/_Hands_on_with_QT.rst:2: (INFO/1) Hyperlink target "hands-on-with-qt" is not referenced.

source/common/EVM_Hardware_Setup/_EVMK2H_Hardware_Setup.rst

source/devices/AM335X/linux/Release_Specific_Migration_Guide.rst

source/linux/Examples_and_Demos/_Hands_on_with_QT.rst

source/linux/Foundational_Components/_OpenCV.rst

cshilwant

Needs work!

github-actions · 2024-11-21T06:13:55Z

New warnings found with rstcheck:

source/linux/Examples_and_Demos/_Hands_on_with_QT.rst:2: (INFO/1) Hyperlink target "hands-on-with-qt" is not referenced.
source/linux/Foundational_Components/Kernel/_Users_Guide.rst:37: (INFO/1) Hyperlink target "preparing-to-build" is not referenced.
source/linux/Foundational_Components/Graphics/SGX/Migration_From_Prior_Releases.rst:78: (INFO/1) Duplicate implicit target name: "window system libraries".

github-actions · 2024-11-21T06:24:07Z

New warnings found with rstcheck:

source/linux/Examples_and_Demos/_Hands_on_with_QT.rst:2: (INFO/1) Hyperlink target "hands-on-with-qt" is not referenced.
source/linux/Foundational_Components/Kernel/_Users_Guide.rst:37: (INFO/1) Hyperlink target "preparing-to-build" is not referenced.
source/linux/Foundational_Components/Graphics/SGX/Migration_From_Prior_Releases.rst:78: (INFO/1) Duplicate implicit target name: "window system libraries".

…migration Update links for creating the SD card to point to the new documentation file. Update the Migration Guide to ensure it includes the correct reference for Graphics Migration. Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>

Update the correct ti.com URL's for AM335x and AM437x Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>

… reference links Add Program EVM User Guide in the Overview/Getting Started Here section Update the correct references of u-boot building methods Include the reference for UG-SATA in Foundational Components/U-Boot section Add the UFS reference in Kernel/Kernel Drivers section Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>

Fixed the processors.wiki links and some broken links in Foundational components section Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>

…ol and Examples and Demos docs Add HSR_PRP in toc tree for AM335x and AM437x Fix broken links in How to Guides and Examples and Demos Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>

…un Setup Scripts sections and update toc tree Update the toc to AM335x and AM437x adding EVMK2H Hardware Setup Remove the expired links in Migration Guides Update the eMMC references in Run Setup Scripts Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>

github-actions · 2024-11-21T06:33:58Z

New warnings found with rstcheck:

source/linux/Examples_and_Demos/_Hands_on_with_QT.rst:2: (INFO/1) Hyperlink target "hands-on-with-qt" is not referenced.
source/linux/Foundational_Components/Kernel/_Users_Guide.rst:37: (INFO/1) Hyperlink target "preparing-to-build" is not referenced.
source/linux/Foundational_Components/Graphics/SGX/Migration_From_Prior_Releases.rst:78: (INFO/1) Duplicate implicit target name: "window system libraries".

…r Guide, UG-SATA and UFS and Release Specific Migration Guide Update the cross referencing to other docs(UG-SATA, UFS) replacing ref tag with doc tag which directly point to the document Update the Release Specific Migration Guide references Update referencing the links through html to using ref tags and change http protocol to https Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>

github-actions · 2024-11-21T09:02:26Z

New warnings found with rstcheck:

source/linux/Examples_and_Demos/_Hands_on_with_QT.rst:2: (INFO/1) Hyperlink target "hands-on-with-qt" is not referenced.
source/linux/Foundational_Components/Kernel/_Users_Guide.rst:37: (INFO/1) Hyperlink target "preparing-to-build" is not referenced.
source/linux/Foundational_Components/Graphics/SGX/Migration_From_Prior_Releases.rst:78: (INFO/1) Duplicate implicit target name: "window system libraries".

Outdated, need a re-review

jeevantelukula requested review from StaticRocket, cshilwant, praneethbajjuri and uditkumarti as code owners November 14, 2024 08:35

StaticRocket previously requested changes Nov 16, 2024

View reviewed changes

cshilwant reviewed Nov 20, 2024

View reviewed changes

source/common/EVM_Hardware_Setup/_EVMK2H_Hardware_Setup.rst Outdated Show resolved Hide resolved

cshilwant reviewed Nov 20, 2024

View reviewed changes

source/devices/AM335X/linux/Release_Specific_Migration_Guide.rst Outdated Show resolved Hide resolved

cshilwant reviewed Nov 20, 2024

View reviewed changes

source/linux/Examples_and_Demos/_Hands_on_with_QT.rst Outdated Show resolved Hide resolved

cshilwant reviewed Nov 20, 2024

View reviewed changes

source/linux/Examples_and_Demos/_Hands_on_with_QT.rst Outdated Show resolved Hide resolved

cshilwant reviewed Nov 20, 2024

View reviewed changes

source/linux/Foundational_Components/_OpenCV.rst Outdated Show resolved Hide resolved

cshilwant requested changes Nov 20, 2024

View reviewed changes

jeevantelukula added 6 commits November 21, 2024 12:01

fix(url): Update the SDK download URL with the correct links

b02c39f

Update the correct ti.com URL's for AM335x and AM437x Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>

fix(references): fix broken links in Foundational Componenets section

62d4844

Fixed the processors.wiki links and some broken links in Foundational components section Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>

fix(references): Fix broken links in How to Guides, Industrial Protoc…

cf9d0a3

…ol and Examples and Demos docs Add HSR_PRP in toc tree for AM335x and AM437x Fix broken links in How to Guides and Examples and Demos Signed-off-by: Telukula Jeevan Kumar Sahu <[email protected]>

jeevantelukula requested review from StaticRocket and cshilwant November 21, 2024 06:37

cshilwant approved these changes Nov 21, 2024

View reviewed changes

StaticRocket approved these changes Nov 21, 2024

View reviewed changes

StaticRocket merged commit 3fd6c25 into TexasInstruments:master Nov 21, 2024
1 of 2 checks passed

Fixes broken links in Documentation #40

Fixes broken links in Documentation #40

Uh oh!

Conversation

jeevantelukula commented Nov 14, 2024

Uh oh!

github-actions bot commented Nov 14, 2024

Uh oh!

StaticRocket left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

github-actions bot commented Nov 20, 2024

Uh oh!

github-actions bot commented Nov 20, 2024

Uh oh!

github-actions bot commented Nov 20, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cshilwant left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 21, 2024

Uh oh!

github-actions bot commented Nov 21, 2024

Uh oh!

github-actions bot commented Nov 21, 2024

Uh oh!

github-actions bot commented Nov 21, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants