Publishing Data: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
m (add mentioning of labgroups + short description) |
||
| Line 3: | Line 3: | ||
== Best Practices == | == Best Practices == | ||
When publishing anything, the following are important to consider: | When publishing anything, the following are important to consider: | ||
* Be sure that any/all data is published via '''a faculty member's account''', not a student's (this is especially important when the data in question is meant to be permanent). This will reduce the chance of any broken links once the student leaves and their account is archived. | * Be sure that any/all data is published via '''a faculty member's account or a Labgroup''' (see below), not a student's (this is especially important when the data in question is meant to be permanent). This will reduce the chance of any broken links once the student leaves and their account is archived. | ||
* OBJ (see below) should be used whenever data or websites are published. | * OBJ (see below) should be used whenever data or websites are published. | ||
* Make sure UMIACS is credited on any papers that contain UMIACS URLs. | * Make sure UMIACS is credited on any papers that contain UMIACS URLs. | ||
== LabGroups == | |||
LabGroups allow for multiple users to upload data to a central shared location. This is especially useful if multiple people are contributing to a single project. To learn more about LabGroups, visit [https://obj.umiacs.umd.edu/obj/help The OBJ help page] for more information. | |||
== OBJ Usage == | == OBJ Usage == | ||
The use of the UMIACS Object Storage (otherwise known as OBJ) is the preferred method of publishing websites, data, and related info. Below are some short guides to publish websites and/or data on obj. | The use of the UMIACS Object Storage (otherwise known as OBJ) is the preferred method of publishing websites, data, and related info. Below are some short guides to publish websites and/or data on obj. | ||
===Uploading files/data=== | ===Uploading files/data=== | ||
# After [https://obj.umiacs.umd.edu/obj/buckets/ logging in to OBJ], select ''"Add Bucket"''. | # After [https://obj.umiacs.umd.edu/obj/buckets/ logging in to OBJ], select ''"Add Bucket"''. | ||
| Line 15: | Line 20: | ||
# In order to make any files publicly available, click the settings cog on the right side of the file, scroll down, and click "Make Key Public" | # In order to make any files publicly available, click the settings cog on the right side of the file, scroll down, and click "Make Key Public" | ||
#* Note that this makes this specific file available to anyone with the link. If you only wish to grant temporary access or access to a specific user, you may want to consider creating a timed download link or modifying the Access Control List at the bottom of the page. More information can be found on | #* Note that this makes this specific file available to anyone with the link. If you only wish to grant temporary access or access to a specific user, you may want to consider creating a timed download link or modifying the Access Control List at the bottom of the page. More information can be found on | ||
===Publishing Websites=== | ===Publishing Websites=== | ||
Generally, for publishing websites, you'll want to upload all your website files '''under one bucket'''. UMIACS recommends that you include an index.html file as well as a error file to be shown in case of a broken link (404). Once all these files are uploaded: | Generally, for publishing websites, you'll want to upload all your website files '''under one bucket'''. UMIACS recommends that you include an index.html file as well as a error file to be shown in case of a broken link (404). Once all these files are uploaded: | ||
| Line 22: | Line 28: | ||
#* Keep in mind that this will expose all data in your bucket. We recommend keeping any sensitive/access controlled data in a separate bucket. | #* Keep in mind that this will expose all data in your bucket. We recommend keeping any sensitive/access controlled data in a separate bucket. | ||
The website will be made public and can be reached using the link at the right side. In order to make the website non-public, simply click "Remove Website Configuration" and then "Make Private" in the above section. | The website will be made public and can be reached using the link at the right side. In order to make the website non-public, simply click "Remove Website Configuration" and then "Make Private" in the above section. | ||
---- | ---- | ||
'''In addition to the above, there are more ways to add data to obj which can be useful, especially if working with a lot of files. See [[OBJbox]] and [https://obj.umiacs.umd.edu/obj/help The OBJ help page] for more information.''' | '''In addition to the above, there are more ways to add data to obj which can be useful, especially if working with a lot of files. See [[OBJbox]] and [https://obj.umiacs.umd.edu/obj/help The OBJ help page] for more information.''' | ||
Revision as of 01:46, 19 May 2020
UMIACS offers viable methods of publishing data, including reports, papers, and more. This page serves as a guide to the best practices and guidelines when publishing a paper with UMIACS. It can also be used to store anything else that fits within your quota.
Best Practices
When publishing anything, the following are important to consider:
- Be sure that any/all data is published via a faculty member's account or a Labgroup (see below), not a student's (this is especially important when the data in question is meant to be permanent). This will reduce the chance of any broken links once the student leaves and their account is archived.
- OBJ (see below) should be used whenever data or websites are published.
- Make sure UMIACS is credited on any papers that contain UMIACS URLs.
LabGroups
LabGroups allow for multiple users to upload data to a central shared location. This is especially useful if multiple people are contributing to a single project. To learn more about LabGroups, visit The OBJ help page for more information.
OBJ Usage
The use of the UMIACS Object Storage (otherwise known as OBJ) is the preferred method of publishing websites, data, and related info. Below are some short guides to publish websites and/or data on obj.
Uploading files/data
- After logging in to OBJ, select "Add Bucket".
- A "bucket" is essentially a folder that stores files.
- Upload any datasets or other files that contain the data you wish to publish.
- For publishing websites, continue to the "Publishing Websites" section. For datasets and the like continue on.
- In order to make any files publicly available, click the settings cog on the right side of the file, scroll down, and click "Make Key Public"
- Note that this makes this specific file available to anyone with the link. If you only wish to grant temporary access or access to a specific user, you may want to consider creating a timed download link or modifying the Access Control List at the bottom of the page. More information can be found on
Publishing Websites
Generally, for publishing websites, you'll want to upload all your website files under one bucket. UMIACS recommends that you include an index.html file as well as a error file to be shown in case of a broken link (404). Once all these files are uploaded:
- In the bucket, click "bucket settings" at the top of the window.
- Under the "Website Hosting" section, put the name of your index file (usually just index.html) and the name of your 404 page.
- Press "Submit"
- Keep in mind that this will expose all data in your bucket. We recommend keeping any sensitive/access controlled data in a separate bucket.
The website will be made public and can be reached using the link at the right side. In order to make the website non-public, simply click "Remove Website Configuration" and then "Make Private" in the above section.
In addition to the above, there are more ways to add data to obj which can be useful, especially if working with a lot of files. See OBJbox and The OBJ help page for more information.