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

Centralizing documentation for standard columns #145

Open
gnguyen87 opened this issue Aug 8, 2024 · 0 comments
Open

Centralizing documentation for standard columns #145

gnguyen87 opened this issue Aug 8, 2024 · 0 comments
Assignees

Comments

@gnguyen87
Copy link
Contributor

gnguyen87 commented Aug 8, 2024

There are documentations of models/columns that can repeat throughout all edu packages. We'd like a centralized .md documentation that reside in edu_wh that details the description of standard columns. These will be doc blocks that can be referenced in every downstream package in their .yml files.

This work includes the following steps:

  • Find and write out standard descriptions for columns/models that appear frequently throughout all edu packages.
  • Centralize them in a singular .md file that reside in edu_wh
  • Refactor other packages .yml file to reference these doc blocks
  • Test and run packages to ensure this all work
@gnguyen87 gnguyen87 self-assigned this Aug 8, 2024
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

No branches or pull requests

1 participant