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

[docs] Refine docs site #91

Merged
merged 13 commits into from
Mar 11, 2024
Merged

[docs] Refine docs site #91

merged 13 commits into from
Mar 11, 2024

Conversation

vpchung
Copy link
Member

@vpchung vpchung commented Mar 7, 2024

Fixes #68

Changelog

  • Move data model tables to the front page, moving the list of terms to the second tab
  • Allow long tables to be scrollable (current max height set to 650px)
  • Replace previous "Vocab" pages with "Valid Values" pages, so that all valid value tables for a given model are displayed on the same page (whereas before, terms were split by category)
  • Add a sub-page that will display all valid value terms (using all_valid_values.csv as the source)
  • Add Attribute: to the headers on the valid values pages
  • Replace Attribute with Valid Values in the valid values tables
  • Add Validation Rules to the data model tables, displaying None for any attributes with no rules
  • Add a hooks script to pre-process the model template files (modules/**/annotationProperty.csv) so that:
    • Attributes with a list of valid values are linked to the valid values table
    • Only columns only relevant to the end-user are used
  • Use "DM Sans" - Sage's latest official font/typeface

Preview

Screen.Recording.2024-03-11.at.3.26.19.PM.mov

To test locally

  1. Install mkdocs, mkdocs-material, mkdocs-table-reader-plugin, pandas, ideally in a virtual environment, e.g.

    conda create -n docs python=3.12
    conda activate docs
    pip install mkdocs mkdocs-material mkdocs-table-reader-plugin pandas
    
  2. Change directories to the repo and checkout this branch:

    cd path/to/data-models 
    git checkout docs-68
    
  3. Start the server:

    mkdocs serve
    

    This will serve the documentation on http://127.0.0.1:8000.

Once done, stop the server with Ctrl + C

@vpchung vpchung added documentation Improvements or additions to documentation non-release PR label for a non-release update labels Mar 7, 2024
@vpchung vpchung self-assigned this Mar 7, 2024
@vpchung vpchung changed the title [docs] Update reorder tab navigation; update .gitignore [docs] Refine docs site Mar 7, 2024
@vpchung vpchung marked this pull request as ready for review March 11, 2024 22:22
Copy link
Contributor

@Bankso Bankso left a comment

Choose a reason for hiding this comment

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

@vpchung thank you for putting these together and for the excellent screen capture video, the pages look incredible! 😄

@vpchung vpchung merged commit 30ff455 into main Mar 11, 2024
1 check passed
@vpchung vpchung deleted the docs-68 branch March 11, 2024 22:53
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 non-release PR label for a non-release update
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Data model documentation refinements
2 participants