3431 dev guide #3892

pdurbin · 2017-06-13T00:40:26Z

New Contributors

Welcome! New contributors should at least glance at CONTRIBUTING.md, especially the section on pull requests where we encourage you to reach out to other developers before you start coding. Also, please note that we measure code coverage and prefer you write unit tests. Pull requests can still be reviewed without tests or completion of the checklist outlined below. Thanks!

Related Issues

connects to Set testing expectations in Developer Guide and document tools (Jacoco, Coveralls, REST Assured) #3431 Set expectations in Developer Guide for testing and document tools (Jacoco, Coveralls, REST Assured)
connects to Set expectations for coding style and code review in dev guide #3418 Set expectations for coding style and code review in dev guide
connects to README.md and CONTRIBUTING.md out of date #3729 README.md out of date, tweaks to it, CONTRIBUTING.md, and PULL_REQUEST_TEMPLATE.md
connects to Document ideas for improving automated testing #2746 Document ideas for improving automated testing
connects to improved war deployment docs #3907 improved war deployment docs
connects to Previous/Next navigation links in dev guide #2163 Previous/Next navigation links in dev guide
connects to Code style: meaningful strings should be constants, but aren't #2724 Code style: meaningful strings should be constants, but aren't
connects to Development tooling: add 'enable hints for javac warnings' to project settings #2644 Development tooling: add 'enable hints for javac warnings' to project settings
connects to Code style/Ops: use Logger.log instead of System.out.print[ln] #2575 Code style/Ops: use Logger.log instead of System.out.print[ln]
connects to Code style: lack of Java generics causes 100s of type safety warnings #2574 Code style: lack of Java generics causes 100s of type safety warnings
connects to dev docs for glassfish analytics #3934 dev docs for glassfish analytics

Pull Request Checklist

Unit tests completed
Integration tests: None
Deployment requirements, SQL updates, Solr updates, etc.: None
Documentation completed
Merged latest from "develop" branch and resolved conflicts

…pdated documentation.rst and geospatial.rst to include table of contents preface

…dev-guide #3431 Resolved ToC Conflicts: doc/sphinx-guides/source/developers/documentation.rst doc/sphinx-guides/source/developers/geospatial.rst doc/sphinx-guides/source/developers/testing.rst

Phil and I are confused about whether our merge conflict worked! Testing out this fix.

Changed filename and title of page and added a section called "Using Git" with info on how to make commits and resolve merge conflicts.

Fixed a couple typos in the Version Control page. Lookin' good!

Made minor typo/style fixes to testing.rst. Also looked over dev-environment.rst and it's all good.

Fixed a header typo I'd missed before.

coveralls · 2017-06-13T18:54:03Z

Coverage decreased (-0.004%) to 10.282% when pulling 51ecfd9 on 3431-dev-guide into 02e5545 on develop.

Conflicts: doc/sphinx-guides/source/developers/dev-environment.rst

coveralls · 2017-06-15T21:22:39Z

Coverage remained the same at 10.28% when pulling f690ded on 3431-dev-guide into e903302 on develop.

coveralls · 2017-06-16T15:20:24Z

Coverage remained the same at 10.28% when pulling 2f43b35 on 3431-dev-guide into e903302 on develop.

Changed formatting to fix issues with issue syntax and Waffle.

coveralls · 2017-06-19T15:52:18Z

Coverage remained the same at 10.28% when pulling 7076bdc on 3431-dev-guide into e903302 on develop.

oscardssmith · 2017-06-19T16:27:57Z

In terms of suggested netbeans settings, add that says roughly, go to options -> editor -> hints and check the following (at least):
Error Fixes
JavaDoc
JDK Migration Support
Standard Javac Warnings
These settings let you see and often fix for you possible problems in your code.

coveralls · 2017-06-20T13:23:48Z

Coverage remained the same at 10.28% when pulling fa95e12 on 3431-dev-guide into e903302 on develop.

coveralls · 2017-06-20T13:46:10Z

Coverage remained the same at 10.28% when pulling 06bd186 on 3431-dev-guide into e903302 on develop.

