Skip to content

Latest commit

 

History

History
46 lines (28 loc) · 1.25 KB

README.md

File metadata and controls

46 lines (28 loc) · 1.25 KB

tilt.build

Tilt landing page, docs page, and blog page

Developing

  1. Install yarn

  2. Install Tilt

  3. Run tilt up

The landing page will be running at http://localhost:4000/.

The docs page will be running at http://localhost:4001/.

The blog page will be running at http://localhost:4002/.

Edits to the markdown will auto-update the HTML. The landing page lives under src and the docs page lives under docs. The docs directory has symlinks to share stuff with the landing page.

When you're finished, merge to master and Netlify will auto-deploy the site.

API docs

The API docs are a little bit more complicated.

We write the API docs as docstrings in Python files in the main Tilt repo. Then, during the release pipeline (release-update-tilt-docs.sh), the files are generated and updated here (under api/api), Sphinx generates HTML fragments (make api), and then Jekyll serves that HTML fragment.

The autogenerated API Python files include instructions on how to edit the source content.

License

Copyright 2022 Docker, Inc.

Licensed under the Apache License, Version 2.0