docs: fix broken links

[blkperl]

fixes #3983

Checklist:

• Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this is a chore.
• The title of the PR is (a) conventional with a list of types and scopes found here, (b) states what changed, and (c) suffixes the related issues number. E.g. "fix(controller): Updates such and such. Fixes #1234".
• I've signed my commits with DCO
• I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
• My builds are green. Try syncing with master if they are not.
• My organization is added to USERS.md.

I fixed most of the warnings shown when running

make serve-docs

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[blkperl]

@zachaller do you know where the link is set for these generated docs?

WARNING -  Doc file 'generated/notification-services/teams.md' contains a link '../templates.md', but the target
           'generated/templates.md' is not found among documentation files.

[zachaller]

I think think these links are actually broken on the hosted site: https://argo-rollouts.readthedocs.io/en/latest/FAQ/

I only checked the best practices link

[github-actions]

Published E2E Test Results

  4 files    4 suites   3h 13m 54s ⏱️
113 tests 104 ✅  7 💤 2 ❌
456 runs  424 ✅ 28 💤 4 ❌

For more details on these failures, see this check.

Results for commit f9233a3.

[github-actions]

Published Unit Test Results

2 293 tests   2 293 ✅  2m 59s ⏱️
  128 suites      0 💤
    1 files        0 ❌

Results for commit f9233a3.

[blkperl]

I think think these links are actually broken on the hosted site: https://argo-rollouts.readthedocs.io/en/latest/FAQ/

I only checked the best practices link

What do you mean they are broken on the hosted site?

[zachaller]

You edited the FAQ's best practices link but you will notice it's not broken here https://argo-rollouts.readthedocs.io/en/latest/FAQ/

links are not broken on readthe docs

[blkperl]

You edited the FAQ's best practices link but you will notice it's not broken here https://argo-rollouts.readthedocs.io/en/latest/FAQ/

Oh interesting, I guess make serve-docs throws a warning and Goland shows an error but then when they are served it becomes a 404.

[blkperl]

Well this needs more work, so i will close it for now.