Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: Rename back upgrading guide #8864

Merged
merged 5 commits into from
May 27, 2022

Conversation

terrytangyuan
Copy link
Member

The new location breaks existing release notes https://github.com/argoproj/argo-workflows/releases/tag/v3.3.6

Renaming back so we can also use it to document anything that's worth attention to our users, e.g. #8860.

Signed-off-by: Yuan Tang [email protected]

Signed-off-by: Yuan Tang <[email protected]>
@terrytangyuan
Copy link
Member Author

terrytangyuan commented May 26, 2022

@alexec >> 22 spelling errors found in 126 files I don't think we want to fix those. Not sure why this didn't complain earlier. I propose to remove the spelling check completely since it's tedious to keep adding stuff like usernames, release prefixes, etc. to this list: https://github.com/argoproj/argo-workflows/blob/master/.spelling

Signed-off-by: Yuan Tang <[email protected]>
@terrytangyuan
Copy link
Member Author

Ok noticed that the file name is hard-coded in make docs-spellcheck. It should be fixed now.

@terrytangyuan
Copy link
Member Author

Getting false positives like these:

FILE: docs/metrics.md

  [✖] https://prometheus.io/docs/concepts/metric_types/

  8 links checked.
  ERROR: 1 dead links found!
  [✖] https://prometheus.io/docs/concepts/metric_types/ → Status: 403
  
   FILE: docs/use-cases/data-processing.md
  [✖] https://towardsdatascience.com/running-a-data-replication-pipeline-on-kubernetes-with-argo-and-singer-io-2fab5b0bad?utm_source=argo-docs

  ERROR: 1 dead links found!

@alexec Should we remove the spell check?

@tczhao
Copy link
Member

tczhao commented May 27, 2022

Getting false positives like these:

FILE: docs/metrics.md

  [✖] https://prometheus.io/docs/concepts/metric_types/

  8 links checked.
  ERROR: 1 dead links found!
  [✖] https://prometheus.io/docs/concepts/metric_types/ → Status: 403
  
   FILE: docs/use-cases/data-processing.md
  [✖] https://towardsdatascience.com/running-a-data-replication-pipeline-on-kubernetes-with-argo-and-singer-io-2fab5b0bad?utm_source=argo-docs

  ERROR: 1 dead links found!

@alexec Should we remove the spell check?

I think this error is from the docs-linkcheck rather than spellcheck.
The linkcheck can be flaky on git actions

Signed-off-by: Yuan Tang <[email protected]>
@terrytangyuan terrytangyuan merged commit d6e8ce5 into argoproj:master May 27, 2022
@terrytangyuan terrytangyuan deleted the mv-upgrading branch May 27, 2022 13:23
@terrytangyuan
Copy link
Member Author

Alright I re-ran the tests and now they passed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants