search

monarch-initiative / mondo-ingest

Coordinating the mondo-ingest with external sources
https://monarch-initiative.github.io/mondo-ingest/
6 stars 3 forks source link

Improve `docs/sources/SOURCE.md` templating & editing #481

Open joeflack4 opened 3 months ago

joeflack4 commented 3 months ago

Overview

These files are currently edited in two ways, sequentially:

  1. Automatically / dynamically, from the metadata/SOURCE.yml
  2. Then, the **Comments about this source:** section is manually edited.

However, this creates a problem. If metadata/SOURCE.yml changes, the manual edits will be overwritten.

Additionally, I think there are improvements in store for this template, such as changing bold **header** section headers to actual markdown ## header section headers.

Sub-tasks

joeflack4 commented 3 months ago

@twhetzel This is a low priority, but an FYI. Sometimes my manual edits to these docs have gotten overwritten, so a fix is due.

matentzn commented 3 months ago
  1. Why not put your manual edits in metadata/SOURCE.yml
  2. If you need more flexibility, just make a docs/sources/SOURCE_extra.md and link it from the metadata/SOURCE.yml file?
joeflack4 commented 3 months ago

I'm fine with (1) or (2), but I just want it to be standard across all the sources.

Right now, I believe that all manual edits to all sources are going in the Comments about this source: sections.

That begs the question: By your suggestion (1), are you saying that there is somewhere in metadata/SOURCE.yml such that, when I fill that part out, it will get populated into the Comments about this source: section? If so, how do I do that? And if not, then where in the file do you suggest I add these details?

matentzn commented 3 months ago

Check the jinja template config/source_documentation.md.j2 and adjust as you see fit!

joeflack4 commented 3 months ago

Righto, that's primarily what I was thinking, and I thought there was an issue about that but I couldn't find. Just updated the sub-tasks in the OP; we'll do that.

joeflack4 commented 2 months ago

In #434 I've already added a comments_about_this_source key to icd11foundation.yml. Now I just need to update the Jinja template to utilize this, and then run it and make sure that it correctly populates.