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

The sample ejb-jar.xml file had a bad version number that would preve… #7181

Merged
merged 4 commits into from
Aug 12, 2020

Conversation

rtreacy
Copy link
Contributor

@rtreacy rtreacy commented Aug 11, 2020

…nt deployment of the application if the ejb-jar file was used to modify the saved searchers timer schedule.

I updated the timer.rst file to document a procedure for inserting an edited ejb-jar.xml file into a war, rather than doing a full build of the application

What this PR does / why we need it:The sample file cannot be used with the wrong version number

Which issue(s) this PR closes:Bad version number in sample ejb-jar.xml; document procedure for updating the war file to include the ejb-jar.xml outside of a build environment

Closes #7175

Special notes for your reviewer:

Suggestions on how to test this: You can test the procedure documented at the end of the timer.rst file. The description of this procedure starts with "Alternatively, you can insert an ejb-jar.xml ..."

Does this PR introduce a user interface change? If mockups are available, please link/include them here:no

Is there a release notes update needed for this change?:no

Additional documentation:

…nt deployment of the application if the ejb-jar file was used to modify the saved searchers timer schedule.

I updated the timer.rst file to document a procedure for inserting an edited ejb-jar.xml file into a war, rather than doing a full build of the application
@djbrooke djbrooke added this to the Dataverse 5 milestone Aug 11, 2020
Copy link
Contributor

@scolapasta scolapasta left a comment

Choose a reason for hiding this comment

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

Looks good - just a small tweak since the next release is Dataverse 5.


* The provided parameters in the sample file are <minute>, <hour>, and <dayOfWeek>; additional parameters are available

* For a complete reference for calendar expressions that can be used to schedule Timer services see: https://docs.oracle.com/javaee/7/tutorial/ejb-basicexamples004.htm

* Build and deploy the application

* Alternatively, you can insert an ejb-jar.xml file into a provided dataverse war file without building the application.

* Check if there is already an ejb-jar.xml file in the war file (as I'm writing, the dataverse war file is named dataverse-4.20.war)
Copy link
Contributor

Choose a reason for hiding this comment

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

Since this will be for the Dataverse 5 release, we should change this to that - I think you can also jsut say e.g. instead of "as I'm writing"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

like 'Check if there is already an ejb-jar.xml file in the war file, e.g dataverse-5.war' and same wherever referenced in the commands?

IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from Code Review 🦁 to QA 🔎✅ Aug 11, 2020
@coveralls
Copy link

coveralls commented Aug 11, 2020

Coverage Status

Coverage decreased (-0.0006%) to 19.562% when pulling 6dac9ed on 7175-tweak-timer-doc into 3029502 on develop.

@kcondon kcondon assigned kcondon, djbrooke and mheppler and unassigned kcondon Aug 12, 2020
@kcondon
Copy link
Contributor

kcondon commented Aug 12, 2020

Confirmed the instructions work, thanks Bob. Passing over to Danny/Mike for doc formatting clean up.

@djbrooke
Copy link
Contributor

Thanks @kcondon and @rtreacy... @mheppler do you want to take the first stab or should I?

@djbrooke djbrooke moved this from QA 🔎✅ to IQSS Team - In Progress 💻 in IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) Aug 12, 2020
@rtreacy
Copy link
Contributor Author

rtreacy commented Aug 12, 2020

One thing I noticed when I looked back at what Kevin showed me, is that aside from the enlarged text, which I have no idea where that comes from, even after reading the basic sphinx documentation, there also a logical formatting error, which I could fix, but since you guys have it now, maybe you could take care of.

The last 3 lines of my instructions, eg
Insert...
jar...
Deploy...
should each be moved to the left, so that Insert and Deploy are at the same indentation as Check

@mheppler
Copy link
Contributor

mheppler commented Aug 12, 2020

@kcondon @djbrooke @rtreacy -- fixed the bulleted list formatting, too many indent spaces.

Screen Shot 2020-08-12 at 2 37 44 PM

@kcondon kcondon merged commit 1eabad2 into develop Aug 12, 2020
IQSS/dataverse (TO BE RETIRED / DELETED in favor of project 34) automation moved this from IQSS Team - In Progress 💻 to Done 🚀 Aug 12, 2020
@kcondon kcondon deleted the 7175-tweak-timer-doc branch August 12, 2020 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Development

Successfully merging this pull request may close these issues.

Tweak timer doc
6 participants