coveralls · 2017-06-20T14:01:56Z

Coverage remained the same at 10.28% when pulling a299f8a on 3431-dev-guide into e903302 on develop.

coveralls · 2017-06-20T14:44:46Z

Coverage remained the same at 10.28% when pulling dccd9b0 on 3431-dev-guide into e903302 on develop.

zhul-pku

For vagrant and VirtualBox, if there is an error like "vitualbox has halted", it could possibly be fixed after something changes are made to the vagrant script and some changes are made to the BIOS settings of windows laptop.

oscardssmith · 2017-06-20T16:01:41Z

doc/sphinx-guides/source/developers/coding-style.rst

+Avoid Hard-Coding Strings
+~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Special strings should be defined as public constants. For example, ``DatasetFieldConstant.java`` contains has a field for "title" and it's used in many places in the code (try "Find Usages" in Netbeans). This is better than writing the string "title" in all those places.


Because (among other reasons), it makes translation easier.

coveralls · 2017-06-20T16:02:15Z

Coverage decreased (-0.004%) to 10.276% when pulling 6535d9d on 3431-dev-guide into e903302 on develop.

oscardssmith · 2017-06-20T16:04:10Z

doc/sphinx-guides/source/developers/coding-style.rst

+
+- "Raw Types" under "Standard Javac Warnings"
+
+If you know of a way to easily share Netbeans configuration across a team, please get in touch.


You can export/import.

Here is mine netbeans.zip

Small fixes to Coding Style page.

coveralls · 2017-06-20T16:50:33Z

Coverage decreased (-0.004%) to 10.276% when pulling f7a9337 on 3431-dev-guide into e903302 on develop.

coveralls · 2017-06-20T17:11:11Z

Coverage decreased (-0.004%) to 10.276% when pulling f7a9337 on 3431-dev-guide into e903302 on develop.

coveralls · 2017-06-20T18:41:57Z

Coverage decreased (-0.004%) to 10.276% when pulling 7dbb863 on 3431-dev-guide into e903302 on develop.

Also link to list of contributors.

coveralls · 2017-06-20T18:57:55Z

Coverage decreased (-0.004%) to 10.276% when pulling 7e9a8d9 on 3431-dev-guide into e903302 on develop.

coveralls · 2017-06-20T19:23:55Z

Coverage decreased (-0.004%) to 10.276% when pulling db03e1d on 3431-dev-guide into e903302 on develop.

bsilverstein95 and others added 13 commits June 6, 2017 15:26

Updated testing documentation page with actual guide documentation; u…

681d1d0

…pdated documentation.rst and geospatial.rst to include table of contents preface

Merge remote-tracking branch 'refs/remotes/origin/develop' into 3431-…

9de44bb

…dev-guide #3431 Resolved ToC Conflicts: doc/sphinx-guides/source/developers/documentation.rst doc/sphinx-guides/source/developers/geospatial.rst doc/sphinx-guides/source/developers/testing.rst

