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

Improve xdmod-ingestor documentation #1016

Merged
merged 1 commit into from
Aug 29, 2019
Merged

Conversation

jtpalmer
Copy link
Contributor

Description

Fixes formatting, grammar and accuracy.

Motivation and Context

There were formatting, grammar and accuracy issues with the documentation.

Tests performed

No tests.

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 documentation Documentation updates Category:General General labels Aug 28, 2019
@jtpalmer jtpalmer added this to the 8.5.0 milestone Aug 28, 2019
@jtpalmer jtpalmer requested a review from chakrabortyr August 28, 2019 18:30
@jpwhite4
Copy link
Member

These changes look good but there is still room for improvement. Some of my favorite quotes:

I like the use of with rather than will. It makes it sound like Shakespearean prose:

By default, the ingestor with process new job data

Lots of extra unneeded words here:

wish to break down your ingestion process to exclusively ingest cloud data, you may do so as such

perhaps change "you may do so as such" to "ye may do so as such" to fit with the pseudo Shakespearean style.

I like the idea that the xdmod-ingestor is having deep philosophical thoughts about the classification of the text that it is producing:

 the Open XDMoD ingestor only outputs what it considers to be warnings

@@ -27,58 +27,59 @@ Start and End Date

If you have changed any data in the Open XDMoD database it is necessary
to re-ingest that data. This can be accomplished by specifying a start
and end date, formatted as YYYY-MM-DD, that include the dates
and end date, formatted as YYYY-MM-DD, that include the dates
Copy link
Member

Choose a reason for hiding this comment

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

Is the end date inclusive of exclusive? Does it refer to the start or the end of the day specified?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

All dates are inclusive. I can add that somewhere if it's not clear.

@jtpalmer jtpalmer merged commit defa57f into ubccr:xdmod8.5 Aug 29, 2019
@jtpalmer jtpalmer deleted the docs-ingestor branch August 29, 2019 13:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Category:General General documentation Documentation updates
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants