argoproj / argo-cd

Declarative Continuous Deployment for Kubernetes
https://argo-cd.readthedocs.io
Apache License 2.0
16.7k stars 5.06k forks source link

Dockerize *-docs Makefile commands #4662

Open igaskin opened 3 years ago

igaskin commented 3 years ago

Summary

Add an option to build the documentation for a docker container

Motivation

Running make build-docs calls out to mkdocs directly, which assumes that contributors have mkdocs installed locally and has dependencies on various python packages

Proposal

All *-docs make commands should be have options to execute in a dockerized environment. This brings this generation command in-line with how other code generations commands can operate.

jessesuen commented 3 years ago

Argo-rollouts takes this approach. We were able to use an off-the-shelf mkdocs image. See: https://github.com/argoproj/argo-rollouts/blob/master/Makefile#L155-L156

Here are Argo CD dependencies: https://github.com/argoproj/argo-cd/blob/c7c554674ec23c4c130ba5a6710e846a48ceb0c0/.github/workflows/gh-pages.yaml#L22

ishitasequeira commented 3 years ago

Looking into this issue