Change markdown links to be relative

alisondy commented 3 years ago

For each of these files, go through and update these links to relative file links

Why

Makes it easier to check locally if links work Can quickly check markdown links locally and then check http links on CI

Steps

clone the website repo
make a new branch
run make gen-content
go to each file below and fix the links by
- checking the file links directly
- linking relatively to the file
- replacing hardlinks, for example links that begin with /docs/ to relative paths
- for example in content/en/docs/faq.md on line 325
  - /docs/migration/flux-v1-migration/ would be migration/flux-v1-migration.md
make a commit for each file you fix

Example of a file's links being fixed

https://github.com/fluxcd/website/pull/531/files

How to check your work

This gist - you will need to install jq

https://gist.github.com/alisondy/4016a3697ca27b4ded1be3da45ead98c

List of files and links

FILE: content/en/docs/_index.md
[✖]  get-started/
[✖]  /support/
[✖]  /contributing

FILE: content/en/docs/components/_index.md
[✖] ../gitops-toolkit/source-watcher/

FILE: content/en/docs/concepts.md
[✖] faq/_index.md#kustomize-questions
[✖] installation/_index.md#bootstrap

FILE: content/en/docs/contributing/docs/style-guide.md
[✖] /docs/contributing/docs/writing-docs
[✖] /docs/contribute/style/hugo-shortcodes/#table-captions

FILE: content/en/docs/faq.md
[✖] /docs/components/source/api/#source.toolkit.fluxcd.io/v1beta1.GitRepository
[✖] ../migration/faq-migration/
[✖] /docs/migration/flux-v1-migration/
[✖] /docs/migration/flux-v1-migration/#flux-with-kustomize
[✖] /docs/migration/flux-v1-automation-migration/
[✖] /docs/migration/helm-operator-migration/

FILE: content/en/docs/get-started.md
[✖] ../components/source/gitrepositories/
[✖] ../components/kustomize/kustomization/
[✖] ../components/kustomize/kustomization/#override-kustomize-config

FILE: content/en/docs/guides/helmreleases.md
[✖] ../get-started/index.md
[✖] ../installation/
[✖] ../components/kustomize/kustomization/#garbage-collection

FILE: content/en/docs/guides/image-update.md
[✖] ../installation/
[✖] /docs/use-cases/gh-actions-auto-pr

FILE: content/en/docs/guides/mozilla-sops.md
[✖] ../get-started/index.md
[✖] ../installation/
[✖] ../installation/_index.md#customize-flux-manifests

FILE: content/en/docs/guides/notifications.md
[✖] ../get-started/index.md
[✖] ../installation/
[✖] ../../get-started
[✖] ../../components/notification/provider/#git-commit-status

FILE: content/en/docs/guides/sealed-secrets.md
[✖] ../get-started/index.md
[✖] ../installation/

FILE: content/en/docs/guides/webhook-receivers.md
[✖] ../get-started/index.md
[✖] ../installation/

FILE: content/en/docs/installation.md
[✖] ../use-cases/azure#flux-installation-for-azure-devops

FILE: content/en/docs/migration/faq-migration.md
[✖] /roadmap/
[✖] /contributing/

FILE: content/en/docs/migration/flux-v1-automation-migration.md
[✖] /docs/guides/image-update/
[✖] /docs/migration/flux-v1-migration/
[✖] /docs/get-started/#install-the-flux-cli
[✖] /docs/installation/_index.md#bootstrap
[✖] /docs/components/image/imageupdateautomations/
[✖] /docs/guides/image-update/#configure-image-scanning
[✖] /docs/guides/image-update/#imagerepository-cloud-providers-authentication
[✖] /docs/guides/sortable-image-tags/
[✖] /docs/components/image/imagepolicies/
[✖] /legacy/flux/references/helm-operator-integration/#automated-image-detection
[✖] /docs/guides/image-update/#configure-image-update-for-custom-resources

FILE: content/en/docs/migration/flux-v1-migration.md
[✖] ../installation/_index.md

FILE: content/en/docs/migration/helm-operator-migration.md
[✖] /docs/components/kustomize/controller/
[✖] ../get-started/index.md
[✖] /docs/guides/image-update/#configure-image-update-for-custom-resources
[✖] /legacy/helm-operator/helmrelease-guide/release-configuration/#migrating-from-helm-v2-to-v3

FILE: content/en/docs/migration/timetable.md
[✖] /docs/migration/flux-v1-migration/
[✖] /docs/components/
[✖] /roadmap/

FILE: content/en/docs/use-cases/azure.md
[✖] ../installation/_index.md#install-the-flux-cli

FILE: content/en/docs/use-cases/gh-actions-auto-pr.md
[✖] /docs/guides/image-update/
[✖] /docs/guides/image-update/#push-updates-to-a-different-branch

FILE: content/en/docs/use-cases/gh-actions-manifest-generation.md
[✖] /guides/sortable-image-tags/
[✖] /docs/guides/image-update/
[✖] /docs/get-started/
[✖] /cmd/flux_create_tenant
[✖] /guides/mozilla-sops/
[✖] /guides/mozilla-sops/#using-various-cloud-providers
[✖] /docs/components/image/
[✖] /docs/guides/sortable-image-tags/#example-of-a-build-process-with-timestamp-tagging
[✖] /docs/guides/sortable-image-tags/#formats-and-alternatives

FILE: content/en/docs/use-cases/jenkins.md
[✖] /docs/components/source/gitrepositories/
[✖] /docs/guides/image-update/#incident-management
[✖] /docs/guides/sortable-image-tags/
[✖] /docs/guides/image-update/
[✖] /docs/guides/sortable-image-tags/#using-in-an-imagepolicy-object

FILE: content/en/docs/use-cases/openshift.md
[✖] ../installation/_index.md#bootstrap
[✖] ../installation/_index.md#upgrade
[✖] ../installation/_index.md#bootstrap-upgrade

Ciggzy1312 commented 3 years ago

Hey @alisondy I would like to give it a try I hope I can reach out to you in case I face any difficulty

alisondy commented 3 years ago

Yooo thank you so much! Feel free to comment on the issue or reach out to me on cloud native slack if you run into any difficulties

Ciggzy1312 commented 3 years ago

Hey @alisondy Some of the links are of files which does not exist across the project folder So what should I do ? Leave them as it is or make it relative considering files of same name and address would be added in future

alisondy commented 3 years ago

Leave them as is and I'll go through on review! Thank you for taking this on!

fluxcd / website