Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
2 tasks
joeflack4 opened this issue Mar 29, 2024 · 6 comments
Open
2 tasks

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

joeflack4 opened this issue Mar 29, 2024 · 6 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@joeflack4
Copy link
Contributor

joeflack4 commented Mar 29, 2024

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

  • 1. Update current automation such that manual edits can be placed somewhere and are persisted
    • a. Updates to the SOURCE.md don't get overwritten
    • b. Rather, have special place(s) in SOURCE.yml for the manual edits <---
  • 2. Improve template formatting, especially regarding section headers.
@joeflack4 joeflack4 self-assigned this Mar 29, 2024
@joeflack4 joeflack4 added the documentation Improvements or additions to documentation label Mar 29, 2024
@joeflack4
Copy link
Contributor Author

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

@joeflack4 joeflack4 mentioned this issue Mar 29, 2024
9 tasks
@matentzn
Copy link
Member

matentzn commented Apr 4, 2024

  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
Copy link
Contributor Author

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
Copy link
Member

matentzn commented Apr 5, 2024

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

@joeflack4
Copy link
Contributor Author

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
Copy link
Contributor Author

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.

@joeflack4 joeflack4 mentioned this issue Apr 18, 2024
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants