Re: [ovs-dev] [PATCH v2 0/2] Documentation: Update broken links
On Tue, Apr 22, 2025 at 10:55:14PM +0200, Ilya Maximets wrote: > On 4/17/25 2:50 PM, Eelco Chaudron wrote: > > > > > > On 17 Apr 2025, at 14:09, David Marchand wrote: > > > >> On Thu, Apr 17, 2025 at 10:07 AM Simon Horman wrote: > >>> > >>> On Wed, Apr 16, 2025 at 11:46:48AM +0100, Simon Horman wrote: > Update some URLs in documentation that are broken to working URLs > to the same information. > > --- > Changes in v2: > - Removed duplicate word "commit" from patch description (David Marchand) > - The make target is "check-docs" (David Marchand) > - Don't break formatting (David Marchand) > - Use mail-archive.com instead of archive.org (Ilya Maximents) > - Collected reviewed-by tag from David Marchand > > --- > Simon Horman (2): > Documentation: Update links to DPDK documentation. > Documentation: Use mail-archive.com URLs for openflow-discuss ML > links. > > Documentation/topics/design.rst | 2 +- > Documentation/topics/dpdk/phy.rst | 4 ++-- > Documentation/topics/porting.rst | 2 +- > 3 files changed, 4 insertions(+), 4 deletions(-) > > base-commit: 50dfd1ce32dff9e400ab1fdc0ef26f83f5299429 > >>> > >>> Thanks David and Eelco for your review. > >>> > >>> I have applied this series to main. > >>> > >>> - Documentation: Use mail-archive.com URLs for openflow-discuss ML links. > >>> https://github.com/openvswitch/ovs/commit/effb2bb286cf > >>> - Documentation: Update links to DPDK documentation. > >>> https://github.com/openvswitch/ovs/commit/88ee8ae0542f > >>> > >>> I was also able to trivially backport the DPDK documentation update to > >>> branch-3.5, and the openflow-discuss documentation update all the way back > >>> to branch-3.0. However, I am not sure if applying documentation updates of > >>> this nature to branch-* is appropriate. I'd appreciate some feedback on > >>> that. > >> > >> It won't hurt to backport those. > >> On the other hand, we don't generate documentation for older branches, do > >> we? > > > > We do not generate docs for older branches, only for the latest. So I guess > > only > > people looking at older branches (on GitHub) might notice. I’d say the > > backports > > are not mandatory. > > > > We're generating docs for the latest git tag. These docs can be found by > switching > to the 'stable' version in the readthedocs panel at the bottom of the page or > by > navigating to /stable instead of /latest. Right now it's showing > documentation for > the v3.5.0. It might make sense to backport the documentation fixes to > branch-3.5, > so they will be picked up and displayed on the website once we have OVS > v3.5.1 out. Thanks David and Ilya, I've pushed the following backports to branch-3.5. We can revisit the topic of backports to other branches as needed. - Documentation: Update links to DPDK documentation. https://github.com/openvswitch/ovs/commit/6ba5f453be55 - Documentation: Use mail-archive.com URLs for openflow-discuss ML links. https://github.com/openvswitch/ovs/commit/7eeb92a344a5 ___ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev
Re: [ovs-dev] [PATCH v2 0/2] Documentation: Update broken links
On 4/17/25 2:50 PM, Eelco Chaudron wrote: > > > On 17 Apr 2025, at 14:09, David Marchand wrote: > >> On Thu, Apr 17, 2025 at 10:07 AM Simon Horman wrote: >>> >>> On Wed, Apr 16, 2025 at 11:46:48AM +0100, Simon Horman wrote: Update some URLs in documentation that are broken to working URLs to the same information. --- Changes in v2: - Removed duplicate word "commit" from patch description (David Marchand) - The make target is "check-docs" (David Marchand) - Don't break formatting (David Marchand) - Use mail-archive.com instead of archive.org (Ilya Maximents) - Collected reviewed-by tag from David Marchand --- Simon Horman (2): Documentation: Update links to DPDK documentation. Documentation: Use mail-archive.com URLs for openflow-discuss ML links. Documentation/topics/design.rst | 2 +- Documentation/topics/dpdk/phy.rst | 4 ++-- Documentation/topics/porting.rst | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) base-commit: 50dfd1ce32dff9e400ab1fdc0ef26f83f5299429 >>> >>> Thanks David and Eelco for your review. >>> >>> I have applied this series to main. >>> >>> - Documentation: Use mail-archive.com URLs for openflow-discuss ML links. >>> https://github.com/openvswitch/ovs/commit/effb2bb286cf >>> - Documentation: Update links to DPDK documentation. >>> https://github.com/openvswitch/ovs/commit/88ee8ae0542f >>> >>> I was also able to trivially backport the DPDK documentation update to >>> branch-3.5, and the openflow-discuss documentation update all the way back >>> to branch-3.0. However, I am not sure if applying documentation updates of >>> this nature to branch-* is appropriate. I'd appreciate some feedback on >>> that. >> >> It won't hurt to backport those. >> On the other hand, we don't generate documentation for older branches, do we? > > We do not generate docs for older branches, only for the latest. So I guess > only > people looking at older branches (on GitHub) might notice. I’d say the > backports > are not mandatory. > We're generating docs for the latest git tag. These docs can be found by switching to the 'stable' version in the readthedocs panel at the bottom of the page or by navigating to /stable instead of /latest. Right now it's showing documentation for the v3.5.0. It might make sense to backport the documentation fixes to branch-3.5, so they will be picked up and displayed on the website once we have OVS v3.5.1 out. Best regards, Ilya Maximets. ___ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev
Re: [ovs-dev] [PATCH v2 0/2] Documentation: Update broken links
On 17 Apr 2025, at 14:09, David Marchand wrote: > On Thu, Apr 17, 2025 at 10:07 AM Simon Horman wrote: >> >> On Wed, Apr 16, 2025 at 11:46:48AM +0100, Simon Horman wrote: >>> Update some URLs in documentation that are broken to working URLs >>> to the same information. >>> >>> --- >>> Changes in v2: >>> - Removed duplicate word "commit" from patch description (David Marchand) >>> - The make target is "check-docs" (David Marchand) >>> - Don't break formatting (David Marchand) >>> - Use mail-archive.com instead of archive.org (Ilya Maximents) >>> - Collected reviewed-by tag from David Marchand >>> >>> --- >>> Simon Horman (2): >>> Documentation: Update links to DPDK documentation. >>> Documentation: Use mail-archive.com URLs for openflow-discuss ML >>> links. >>> >>> Documentation/topics/design.rst | 2 +- >>> Documentation/topics/dpdk/phy.rst | 4 ++-- >>> Documentation/topics/porting.rst | 2 +- >>> 3 files changed, 4 insertions(+), 4 deletions(-) >>> >>> base-commit: 50dfd1ce32dff9e400ab1fdc0ef26f83f5299429 >> >> Thanks David and Eelco for your review. >> >> I have applied this series to main. >> >> - Documentation: Use mail-archive.com URLs for openflow-discuss ML links. >> https://github.com/openvswitch/ovs/commit/effb2bb286cf >> - Documentation: Update links to DPDK documentation. >> https://github.com/openvswitch/ovs/commit/88ee8ae0542f >> >> I was also able to trivially backport the DPDK documentation update to >> branch-3.5, and the openflow-discuss documentation update all the way back >> to branch-3.0. However, I am not sure if applying documentation updates of >> this nature to branch-* is appropriate. I'd appreciate some feedback on >> that. > > It won't hurt to backport those. > On the other hand, we don't generate documentation for older branches, do we? We do not generate docs for older branches, only for the latest. So I guess only people looking at older branches (on GitHub) might notice. I’d say the backports are not mandatory. ___ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev
Re: [ovs-dev] [PATCH v2 0/2] Documentation: Update broken links
On Thu, Apr 17, 2025 at 10:07 AM Simon Horman wrote: > > On Wed, Apr 16, 2025 at 11:46:48AM +0100, Simon Horman wrote: > > Update some URLs in documentation that are broken to working URLs > > to the same information. > > > > --- > > Changes in v2: > > - Removed duplicate word "commit" from patch description (David Marchand) > > - The make target is "check-docs" (David Marchand) > > - Don't break formatting (David Marchand) > > - Use mail-archive.com instead of archive.org (Ilya Maximents) > > - Collected reviewed-by tag from David Marchand > > > > --- > > Simon Horman (2): > > Documentation: Update links to DPDK documentation. > > Documentation: Use mail-archive.com URLs for openflow-discuss ML > > links. > > > > Documentation/topics/design.rst | 2 +- > > Documentation/topics/dpdk/phy.rst | 4 ++-- > > Documentation/topics/porting.rst | 2 +- > > 3 files changed, 4 insertions(+), 4 deletions(-) > > > > base-commit: 50dfd1ce32dff9e400ab1fdc0ef26f83f5299429 > > Thanks David and Eelco for your review. > > I have applied this series to main. > > - Documentation: Use mail-archive.com URLs for openflow-discuss ML links. > https://github.com/openvswitch/ovs/commit/effb2bb286cf > - Documentation: Update links to DPDK documentation. > https://github.com/openvswitch/ovs/commit/88ee8ae0542f > > I was also able to trivially backport the DPDK documentation update to > branch-3.5, and the openflow-discuss documentation update all the way back > to branch-3.0. However, I am not sure if applying documentation updates of > this nature to branch-* is appropriate. I'd appreciate some feedback on > that. It won't hurt to backport those. On the other hand, we don't generate documentation for older branches, do we? -- David Marchand ___ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev
Re: [ovs-dev] [PATCH v2 0/2] Documentation: Update broken links
On Wed, Apr 16, 2025 at 11:46:48AM +0100, Simon Horman wrote: > Update some URLs in documentation that are broken to working URLs > to the same information. > > --- > Changes in v2: > - Removed duplicate word "commit" from patch description (David Marchand) > - The make target is "check-docs" (David Marchand) > - Don't break formatting (David Marchand) > - Use mail-archive.com instead of archive.org (Ilya Maximents) > - Collected reviewed-by tag from David Marchand > > --- > Simon Horman (2): > Documentation: Update links to DPDK documentation. > Documentation: Use mail-archive.com URLs for openflow-discuss ML links. > > Documentation/topics/design.rst | 2 +- > Documentation/topics/dpdk/phy.rst | 4 ++-- > Documentation/topics/porting.rst | 2 +- > 3 files changed, 4 insertions(+), 4 deletions(-) > > base-commit: 50dfd1ce32dff9e400ab1fdc0ef26f83f5299429 Thanks David and Eelco for your review. I have applied this series to main. - Documentation: Use mail-archive.com URLs for openflow-discuss ML links. https://github.com/openvswitch/ovs/commit/effb2bb286cf - Documentation: Update links to DPDK documentation. https://github.com/openvswitch/ovs/commit/88ee8ae0542f I was also able to trivially backport the DPDK documentation update to branch-3.5, and the openflow-discuss documentation update all the way back to branch-3.0. However, I am not sure if applying documentation updates of this nature to branch-* is appropriate. I'd appreciate some feedback on that. ___ dev mailing list d...@openvswitch.org https://mail.openvswitch.org/mailman/listinfo/ovs-dev