Fixing merge conflict [ref: #3431]

8aaed4f

Phil and I are confused about whether our merge conflict worked! Testing out this fix.

Changed "Branching Strategy" page to "Version Control" [Ref: #3431]

4aa8141

Changed filename and title of page and added a section called "Using Git" with info on how to make commits and resolve merge conflicts.

finish converting branching-strategy.rst into version-control.rst #3431

271137d

must build war before running installer #3431

3c0c538

explain context-root problem and solution #3431

e32b9de

reword version control page #3431

269301a

Version Control page review [Ref: #3431]

2220912

Fixed a couple typos in the Version Control page. Lookin' good!

fix a typo, a couple tweaks #3431

682452c

rewrite of testing page #3431

5b57bec

Proofread of Testing and Dev Environment pages [ref: #3431]

a47b0c2

Made minor typo/style fixes to testing.rst. Also looked over dev-environment.rst and it's all good.

Typo fix [ref: #3431]

51ecfd9

Fixed a header typo I'd missed before.

pdurbin added 2 commits June 14, 2017 14:39

fix glassfish link, smtp trouble, non-interactive mode #3431

24340e9

mention dos2unix is needed on Windows for Vagrant #3431

f4f0feb

pdurbin mentioned this pull request Jun 15, 2017

Glassfish link fix #3901

Merged

Merge branch 'develop' into 3431-dev-guide #3431

f690ded

Conflicts: doc/sphinx-guides/source/developers/dev-environment.rst

mention read-only team and spreadsheet of contributors #3431

2f43b35

Changed formatting of Issue Number and Title

7076bdc

Changed formatting to fix issues with issue syntax and Waffle.

mention asadmin deployment in dev guide #3907

fa95e12

add previous and next links to dev guide #2163

06bd186

pdurbin mentioned this pull request Jun 20, 2017

Document how to configure a Jenkins job to build Dataverse #1936

Closed

add section on testing commands #3431 #1797

a299f8a

pdurbin mentioned this pull request Jun 20, 2017

Clean up docs directory #1797

Closed

add deploying manually section from @pameyer #3907

dccd9b0

zhul-pku reviewed Jun 20, 2017

View reviewed changes

improve coding style page in dev guide #3418 #2724 #2644 #2575 #2574

6535d9d

pdurbin mentioned this pull request Jun 20, 2017

Set expectations for coding style and code review in dev guide #3418

Closed

oscardssmith reviewed Jun 20, 2017

View reviewed changes

pdurbin and others added 2 commits June 20, 2017 12:25

fix broken links to datascience.iq (deceased) #3431

071a6bd

Proofread fixes for #3418

f7a9337

Small fixes to Coding Style page.

pdurbin added 2 commits June 20, 2017 14:37

improve readme #3729

b5a4ed1

finsh changing "master" to "develop" in readme #3729

7dbb863

we don't assign new issues anymore, link version control page #3729

7e9a8d9

Also link to list of contributors.

pdurbin mentioned this pull request Jun 20, 2017

README.md and CONTRIBUTING.md out of date #3729

Closed

asadmin syntax for disabling glassfish analytics

db03e1d

This was referenced Jun 20, 2017

dev docs for glassfish analytics #3934

Closed

asadmin syntax for disabling glassfish analytics #3935

Closed

kcondon merged commit 6f2afd1 into develop Jun 20, 2017

kcondon deleted the 3431-dev-guide branch June 20, 2017 20:06

pdurbin mentioned this pull request Jun 20, 2017

Builtin-Users API doc not clear how to specify user with JSON #3192

Closed

pdurbin added this to the 4.7 - Customization and Community Release milestone Jun 21, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

3431 dev guide #3892

3431 dev guide #3892

pdurbin commented Jun 13, 2017 •

edited

Loading

coveralls commented Jun 13, 2017

coveralls commented Jun 15, 2017

coveralls commented Jun 16, 2017

coveralls commented Jun 19, 2017

oscardssmith commented Jun 19, 2017 •

edited

Loading

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017

zhul-pku left a comment

oscardssmith Jun 20, 2017

coveralls commented Jun 20, 2017

oscardssmith Jun 20, 2017

oscardssmith Jun 20, 2017

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017


		- "Raw Types" under "Standard Javac Warnings"

		If you know of a way to easily share Netbeans configuration across a team, please get in touch.

3431 dev guide #3892

3431 dev guide #3892

Conversation

pdurbin commented Jun 13, 2017 • edited Loading

New Contributors

Related Issues

Pull Request Checklist

coveralls commented Jun 13, 2017

coveralls commented Jun 15, 2017

coveralls commented Jun 16, 2017

coveralls commented Jun 19, 2017

oscardssmith commented Jun 19, 2017 • edited Loading

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017

zhul-pku left a comment

Choose a reason for hiding this comment

oscardssmith Jun 20, 2017

Choose a reason for hiding this comment

coveralls commented Jun 20, 2017

oscardssmith Jun 20, 2017

Choose a reason for hiding this comment

oscardssmith Jun 20, 2017

Choose a reason for hiding this comment

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017

coveralls commented Jun 20, 2017

pdurbin commented Jun 13, 2017 •

edited

Loading

oscardssmith commented Jun 19, 2017 •

edited

Loading