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

DM-41867: Add improvements to schema browser #256

Merged
merged 5 commits into from
Oct 18, 2024
Merged

Conversation

JeremyMcCormick
Copy link
Collaborator

@JeremyMcCormick JeremyMcCormick commented Sep 30, 2024

Adds the following improvements and features to the schema browser:

  • Sorts tables initially on Index and then Column Name if Index is not present
  • Added additional columns to the table: Index, UCD, and Principal
  • Column sorting (by clicking on the column header)
  • Table contents search by text string using a search box
  • Table pagination with selectable number of rows to display
  • Export to CSV by clicking a button at the top of each table

Advanced table features were enabled by the well-known DataTables Javascript library and its script dependencies.

Also included several miscellaneous fixes:

  • Changed the "Updated" date to use the site upload date rather than last_modified (Otherwise, this only updates when the HTML pages themselves are changed, which does not work for our purposes.)
  • Removed the last_modified plugin config, as it is no longer required
  • Removed the DP0.1 schema markdown file

(Many of these features and fixes are outside the scope of the original ticket, but they were fairly minimal in terms of updating the HTML files. So I decided to bundle them together in one update.)

@JeremyMcCormick JeremyMcCormick marked this pull request as draft October 4, 2024 20:54
@JeremyMcCormick JeremyMcCormick force-pushed the tickets/DM-41867 branch 6 times, most recently from 04ec583 to d5774d7 Compare October 15, 2024 20:04
@JeremyMcCormick JeremyMcCormick changed the title DM-41867: Sort columns by TAP column index and name in schema browser DM-41867: Add improvements to schema browser Oct 15, 2024
@JeremyMcCormick JeremyMcCormick requested review from gpdf and removed request for gpdf October 15, 2024 20:40
@JeremyMcCormick JeremyMcCormick marked this pull request as ready for review October 15, 2024 20:59
@JeremyMcCormick JeremyMcCormick force-pushed the tickets/DM-41867 branch 4 times, most recently from e4c2e0c to 3e91a72 Compare October 18, 2024 16:10
@JeremyMcCormick JeremyMcCormick force-pushed the tickets/DM-41867 branch 2 times, most recently from 71d0373 to a376c61 Compare October 18, 2024 16:23
Copy link
Collaborator

@gpdf gpdf left a comment

Choose a reason for hiding this comment

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

Reviewed as-deployed on a branch on this doc site, on 2024-10-16 and -18.

Last request: restore the ordering of tables from the existing schema browser.

Add DataTables support which provides pagination, sorting by column,
and textual search capability.

Also add additional columns to the schema browser: UCD, Index and
Principal.

Initially sort the table first by Index and then Column Name.
This is not needed any longer with the DataTables sorting.
This no longer needed, because the pages have been changed to use the
site upload date, instead.
Copy link
Collaborator

@gpdf gpdf left a comment

Choose a reason for hiding this comment

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

Looks great now. Deploy!

@JeremyMcCormick JeremyMcCormick merged commit 7d2bb10 into main Oct 18, 2024
9 checks passed
@JeremyMcCormick JeremyMcCormick deleted the tickets/DM-41867 branch October 18, 2024 16:56
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.

2 participants