Page MenuHomePhabricator

Create a better dev experience for editing docs
Closed, ResolvedPublic

Description

Editing .rst files can be hard on the eyes, and it's nice to be able to see changes to the rendered HTML files in real time. This task proposes the following upgrades to the dev environment for a more user-friendly editing experience:

  • Add a new port mapping (8080) to the web service in docker-compose
  • Add the sphinx-autobuild extension as a dev dependency to live serve docs in the browser
  • Add a serve-docs target to the Makefile

Usage:

  1. run make serve from the root project directory
  2. navigate to localhost:8080 in a browser window
  3. enjoy hot reloading of the docs as you edit!

Event Timeline

Change 755949 had a related patch set uploaded (by Slavina Stefanova; author: Slavina Stefanova):

[wikimedia/toolhub@main] dev: Improve the dev experience for editing docs

https://gerrit.wikimedia.org/r/755949

Change 755949 merged by jenkins-bot:

[wikimedia/toolhub@main] dev: Improve the dev experience for editing docs

https://gerrit.wikimedia.org/r/755949

Change 770638 had a related patch set uploaded (by BryanDavis; author: Bryan Davis):

[operations/deployment-charts@master] toolhub: Bump container version to 2022-03-15-002555-production

https://gerrit.wikimedia.org/r/770638

Change 770638 merged by jenkins-bot:

[operations/deployment-charts@master] toolhub: Bump container version to 2022-03-15-002555-production

https://gerrit.wikimedia.org/r/770638