template readme files live in templates repo vs oci repo

Bug #1905286 reported by Richard Harding
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Ubuntu Docker Images
Fix Released
Medium
Unassigned

Bug Description

lp:~canonical-server/ubuntu-docker-images/+git/templates

The data directory in ^ contains the readme yaml data for each oci image. Given that folks will go to the oci git project to make an edit this is a really easy way for the data to get out of sync.

I propose that in each container should be a readme.yaml and a readme.md where the templating tool is used as an outside script/tool to generate the readme.md from the yaml in tree.

Related branches

Revision history for this message
Sergio Durigan Junior (sergiodj) wrote :

I've now updated all of the images with the new template scheme. Here's basically what I did:

- Move the YAML data files from the templates.git to the respective
  repositories.

- Create a Makefile inside each repository, which makes it easier to
  generate the final documents (you just have to type "make" now, and
  you can provide the path to your RenderDown script by setting the
  RENDERDOWN variable).

- Transform the HACKING.md files into a template as well. I've had to
  create one template for images that are built from .deb packages, and
  another for images that are built directly from upstream.

- Regenerate everything inside each repository.

I'm marking this bug as Fix Released.

Changed in ubuntu-docker-images:
status: Triaged → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.