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

build(docs): improve Makefile for docs #2327

Closed
wants to merge 1 commit into from

Conversation

agilgur5
Copy link

Summary

Used the docs Makefile in #2326 and made some improvements while working on it

Modifications

  • the docker build can be extracted into a separate make command and re-used

  • volumes need to be mounted in order to make changes to local dir and reflect in container (and vice-versa)

Notes to Reviewers

I actually still had trouble getting changes to reflect in the local dir properly. Moved to local usage of hugo and didn't debug further, but thought this was still a worthwhile improvement.

Future Work

  • May want to update versions in the Dockerfile (e.g. to Go 1.21+), newer version of Hugo, etc
  • $(COMMON_DOCKER_BUILD_ARGS) is no longer necessary as it's in a single place. But args for -v ... and -t ... could be consolidated if one wanted to do so (nbd either way imo)

- the `docker build` can be extracted into a separate `make` command and re-used

- volumes need to be mounted in order to make changes to local dir and reflect in container (and vice-versa)

Signed-off-by: Anton Gilgur <[email protected]>
@lucix-aws
Copy link
Contributor

We have internal CI that consumes this makefile, we're not generally in a position to accept changes to it without risk of breakage.

@lucix-aws lucix-aws closed this Oct 30, 2023
@agilgur5
Copy link
Author

agilgur5 commented Nov 2, 2023

without risk of breakage.

This isn't a breaking change though?

We have internal CI that consumes this makefile

The container variant also doesn't work locally, so I am guessing that your internal CI isn't using it either

we're not generally in a position to accept changes to it

That's totally your prerogative, but I would ask that you make that explicit to all potential contributors, instead of saying so after someone has already spent their time on a contribution. The CONTRIBUTING.md does not mention that nor does the Makefile itself, say, in a comment at the top.

There is also just no contributing guidelines for the docs what-so-ever, which made contributing a docs fix a good bit more difficult as a result as well

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.

2 participants