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

v4.7 #3955

Merged
merged 182 commits into from
Jun 23, 2017
Merged

v4.7 #3955

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
182 commits
Select commit Hold shift + click to select a range
a158ebf
DC identifier (persistent ID) to dataset landing page
pameyer May 11, 2017
331832a
a few more DC terms
pameyer May 11, 2017
e925b3f
now with dataset authors
pameyer May 11, 2017
0b69048
use root dataverse name as DC.publisher
pameyer May 11, 2017
66438cf
remove 'work-in-progress' comment
pameyer May 11, 2017
5b10732
return empty string for DC publication date in meta tags for DRAFT da…
pameyer May 17, 2017
ba0b730
#3639 Add customization hooks
sekmiller May 22, 2017
7c00974
#3639 Fix Style hook
sekmiller May 22, 2017
970dce3
Moved custom content resourceInclude for homePage and style. Added ne…
mheppler May 22, 2017
3657ea7
#3639 have dataverse redirect go to dataverse_homepage
sekmiller May 22, 2017
46d147e
3637 - about url setting
raprasad May 23, 2017
826b6b6
Allow download of rsync scripts from Data Capture Module (DCM) #3725
pdurbin May 23, 2017
02824f9
Added alt. guides link to settings. #3637
raprasad May 23, 2017
c8ef8bb
change from "RSYNC" to "dcm/rsync+ssh" #3725
pdurbin May 23, 2017
ede3050
update to use settingswrapper by passing a key #3637
raprasad May 24, 2017
7c79b14
#3637 updates to use the settingsWrapper rather than make extra queri…
raprasad May 24, 2017
de9f861
remove debug line used for query counting #3637
raprasad May 24, 2017
22ea587
#3637 - remove debug line used for guides setting
raprasad May 24, 2017
8d18320
Merge branch 'develop' into 3725-download-rsync-script #3725
pdurbin May 24, 2017
da2cda4
make table of contents consistent #3796
pdurbin May 24, 2017
e102835
indicate that we are running rsync over ssh #3725
pdurbin May 24, 2017
f93b56f
#3637, function to change where the About link has no default
raprasad May 24, 2017
5709da3
Added looks for dataverse logo file #3639
raprasad May 24, 2017
1a0b859
Removed the Harvard text/links out of the footer. [ref #3639]
mheppler May 24, 2017
d35abbc
Merge branch 'develop' into 3639-homepage-customization
sekmiller May 24, 2017
fabc190
Merge remote-tracking branch 'origin/3639-homepage-customization' int…
sekmiller May 24, 2017
cccde5d
fix pretty faces
sekmiller May 25, 2017
4df9336
have CreateDatasetCommand call ur.py, more tests #3725
pdurbin May 25, 2017
a008707
Labeled and repositions ToCs, etc [ref: #3796]
dlmurphy May 25, 2017
c0495bb
Merge branch 'develop' into 3725-download-rsync-script #3725
pdurbin May 26, 2017
dbca26f
Merge branch 'develop' into 3796-guides-table-of-contents #3796
pdurbin May 26, 2017
2739c72
use `|toctitle|` as variable from rst_prolog #3796
pdurbin May 26, 2017
3f6f430
Typo fixes
dlmurphy May 26, 2017
4126ad1
return more helpful message when DCM is broken #3725
pdurbin May 30, 2017
85952cb
better automated tests and error handling #3725
pdurbin May 30, 2017
967c127
consolidate duplicate code #3725
pdurbin May 30, 2017
be42fa5
Changed navbar to only display one "User Guide" link. Removed additio…
mheppler May 30, 2017
087f876
consolidate upload and script request path definitions #3725
pdurbin May 30, 2017
e2b5570
remove 'NavbarGuidesUrl' setting. #3637
raprasad May 31, 2017
32a90dd
Merge remote-tracking branch 'origin/develop' into 3637-navbar
raprasad May 31, 2017
ee15fd9
Merge branch 'develop' into 3639-homepage-customization
sekmiller May 31, 2017
d31fb88
Merge branch 'develop' into 3725-download-rsync-script #3725
pdurbin Jun 1, 2017
b5afaae
Merge branch 'develop' into 3639-homepage-customization
sekmiller Jun 1, 2017
7d99a86
#3639 Add Homepage Servlet for customization
sekmiller Jun 1, 2017
24cef17
#3639 Homepage Servlet now forwards to hide url from user
sekmiller Jun 1, 2017
1b763c6
Merge branch 'develop' into 3637-navbar #3637
pdurbin Jun 2, 2017
6375f9e
remove " Dataverse", suggest in watermark on create #3611
pdurbin Jun 2, 2017
e855b8a
optionally, append " Dataverse" to name in dataverse table #3611
pdurbin Jun 2, 2017
a517e18
Merge branch 'develop' into 3611-custom-dv-names #3611
pdurbin Jun 2, 2017
f0ddb6e
Added custom content logo to navbar with render logic, plus revisions…
mheppler Jun 2, 2017
426cf45
Updated CONTRIBUTING.md in an attempt to appeal to inexperienced cont…
HedgeMage Jun 4, 2017
a9c6e80
#3639 - change graphic image link reference to url
sekmiller Jun 5, 2017
bd3cd09
Small edits to phrasing [ref: #3882]
dlmurphy Jun 5, 2017
d3b53c9
Removed "Dataverse" as part of a dataverse name in page title, help t…
mheppler Jun 5, 2017
f9cdceb
Merge pull request #3882 from HedgeMage/develop
kcondon Jun 5, 2017
29ed4d9
provide branding starting point files, make unix-y #3639
pdurbin Jun 5, 2017
7cffad4
Merge branch 'develop' into 3639-homepage-customization #3639
pdurbin Jun 5, 2017
bbc3945
Edited tooltip for "Dataverse" label [ref: #3863]
jggautier Jun 5, 2017
a470903
Merge branch 'develop' into 3725-download-rsync-script #3725
pdurbin Jun 5, 2017
4a34447
Merge pull request #3854 from IQSS/3796-guides-table-of-contents
kcondon Jun 5, 2017
5480888
Merge branch 'develop' into 3637-navbar
mheppler Jun 5, 2017
9b9c332
Merge branch 'develop' into 3725-download-rsync-script #3725
pdurbin Jun 6, 2017
89f21ac
document nicer DOI form of API endpoint #3725
pdurbin Jun 6, 2017
de03d5e
require edit permission on dataset (more strict) #3725
pdurbin Jun 6, 2017
b3d7ab6
Merge branch 'develop' into 3863-edit-dataverse-tooltip
mheppler Jun 6, 2017
44572fd
clarify that the rsync script is downloaded from Dataverse #3725
pdurbin Jun 6, 2017
681d1d0
Updated testing documentation page with actual guide documentation; u…
bsilverstein95 Jun 6, 2017
dd39e8a
Merge pull request #3851 from IQSS/3725-download-rsync-script
kcondon Jun 6, 2017
77214a5
get tests passing, dynamic support team #3611 #2710
pdurbin Jun 6, 2017
ce77fa2
Merge branch 'develop' into 3611-custom-dv-names #3611
pdurbin Jun 6, 2017
b8a8c1a
email now "welcome to LibraScholar" or whatever #3611 #2710
pdurbin Jun 7, 2017
585ec73
use installation brand name in email closing #3611 #2710
pdurbin Jun 7, 2017
7de7e5a
Merge pull request #3867 from IQSS/3637-navbar
kcondon Jun 7, 2017
8d4ebdf
add brand to email subject on account create #3611 #2710
pdurbin Jun 7, 2017
52ada78
just use the existing "Support" bundle key #3611 #2710
pdurbin Jun 7, 2017
e8fdd34
make email subjects testable with junit #3611 #2710
pdurbin Jun 7, 2017
4550e4d
make "create dataverse" email subject dynamic #3611 #2710
pdurbin Jun 7, 2017
66cb841
Merge pull request #3885 from IQSS/3863-edit-dataverse-tooltip
kcondon Jun 7, 2017
9de44bb
Merge remote-tracking branch 'refs/remotes/origin/develop' into 3431-…
dlmurphy Jun 7, 2017
8aaed4f
Fixing merge conflict [ref: #3431]
dlmurphy Jun 7, 2017
599c6a3
use custom support team name rather than "Support" #3611 #2710
pdurbin Jun 7, 2017
4aa8141
Changed "Branching Strategy" page to "Version Control" [Ref: #3431]
dlmurphy Jun 7, 2017
55e5053
make rest of email subject dynamic, using branding #3611 #2710
pdurbin Jun 8, 2017
c349f1b
Merge branch 'develop' into 3611-custom-dv-names #3611
pdurbin Jun 8, 2017
2efebf2
document how :SystemEmail is the way to brand your support team #3611
pdurbin Jun 8, 2017
271137d
finish converting branching-strategy.rst into version-control.rst #3431
pdurbin Jun 8, 2017
3c0c538
must build war before running installer #3431
pdurbin Jun 8, 2017
eec5a2e
remove cases of "Dataverse Support" #3611 #2710
pdurbin Jun 8, 2017
e32b9de
explain context-root problem and solution #3431
pdurbin Jun 9, 2017
1f66efb
Added meta tags for subject, description.
oscardssmith Jun 9, 2017
bd1496b
Added sample code to the sample files, plus documentation to Branding…
mheppler Jun 9, 2017
05d54dc
Merge branch 'develop' into 3639-homepage-customization
mheppler Jun 9, 2017
203f229
Sample files for Branding section of Installation Guide. [ref #3639]
mheppler Jun 9, 2017
9ffc6b5
fixed bundle; added tests for email subjects
bsilverstein95 Jun 9, 2017
e7844fd
Slight refactoring
oscardssmith Jun 9, 2017
1831c83
fixed nesting of Date/Time from line 69 to 70
bsilverstein95 Jun 9, 2017
269301a
reword version control page #3431
pdurbin Jun 9, 2017
df87f96
Lots of angle bracket fixes, code formatting
oscardssmith Jun 9, 2017
8e49760
Typo
oscardssmith Jun 9, 2017
ea27760
Doc fixes [ref: #3639]
dlmurphy Jun 9, 2017
2220912
Version Control page review [Ref: #3431]
dlmurphy Jun 9, 2017
682452c
fix a typo, a couple tweaks #3431
pdurbin Jun 12, 2017
9e13026
Fixed a problem with broken HTML tags.
oscardssmith Jun 12, 2017
e18b233
Minor stuff to reduce the diff from main, removes some unused commits…
oscardssmith Jun 12, 2017
5b57bec
rewrite of testing page #3431
pdurbin Jun 12, 2017
4f131f0
dataverse name initial text should be real, not watermark #3611
pdurbin Jun 12, 2017
02e5545
Merge pull request #3880 from IQSS/3611-custom-dv-names
kcondon Jun 12, 2017
7a90c98
Merge branch 'develop' into 1393_exp_dcmeta
oscardssmith Jun 12, 2017
a47b0c2
Proofread of Testing and Dev Environment pages [ref: #3431]
dlmurphy Jun 12, 2017
df7089a
Merge branch 'develop' into 3639-homepage-customization #3639
pdurbin Jun 13, 2017
e752ba8
add branding of installation and support team #3639
pdurbin Jun 13, 2017
07f4a58
Merge pull request #3828 from IQSS/1393_exp_dcmeta
kcondon Jun 13, 2017
f800e2d
don't send notification when creating dataverseAdmin user #3894
pdurbin Jun 13, 2017
51ecfd9
Typo fix [ref: #3431]
dlmurphy Jun 13, 2017
e28b927
Merge pull request #3895 from IQSS/3894-setup
kcondon Jun 13, 2017
a37d9df
Merge branch 'develop' into 3639-homepage-customization #3639
pdurbin Jun 13, 2017
30a7e53
don't expect "Dataverse" in name/brand in test #3897
pdurbin Jun 13, 2017
3f2ac33
#3639 Fix Search re-direct
sekmiller Jun 14, 2017
804b76a
doc json for creating built-in users
pameyer Jun 14, 2017
4186cb6
Glassfish link fix
dlmurphy Jun 14, 2017
e903302
Merge pull request #3901 from IQSS/Devguide-Glassfish-URL-fix
dlmurphy Jun 14, 2017
24340e9
fix glassfish link, smtp trouble, non-interactive mode #3431
pdurbin Jun 14, 2017
bb2c681
typo fixes for account page
acme146 Jun 14, 2017
392bcbb
#3639 Remove Show File Landing Page setting
sekmiller Jun 14, 2017
d0bf813
Fixed example formatting [ref: #3192]
dlmurphy Jun 14, 2017
fee111c
typo fixes dataset management and files
acme146 Jun 14, 2017
b91568e
typo fix dataverse-management
acme146 Jun 14, 2017
9bdfcbf
typo fixes tworavens
acme146 Jun 14, 2017
fa0e08c
typo fixes worldmap
acme146 Jun 14, 2017
9c76530
1551-Make Use of RedirectPage Logic
Jun 14, 2017
89bf11b
Moved dataset version message text to bundle. [ref #1953]
mheppler Jun 14, 2017
a650c61
typo fixes csv
acme146 Jun 14, 2017
f4f0feb
mention dos2unix is needed on Windows for Vagrant #3431
pdurbin Jun 14, 2017
f5c5a4f
note dataverse-client-r is available on CRAN
leeper Jun 15, 2017
9cac032
move API key language to API guide index page
leeper Jun 15, 2017
ca1b41b
update sword api client list
leeper Jun 15, 2017
337e6e9
tweak search API documentation
leeper Jun 15, 2017
2b01a60
update formatting of SWORD API docs curl examples
leeper Jun 15, 2017
f690ded
Merge branch 'develop' into 3431-dev-guide #3431
pdurbin Jun 15, 2017
2f43b35
mention read-only team and spreadsheet of contributors #3431
pdurbin Jun 16, 2017
f7e1b71
Comment explaining stuff
oscardssmith Jun 19, 2017
1378d44
Merge branch 'develop' into 3639-homepage-customization #3639
pdurbin Jun 19, 2017
c05ae5e
how to delete db settings, logo size, homepage alias tip #3639
pdurbin Jun 19, 2017
7076bdc
Changed formatting of Issue Number and Title
dlmurphy Jun 19, 2017
55ffe3e
Merge branch 'develop' into 3192-docuser #3192
pdurbin Jun 19, 2017
bffb3fe
made JSON example downloadable and improve wording #3192
pdurbin Jun 19, 2017
a7242a9
Typo fix #3639
dlmurphy Jun 19, 2017
f88b0ef
Merge remote-tracking branch 'leeper/master' into 3918-api-guide #3918
pdurbin Jun 19, 2017
e57525d
Proofreading the Proofread #3916
dlmurphy Jun 19, 2017
8d131af
wordung changes
oscardssmith Jun 19, 2017
c4cb1a8
improve index page of API Guide #3918
pdurbin Jun 19, 2017
a9561b5
various tweaks #3918
pdurbin Jun 19, 2017
28d50a9
move index content to intro to match dev and install guides #3918
pdurbin Jun 19, 2017
307794a
Removed ShowFileLandingPage setting logic from search-include (again)…
mheppler Jun 19, 2017
fa95e12
mention asadmin deployment in dev guide #3907
pdurbin Jun 20, 2017
06bd186
add previous and next links to dev guide #2163
pdurbin Jun 20, 2017
a299f8a
add section on testing commands #3431 #1797
pdurbin Jun 20, 2017
dccd9b0
add deploying manually section from @pameyer #3907
pdurbin Jun 20, 2017
6535d9d
improve coding style page in dev guide #3418 #2724 #2644 #2575 #2574
pdurbin Jun 20, 2017
6c7e016
Merge pull request #3889 from IQSS/3639-homepage-customization
kcondon Jun 20, 2017
566ce32
Proofreading fixes #3918
dlmurphy Jun 20, 2017
071a6bd
fix broken links to datascience.iq (deceased) #3431
pdurbin Jun 20, 2017
f7a9337
Proofread fixes for #3418
dlmurphy Jun 20, 2017
ec23367
Merge branch 'develop' into 1551-shib-redirect #1551
pdurbin Jun 20, 2017
b5a4ed1
improve readme #3729
pdurbin Jun 20, 2017
7dbb863
finsh changing "master" to "develop" in readme #3729
pdurbin Jun 20, 2017
75d8bba
Merge pull request #3929 from IQSS/1551-shib-redirect
kcondon Jun 20, 2017
7e9a8d9
we don't assign new issues anymore, link version control page #3729
pdurbin Jun 20, 2017
db03e1d
asadmin syntax for disabling glassfish analytics
pameyer Jun 20, 2017
6f2afd1
Merge pull request #3892 from IQSS/3431-dev-guide
kcondon Jun 20, 2017
d7ed17e
Merge pull request #3917 from IQSS/doc_proofread
kcondon Jun 20, 2017
df1d2ba
Merge pull request #3920 from IQSS/3918-api-guide
kcondon Jun 20, 2017
76d9fd3
Merge pull request #3898 from IQSS/3897-title-test-brand
kcondon Jun 20, 2017
9708f57
Merge pull request #3909 from IQSS/1953-ds-version-msg-bundle
kcondon Jun 20, 2017
8ee962e
add installation brand name to subject of verify email message #3941
pdurbin Jun 21, 2017
5b75860
finish FIXME comment about CONFIRMEMAIL #3941
pdurbin Jun 21, 2017
2fb082a
bump versions from 4.6.2 to 4.7
ferrys Jun 21, 2017
70a41b4
Merge pull request #3945 from IQSS/3941-verify-email-branding
kcondon Jun 21, 2017
91b6526
small Sphinx fixes
ferrys Jun 21, 2017
ed32206
Merge pull request #3948 from IQSS/3947-update-version
kcondon Jun 22, 2017
8e9ccce
A one line fix for #3952, properly preserving the original type of an…
landreev Jun 23, 2017
7f4309b
Merge pull request #3954 from IQSS/3952-fix-original-type
kcondon Jun 23, 2017
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
13 changes: 7 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Contributing to Dataverse

Thank you for your interest in contributing to Dataverse! We welcome contributions of ideas, bug reports, usability testing, documentation, code, and more!
Thank you for your interest in contributing to Dataverse! We are open to contributions from everyone. You don't need permission to participate, just jump in using the resources below. If you have questions, reach out to us on the [#dataverse IRC channel][], and hang around a while, as it may take time for community members to de-idle.

We aren't just looking for developers, there are many ways to contribute to Dataverse. We welcome contributions of ideas, bug reports, usability research/feedback, documentation, code, and more!

## Ideas/Feature Requests

Expand All @@ -26,7 +28,7 @@ An issue is a bug (a feature is no longer behaving the way it should) or a featu

Before submitting an issue, please search the existing issues by using the search bar at the top of the page. If there is an existing issue that matches the issue you want to report, please add a comment to it.

If there is no pre-existing issue, please click on the "New Issue" button, log in, and write in what the issue is (unless it is a security issue which should be reported privately to security@dataverse.org). Someone on the Dataverse development team will appropriately tag and assign it to a member of the Dataverse development team.
If there is no pre-existing issue, please click on the "New Issue" button, log in, and write in what the issue is (unless it is a security issue which should be reported privately to security@dataverse.org).

If you do not receive a reply to your new issue or comment in a timely manner, please email support@dataverse.org with a link to the issue.

Expand All @@ -51,12 +53,11 @@ The source for the documentation at http://guides.dataverse.org is in the GitHub

Before you start coding, please reach out to us either on the [dataverse-community Google Group][], the [dataverse-dev Google Group][], [IRC][] (#dataverse on freenode), or via support@dataverse.org to make sure the effort is well coordinated and we avoid merge conflicts.

We will encourage you to create a GitHub issue (if it doesn't exist already) to associate with your pull request.

We hope you find the Developer Guide at http://guides.dataverse.org/en/latest/developers helpful.
Please read http://guides.dataverse.org/en/latest/developers/version-control.html to understand how we use the "git flow" model of development and how we will encourage you to create a GitHub issue (if it doesn't exist already) to associate with your pull request.

After making your pull request, your goal should be to help it advance through our kanban board at https://waffle.io/IQSS/dataverse . If no one has moved your pull request to the code review column in a timely manner, please reach out. Thanks!
After making your pull request, your goal should be to help it advance through our kanban board at https://waffle.io/IQSS/dataverse . If no one has moved your pull request to the code review column in a timely manner, please reach out. We maintain a list of [community contributors][] so please let us know if you'd like to be added or removed from the list. Thanks!

[dataverse-community Google Group]: https://groups.google.com/group/dataverse-community
[dataverse-dev Google Group]: https://groups.google.com/group/dataverse-dev
[IRC]: http://chat.dataverse.org
[community contributors]: https://docs.google.com/spreadsheets/d/1o9DD-MQ0WkrYaEFTD5rF_NtyL8aUISgURsAXSL7Budk/edit?usp=sharing
2 changes: 1 addition & 1 deletion PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Welcome! New contributors should at least glance at [CONTRIBUTING.md](/CONTRIBUT

## Related Issues

- connects to [#issue number]: [issue title]
- connects to #ISSUE_NUMBER: ISSUE_TITLE

## Pull Request Checklist

Expand Down
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,36 @@
Dataverse®
===============

Dataverse is an open source web application for sharing, citing, analyzing, and preserving research data (developed by the [Data Science and Products team](http://www.iq.harvard.edu/people/people/data-science-products) at the [Institute for Quantitative Social Science](http://iq.harvard.edu/)).
Dataverse is an [open source][] web application for sharing, citing, analyzing, and preserving research data (developed by the [Data Science and Products team](http://www.iq.harvard.edu/people/people/data-science-products) at the [Institute for Quantitative Social Science](http://iq.harvard.edu/) and the [Dataverse community][]).

Institutions and organizations can choose to install the Dataverse software for their own use.
In this case, the institution will be responsible for maintaining the application; installing upgrades,
setting up backups and data replication as needed. Dataverse 4.0 is now released and used by the Harvard Dataverse: [dataverse.harvard.edu](http://dataverse.harvard.edu/). If you'd like to first test it, you can use our demo site: [demo.dataverse.org](http://demo.dataverse.org).
[dataverse.org][] is our home on the web and shows a map of Dataverse installations around the world, a list of [features][], [integrations][] that have been made possible through [REST APIs][], our development [roadmap][], and more.

For more general information about Dataverse please visit [dataverse.org](http://dataverse.org).
We maintain a demo site at [demo.dataverse.org][] which you are welcome to use for testing and evaluating Dataverse.

The Dataverse code is *open-source* and *free*.
To install Dataverse, please see our [Installation Guide][] which will prompt you to download our [latest release][].

Dataverse releases are available for download from https://github.com/IQSS/dataverse/releases and installation instructions can be found in the [Installation Guide](http://guides.dataverse.org/en/latest/installation/).
To discuss Dataverse with the community, please join our [mailing list][], participate in a [community call][], chat with us at [chat.dataverse.org][], or attend our annual [Dataverse Community Meeting][].

We love contributors! Please see our [Contributing Guide][] for ways you can help.

Dataverse is a trademark of President and Fellows of Harvard College and is registered in the United States.

[![Dataverse Project logo](src/main/webapp/resources/images/dataverseproject_logo.jpg?raw=true "Dataverse Project")](http://dataverse.org)

[![Build Status](https://travis-ci.org/IQSS/dataverse.svg?branch=master)](https://travis-ci.org/IQSS/dataverse) [![Coverage Status](https://coveralls.io/repos/IQSS/dataverse/badge.svg?branch=master&service=github)](https://coveralls.io/github/IQSS/dataverse?branch=master)
[![Build Status](https://travis-ci.org/IQSS/dataverse.svg?branch=develop)](https://travis-ci.org/IQSS/dataverse) [![Coverage Status](https://coveralls.io/repos/IQSS/dataverse/badge.svg?branch=develop&service=github)](https://coveralls.io/github/IQSS/dataverse?branch=develop)

[dataverse.org]: https://dataverse.org
[demo.dataverse.org]: https://demo.dataverse.org
[Dataverse community]: https://dataverse.org/developers
[Installation Guide]: http://guides.dataverse.org/en/latest/installation/index.html
[latest release]: https://github.com/IQSS/dataverse/releases
[features]: https://dataverse.org/software-features
[roadmap]: https://dataverse.org/goals-roadmap-and-releases
[integrations]: https://dataverse.org/integrations
[REST APIs]: http://guides.dataverse.org/en/latest/api/index.html
[Contributing Guide]: CONTRIBUTING.md
[mailing list]: https://groups.google.com/group/dataverse-community
[community call]: https://dataverse.org/community-calls
[chat.dataverse.org]: http://chat.dataverse.org
[Dataverse Community Meeting]: https://dataverse.org/events
[open source]: LICENSE.md
8 changes: 8 additions & 0 deletions doc/sphinx-guides/source/_static/api/user-add.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"firstName": "Lisa",
"lastName": "Simpson",
"userName": "lsimpson",
"affiliation": "Springfield",
"position": "Student",
"email": "lsimpson@mailinator.com"
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
<style>
/* NOTE: You can use the custom CSS configuration to move this CSS your own stylesheet. */

/* Overwrite default footer styles to make room at the bottom of the browser page for our custom footer... */
html, body {
height: 100%;
}
#content.container {
min-height: calc(100% - 210px);
margin-bottom: -142px;
}
#content.container:after {
content: "";
display: block;
}
#footer {
color: #a9a9a9; margin-top:0px; padding-bottom:0px; bottom:-150px; position: relative;
}

/* Place custom footer just above default footer at the bottom of the page... */
#custom-footer, #content.container:after {
height: 142px;
}
#custom-footer {
background: #414141; color: #a9a9a9; min-height: 100px; padding: 1.25em 0 100px 0;
}
#custom-footer a {
color: #fff;
}
</style>
<div id="custom-footer">
<div class="container">
<p>SAMPLE FOOTER TEXT</p>
<p class="small">
<a href="https://dataverse.org" title="SAMPLE LINK" target="_blank">SAMPLE LINK</a>
</p>
</div>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<style>
/* NOTE: You can use the custom CSS configuration to move this CSS your own stylesheet... */

/* Overwrite default navbar styles to make room at the top of the browser page for our custom header... */
.navbar-fixed-top {
top:50px !important;
}
#dataverse-header-block {
padding-top: 150px;
}

/* Place narrow custom header at the top of the page... */
#custom-header {
background: #414141;
min-height: 44px;
position: fixed;
right: 0;
left: 0;
z-index: 930;
padding-top: 8px;
}
#custom-header a.cst-hdr-link {
line-height: 32px;
color: #BAC5C6;
font-weight: bold;
}
</style>
<div id="custom-header">
<div class="container">
<p class="text-right">
<a class="pull-left" href="https://dataverse.org" title="SAMPLE IMAGE LINK" target="_blank"><img src="/var/www/dataverse/branding/sample.png" alt="SAMPLE IMAGE"/></a>
<a class="cst-hdr-link" href="https://dataverse.org" title="SAMPLE HEADER LINK" target="_blank">SAMPLE HEADER LINK</a>
</p>
</div>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@

<style>
/* NOTE: You can use the custom CSS configuration to move this CSS your own stylesheet... */

/* Custom CSS for the custom homepage... */
div.jumbotron h1 {color:#C55B28;}
</style>

<div class="jumbotron">
<h1>Hello, world!</h1>
<p>Welcome to our Dataverse.</p>
<p><a class="btn btn-primary btn-lg" href="/dataverse/root" role="button">Browse Data</a></p>
</div>
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
/* Add any CSS necessary for your custom content */

.navbar-default {
background-color: gold;
background-image: none;
}
5 changes: 3 additions & 2 deletions doc/sphinx-guides/source/admin/geoconnect-worldmap.rst
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
Geoconnect and WorldMap
=======================

.. contents:: :local:

One of the optional components listed under "Architecture and Components" in the :doc:`/installation/prep` section of the Installation Guide is `Geoconnect <https://github.com/IQSS/geoconnect>`_, a piece of middleware that allows Dataverse users to create maps in `WorldMap <http://worldmap.harvard.edu>`_ based on geospatial data stored in Dataverse. For more details on the feature from the user perspective, see the :doc:`/user/data-exploration/worldmap` section of the User Guide.

.. contents:: |toctitle|
:local:

Update "mapitlink"
------------------

Expand Down
5 changes: 3 additions & 2 deletions doc/sphinx-guides/source/admin/harvestclients.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
Managing Harvesting Clients
===========================

.. contents:: :local:

.. contents:: |toctitle|
:local:

Your Dataverse as a Metadata Harvester
--------------------------------------

Expand Down
3 changes: 2 additions & 1 deletion doc/sphinx-guides/source/admin/harvestserver.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Managing Harvesting Server and Sets
===================================

.. contents:: :local:
.. contents:: |toctitle|
:local:

Your Dataverse as an OAI server
-------------------------------
Expand Down
2 changes: 1 addition & 1 deletion doc/sphinx-guides/source/admin/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This guide documents the functionality only available to the Dataverse Admin ("N

These "superuser" tasks are managed via the new page called the Dashboard. A user logged in as a Dataverse Admin will see the Dashboard link rendered in the upper right corner of every Dataverse page.

Contents:
**Contents:**

.. toctree::

Expand Down
3 changes: 2 additions & 1 deletion doc/sphinx-guides/source/admin/metadataexport.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
Metadata Export
===============

.. contents:: :local:
.. contents:: |toctitle|
:local:

Automatic Exports
-----------------
Expand Down
4 changes: 2 additions & 2 deletions doc/sphinx-guides/source/admin/timers.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
Dataverse Application Timers
============================

.. contents:: :local:

Dataverse uses timers to automatically run scheduled Harvest and Metadata export jobs.

.. contents:: |toctitle|
:local:

Dedicated timer server in a Dataverse server cluster
----------------------------------------------------
Expand Down
5 changes: 3 additions & 2 deletions doc/sphinx-guides/source/admin/troubleshooting.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,11 @@
Troubleshooting
===============

.. contents:: :local:

This new (as of v.4.6) section of the Admin guide is for tips on how to diagnose and fix system problems.

.. contents:: |toctitle|
:local:

Deployment fails, "EJB Timer Service not available"
---------------------------------------------------

Expand Down
3 changes: 2 additions & 1 deletion doc/sphinx-guides/source/api/apps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@ The introduction of Dataverse APIs has fostered the development of apps that are

The apps below are open source, demonstrating how to use Dataverse APIs. Some of these apps (and others) are built on :doc:`/api/client-libraries` that are available for Dataverse APIs.

.. contents:: :local:
.. contents:: |toctitle|
:local:

Javascript
----------
Expand Down
5 changes: 4 additions & 1 deletion doc/sphinx-guides/source/api/client-libraries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ Currently there are client libraries for Python, R, and Java that can be used to

Because Dataverse is a SWORD server, additional client libraries exist for Java, Ruby, and PHP per the :doc:`/api/sword` page.

.. contents:: |toctitle|
:local:

Python
------

Expand All @@ -15,7 +18,7 @@ https://github.com/IQSS/dataverse-client-python is the offical Python package fo
R
-

https://github.com/IQSS/dataverse-client-r is the official R package for Dataverse APIs.
https://github.com/IQSS/dataverse-client-r is the official R package for Dataverse APIs. The latest release can be installed from `CRAN <https://cran.r-project.org/package=dataverse>`_.

It was created by `Thomas Leeper <http://thomasleeper.com>`_ whose dataverse can be found at https://dataverse.harvard.edu/dataverse/leeper

Expand Down
5 changes: 2 additions & 3 deletions doc/sphinx-guides/source/api/dataaccess.rst
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
Data Access API
===============

.. contents:: :local:


The Data Access API provides programmatic download access to the files stored under Dataverse.
More advanced features of the Access API include format-specific transformations (thumbnail generation/resizing for images; converting tabular data into alternative file formats) and access to the data-level metadata that describes the contents of the tabular files.

.. contents:: |toctitle|
:local:

Basic File Access
-----------------
Expand Down
12 changes: 2 additions & 10 deletions doc/sphinx-guides/source/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,11 @@
API Guide
=========

We encourage anyone interested in building tools to
interoperate with the Dataverse to utilize our
APIs. In 4.0, we require to get a token, by simply registering for a Dataverse account, before using our APIs
(We are considering making some of the APIs completely public in the future - no token required - if you use it only a few times).

Rather than using a production installation of Dataverse, API users are welcome to use http://demo.dataverse.org for testing.

Please note that the APIs in this guide are shipped with the Dataverse software itself but additional APIs are available if you install the "miniverse" application from https://github.com/IQSS/miniverse and give it read only access to your production Dataverse database. http://dataverse.org/metrics is powered by miniverse.

Contents:
**Contents:**

.. toctree::

intro
sword
search
dataaccess
Expand Down
56 changes: 56 additions & 0 deletions doc/sphinx-guides/source/api/intro.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
Introduction
============

We encourage anyone interested in building tools that interoperate with Dataverse to utilize our APIs. The Dataverse community has supplied :doc:`client-libraries` for Python, R, and Java and we are always interested in helping the community develop libraries for additional languages. The :doc:`apps` section links to open source Javascript, PHP, Python, and Java code that you can learn from while developing against Dataverse APIs.

.. contents:: |toctitle|
:local:

How This Guide is Organized
---------------------------

We document the Dataverse API in four sections:

- :doc:`sword`: For depositing data using a standards-based approach rather than the :doc:`native-api`.
- :doc:`search`: For searching dataverses, datasets, and files.
- :doc:`dataaccess`: For downloading and subsetting data.
- :doc:`native-api`: For performing most tasks that are possible in the GUI.

We use the term "native" to mean that the API is not based on any standard. For this reason, the :doc:`search` and :doc:`dataaccess` could also be considered "native" and in the future we may reorganize the API Guide to split the :doc:`native-api` section into "Datasets API", "Files" API, etc.

Authentication
--------------

Most Dataverse APIs require the use of an API token. Instructions for getting a token are described in the :doc:`/user/account` section of the User Guide.

There are two ways to pass your API token to Dataverse APIs. The preferred method is to send the token in the ``X-Dataverse-key`` HTTP header, as in the following curl example::

curl -H "X-Dataverse-key: 8b955f87-e49a-4462-945c-67d32e391e7e" https://demo.dataverse.org/api/datasets/:persistentId?persistentId=doi:TEST/12345

Throughout this guide you will often see Bash shell envionmental variables being used, like this::

export API_TOKEN='8b955f87-e49a-4462-945c-67d32e391e7e'
curl -H "X-Dataverse-key: $API_TOKEN" https://demo.dataverse.org/api/datasets/:persistentId?persistentId=doi:TEST/12345

The second way to pass your API token is via an extra query parameter called ``key`` in the URL like this::

curl "https://demo.dataverse.org/api/datasets/:persistentId?persistentId=doi:TEST/12345&key=$API_TOKEN"

Use of the ``X-Dataverse-key`` HTTP header form is preferred because putting the query parameters in URLs often results in them finding their way into web server access logs. Your API token should be kept as secret as your password because it can be used to perform any action *as you* in the Dataverse application.

Testing
-------

Rather than using a production installation of Dataverse, API users are welcome to use http://demo.dataverse.org for testing.

Support
-------

If you are using the APIs for an installation of Dataverse hosted by your institution, you may want to reach out to the team that supports it. At the top of the Dataverse installation's home page, there should be a form you can fill out by clicking the "Support" link.

If you are having trouble with http://demo.dataverse.org or have questions about the APIs, please feel free to reach out to the Dataverse community via https://groups.google.com/forum/#!forum/dataverse-community .

Metrics
-------

APIs described in this guide are shipped with the Dataverse software itself. Additional APIs are available if someone at your institution installs the "miniverse" application from https://github.com/IQSS/miniverse and gives it read only access to a production Dataverse database. http://dataverse.org/metrics is powered by miniverse.