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

Add description key and description processing to sources tab #2747

Merged
merged 3 commits into from
Oct 13, 2023

Conversation

pabloarosado
Copy link
Contributor

@pabloarosado pabloarosado commented Oct 12, 2023

We used to show plenty of information about variables (including information about the processing of the variable) via the description field, which is surfaced in the sources tab. But now, with the new metadata, we are only surfacing descriptionShort, and therefore we are currently missing crucial information in charts.

This PR adds a section in the variable description table called "Key information" (showing descriptionKey) and another called "Processing notes" (showing descriptionProcessing).

NOTE: For some reason, descriptionProcessing is always empty in the database variables table, but I understand that this was unintended, and can be easily fixed. (Mojmir has fixed this)

@pabloarosado
Copy link
Contributor Author

This is an example of how the sources tab will look like:
Screen Shot 2023-10-12 at 12 17 19

One thing to note is that bullet points within the string field descriptionProcessing (that in the YAML file were created using - Blah) look different to the bullet points of descriptionKey. But I guess this is a minor style concern.

Copy link
Member

@lucasrodes lucasrodes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for the rapid implementation

Copy link
Contributor

@danyx23 danyx23 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice work - thanks Pablo! I added a new markdown renderer to fix some issues with broken list items.

Good to merge!

@pabloarosado pabloarosado merged commit 8718595 into master Oct 13, 2023
13 checks passed
@pabloarosado pabloarosado deleted the add-description-fields-to-sources-tab branch October 13, 2023 12:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants