search

influxdata / docs-v2

InfluxData Documentation that covers InfluxDB Cloud, InfluxDB OSS 2.x, InfluxDB OSS 1.x, InfluxDB Enterprise, Telegraf, Chronograf, Kapacitor, and Flux.
https://docs.influxdata.com
MIT License
72 stars 262 forks source link

docs: Add docker compose workflow for running docs locally #5400

Closed waynr closed 5 months ago

waynr commented 5 months ago

Closes #5399

Definitely open to feedback here. It seems to just work when I run docker compose up local-dev -- the rendered site looks fine without running any additional npm commands or whatever.

jstirnaman commented 5 months ago

I noticed that if I'm already running Hugo on 1313 (for example, running npx hugo serve), and then I start the Hugo container on port 1313, they both continue to work fine. I see changes in both logs. So, it doesn't seem to be a problem, and most people should/will prefer one or the other, but I'm not sure how it works and why it doesn't cause a conflict.

waynr commented 5 months ago

I just made some style suggestions for the README and some minor changes to make the compose file more explanatory.

For what it's worth I was following the existing convention from the previous in the README but I like your suggestions better so I accepted them.