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 data loading documentation to README #899

Merged
merged 2 commits into from
Feb 10, 2022

Conversation

hakbailey
Copy link
Contributor

@hakbailey hakbailey commented Feb 9, 2022

Why these changes are being introduced:

To provide documentation for developers on how and when various types of data get loaded into the system.

How this addresses that need:

  • Adds a Data Loading section to the README with documentation on seed data and registrar data loads, and a placeholder for test data loads

Side effects of this change:

None

Relevant ticket(s):

Developer

  • All new ENV is documented in README
  • All new ENV has been added to Heroku Pipeline, Staging and Prod
  • ANDI or Wave has been run in accordance to
    our guide and
    all issues introduced by these changes have been resolved or opened as new
    issues (link to those issues in the Pull Request details above)
  • Stakeholder approval has been confirmed (or is not needed)

Code Reviewer

  • The commit message is clear and follows our guidelines
    (not just this pull request message)
  • There are appropriate tests covering any new functionality
  • The documentation has been updated or is unnecessary
  • The changes have been verified
  • New dependencies are appropriate or there were no changes

Requires database migrations?

NO

Includes new or updated dependencies?

NO

Why these changes are being introduced:
To provide documentation for developers on how and when various types
of data get loaded into the system.

How this addresses that need:
* Adds a Data Loading section to the README with documentation on seed
  data and registrar data loads, and a placeholder for test data loads

Side effects of this change:
None

Relevant ticket(s):
* https://mitlibraries.atlassian.net/browse/ETD-217
@mitlib mitlib temporarily deployed to thesis-submit-pr-899 February 9, 2022 21:52 Inactive
@coveralls
Copy link

coveralls commented Feb 9, 2022

Coverage Status

Coverage remained the same at 97.047% when pulling 0d47cc1 on etd-217-document-data-loading into a069d54 on main.

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Member

@JPrevost JPrevost left a comment

Choose a reason for hiding this comment

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

Please update syntax from rake to rails. Thanks for documenting this!

@hakbailey hakbailey requested a review from JPrevost February 10, 2022 14:47
@hakbailey hakbailey temporarily deployed to thesis-submit-pr-899 February 10, 2022 14:48 Inactive
@hakbailey hakbailey merged commit ddf3e5a into main Feb 10, 2022
@hakbailey hakbailey deleted the etd-217-document-data-loading branch February 10, 2022 16:19
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