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

refactor(build): simplify mkdocs build scripts #12463

Merged

Conversation

agilgur5
Copy link
Member

@agilgur5 agilgur5 commented Jan 4, 2024

Motivation

  • we no longer need a separate file in hack/ since the new build in mkdocs 1.5+ is a one-liner
    • this is also more efficient as we only execute mkdocs build once now

follow-up to #12360

Modifications

  • Remove hack/check-mkdocs.sh and all references to it
  • add --strict to Makefile's existing mkdocs build command

Verification

Ran make docs successfully and checked that the docs looked as expected (i.e. no changes).

- we no longer need a separate file in `hack/` since the new build in `mkdocs` 1.5+ is a one-liner
  - this is also more efficient as we only execute `mkdocs build` once now

follow-up to e921056

Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
@agilgur5 agilgur5 added area/docs Incorrect, missing, or mistakes in docs area/build Build or GithubAction/CI issues labels Jan 4, 2024
@agilgur5 agilgur5 requested a review from jmeridth January 4, 2024 19:52
Signed-off-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
@agilgur5
Copy link
Member Author

agilgur5 commented Jan 6, 2024

Fixed conflict

Copy link
Contributor

@alexec alexec left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@terrytangyuan terrytangyuan merged commit 1c31790 into argoproj:main Feb 5, 2024
27 checks passed
@agilgur5 agilgur5 deleted the refactor-mkdocs-script-simplify branch February 5, 2024 18:36
agilgur5 added a commit that referenced this pull request Apr 9, 2024
Signed-off-by: Anton Gilgur <agilgur5@gmail.com>
Signed-off-by: Anton Gilgur <4970083+agilgur5@users.noreply.github.com>
@agilgur5
Copy link
Member Author

agilgur5 commented Apr 9, 2024

Backported cleanly to release-3.5 as a164335

@agilgur5 agilgur5 added this to the v3.5.x patches milestone Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/build Build or GithubAction/CI issues area/docs Incorrect, missing, or mistakes in docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants