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.

Sign up for GitHub

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

Jump to bottom

docs: fix broken links + add back check #11301

Merged
merged 1 commit into from
Jul 6, 2023
Merged

docs: fix broken links + add back check #11301

merged 1 commit into from
Jul 6, 2023

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Jul 6, 2023 •
edited
Loading

Motivation

Modifications

  • fixed both broken links by adding versioned permalinks to updated locations
  • uncomment docs-linkcheck from make docs
  • corrected Nix directory comment

Verification

Ran make docs

@agilgur5
docs: fix broken links + add back CI check
1a87b5f 
- `make docs-linkcheck` found two broken links
  - fixed both by adding versioned permalinks to updated locations

- command runs fine on my local machine now, so maybe was due to an error that was patched
  - uncomment it from `make docs` as such

- fix the top-level Nix comment -- the folder got moved to `dev/nix/`

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@terrytangyuan
Copy link
Member

Where did you add the CI back?

@agilgur5
Copy link
Member Author

agilgur5 commented Jul 6, 2023 •
edited
Loading

I perhaps used the word "CI" a bit generically in the title; I meant the uncommenting of make docs-linkcheck

I'll remove that from the title so it's just "check" instead of "CI check"

@agilgur5 agilgur5 changed the title docs: fix broken links + add back CI check docs: fix broken links + add back check Jul 6, 2023
@terrytangyuan terrytangyuan merged commit 28376e5 into argoproj:master Jul 6, 2023
24 checks passed
@agilgur5 agilgur5 deleted the docs-fix-broken-links branch July 6, 2023 21:03
@terrytangyuan
Copy link
Member

I am disabling it again since it's flaky. #11305

@agilgur5
Copy link
Member Author

agilgur5 commented Jul 7, 2023 •
edited
Loading

aw dang. it is working now though, but as it does live checks on sites, depends on website availability and got a 503:

  [✖] https://www.jenkins.io/doc/pipeline/steps/pipeline-input-step/ → Status: 503
  ERROR: 1 dead links found in docs/intermediate-inputs.md !

guess it might be better to run as a weekly job. or preferably, to only run on changed docs. potentially not worth the effort to implement.

Related but separately, I was looking to optimize the CI pipeline with something like https://github.com/tj-actions/changed-files so that, primarily, E2E tests can be skipped for docs-only changes (i.e. limited to the docs/ folder).

@terrytangyuan
Copy link
Member

That would be great. There's an existing issue for that I think

@agilgur5 agilgur5 mentioned this pull request Aug 15, 2023
Merged
@agilgur5 agilgur5 added area/docs Incorrect, missing, or mistakes in docs area/build Build or GithubAction/CI issues labels Sep 13, 2023
@agilgur5
Copy link
Member Author

There's an existing issue for that I think

I couldn't find this when you first mentioned it. Randomly stumbled upon it today and assigned myself: #10265

@agilgur5 agilgur5 mentioned this pull request Sep 21, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@terrytangyuan terrytangyuan terrytangyuan approved these changes

Assignees
No one assigned
Labels
area/build Build or GithubAction/CI issues area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@agilgur5 @terrytangyuan