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 README to data warehouse export zip files #1300

Merged
merged 2 commits into from
May 5, 2020

Conversation

jtpalmer
Copy link
Contributor

@jtpalmer jtpalmer commented May 1, 2020

Description

Adds a README.txt file to the data warehouse export zip file that contains a description of all the exported fields.

NOTE: This depends on and includes all the commits from #1298 as of now

Motivation and Context

https://app.asana.com/0/15230011293693/1146676887787308

Tests performed

Updated automated tests. Tested manually.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project as found in the CONTRIBUTING document.
  • I have added tests to cover my changes.
  • All new and existing tests passed.

@jtpalmer jtpalmer added enhancement Enhancement of the functionality of an existing feature Category:Data Warehouse Export Data Warehouse Export labels May 1, 2020
@jtpalmer jtpalmer added this to the 9.0.0 milestone May 1, 2020
@jtpalmer jtpalmer requested review from plessbd and jpwhite4 May 1, 2020 17:27
foreach ($fields as $field) {
$text .= sprintf(
"%s: %s\n",
$field['name'],
Copy link
Member

Choose a reason for hiding this comment

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

Do we allow html in the documentation field? Is it work htmldecode this before putting in the text file?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

As of now, none of the documentation fields contain html. I don't think there is anything to forbid it.

I don't see any entities, but if we do decide to allow arbitrary html then just decoding wouldn't be enough since we'd still have to strip out any tags.

@jtpalmer jtpalmer merged commit 9c2e377 into ubccr:xdmod9.0 May 5, 2020
@jtpalmer jtpalmer deleted the dwe-explanation-file branch May 5, 2020 13:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category:Data Warehouse Export Data Warehouse Export enhancement Enhancement of the functionality of an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants