Update UI documentation references links

[sgratch]

Reference: #781

Update all UI documentation fields help text references links by pointing to HELP_LINK_HREF and by adding DOCUMENTATION_VERSION as an internal parameter. So that it will be configurable for next version bumps. The doc link is pointed to either u/s or d/s doc, based on the BRAND_TYPE env. variable.

This is currently relevant for both providers details tab and overview settings card.

[yaacov]

As disccused offline, the links will be changed, once we agree on the best way to do it, and after doc team will have docs for 2.6, until then we will use the downstream docs

[sonarqubecloud]

Kudos, SonarCloud Quality Gate passed!   

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
6.0% Duplication

[sgratch]

As disccused offline, the links will be changed, once we agree on the best way to do it, and after doc team will have docs for 2.6, until then we will use the downstream docs

The current status, before this fix, is that we use u/s docs on few places that points to a broken link (e.g., empty state msgs) and u/s docs on other places which points to 2.4 instead of 2.5.
If not important to fix to 2.5.x, it can wait to the new 2.6 docs of course

[yaacov]

is that we use u/s docs on few places that points to a broken link

we will fix the upstream docs once the doc team will create some, AFAIK forklift project does not have upstream docs yet.

on other places which points to 2.4 instead of 2.5.

we are currently working on 2.6, once the 2.6 docs will be ready, we will need to collaborate with release and docs teams to come up with a release mechanism / automation to manage the links in collaboration with all stake holders, e.g. dev that set up the links, docs that publish the docs and release that set up the downstream package so when we release 2.6 the docs will be as up to date as possible

cc:// @ahadas @RichardHoch - cc because we currently don't have any automation/manual-flow to update the docs links once they are published by the docs team for specific downstream version, we will need to agree on some flow and then try to automate it, see: #781 .

[github-actions]

This PR is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 15 days.

[RichardHoch]

@anarnold97 Would appreciate your insights.

[RichardHoch]

remove label/ stale

[yaacov]

closing in favor of:
#817