Permalink
Please sign in to comment.
Showing
with
176 additions
and 415 deletions.
- +14 −16 CONTRIBUTING.md
- +28 −0 Dockerfile
- +9 −7 LICENSE
- +125 −218 README.md
- +0 −60 Vagrantfile
- +0 −57 scripts/bootstrap.sh
- +0 −57 scripts/warcbase.sh
| @@ -1,55 +1,53 @@ | ||
| # Welcome! | ||
| If you are reading this document then you are interested in contributing to the warcbase or warcbase workshop project. All contributions are welcome: use-cases, documentation, code, patches, bug reports, feature requests, etc. You do not need to be a programmer to speak up! | ||
| If you are reading this document then you are interested in contributing The Archives Unleashed Project. All contributions are welcome: use-cases, documentation, code, ptatches, bug reports, feature requests, etc. You do not need to be a programmer to speak up! | ||
| ### Use cases | ||
| If you would like to submit a use case for the workshop, please submit and issue [here](https://github.com/web-archive-group/warcbase_workshop_vagrant/issues/new), assigning the "use case" label to the issue. | ||
| If you would like to submit a use case for docker-aut, please submit and issue [here](https://github.com/archivesunleashed/docker-aut/issues/new), and begin the issue title with "Use Case:". | ||
| ### Documentation | ||
| You can contribute documentation in two different ways. One way is to create an issue [here](https://github.com/web-archive-group/warcbase_workshop_vagrant/issues/new) assign the "documentation" label to the issue. | ||
| Or, you can fork and do a Pull Request. All documentation resides in the [`README`], and [`coursework`](https://github.com/web-archive-group/warcbase_workshop_vagrant/tree/master/coursework) directory. | ||
| You can contribute documentation in two different ways. One way is to create an issue [here](https://github.com/archivesunleashed/docker-aut/issues/new) and begin the issue title with "Documentation:". | ||
| ### Request a new feature | ||
| To request a new feature you should [open an issue](https://github.com/web-archive-group/warcbase_workshop_vagrant/issues/new) or create a use case as described above (see _use case_ section above), and summarize the desired functionality. Select the label "enhancement" if creating an issue on the project repo. | ||
| To request a new feature you should [open an issue](https://github.com/archivesunleashed/docker-aut/issues/new) or create a use case as described above (see _use case_ section above), and summarize the desired functionality. Begin the issue title with "Enhancement:". | ||
| ### Report a bug | ||
| To report a bug you should [open an issue](https://github.com/web-archive-group/warcbase_workshop_vagrant/issues/new) that summarizes the bug. Set the label to "bug". | ||
| To report a bug you should [open an issue](https://github.com/archivesunleashed/docker-aut/issues/new) that summarizes the bug. Set the label to "bug". | ||
| In order to help us understand and fix the bug it would be great if you could provide us with: | ||
| 1. The steps to reproduce the bug. This includes information about e.g. the version you were using, whether on a single node or cluster, etc. | ||
| 1. The steps to reproduce the bug. This includes information about e.g. docker-aut version you were using, whether on a single node or cluster, etc. | ||
| 2. The expected behavior. | ||
| 3. The actual, incorrect behavior. | ||
| Feel free to search the issue queue for existing issues (aka tickets) that already describe the problem; if there is such a ticket please add your information as a comment. | ||
| ### Contribute code | ||
| _If you are interested in contributing code to Warcbase but do not know where to begin:_ | ||
| _If you are interested in contributing code to docker-aut but do not know where to begin:_ | ||
| In this case you should [browse open issues](https://github.com/web-archive-group/warcbase_workshop_vagrant/issues), and or [use cases](https://github.com/web-archive-group/warcbase_workshop_vagrant/labels/use%20case). | ||
| In this case you should [browse open issues](https://github.com/archivesunleashed/docker-aut/issues). | ||
| Contributions to the Warcbase codebase should be sent as GitHub pull requests. See section _Create a pull request_ below for details. If there is any problem with the pull request we can work through it using the commenting features of GitHub. | ||
| Contributions to docker-aut codebase should be sent as GitHub pull requests. See section _Create a pull request_ below for details. If there is any problem with the pull request we can work through it using the commenting features of GitHub. | ||
| * For _small patches_, feel free to submit pull requests directly for those patches. | ||
| * For _larger code contributions_, please use the following process. The idea behind this process is to prevent any wasted work and catch design issues early on. | ||
| 1. [Open an issue](https://github.com/web-archive-group/warcbase_workshop_vagrant/issues) and assign it the label of "enhancement", if a similar issue does not exist already. If a similar issue does exist, then you may consider participating in the work on the existing issue. | ||
| 1. [Open an issue](https://github.com/archivesunleashed/docker-aut/issues), if a similar issue does not exist already. If a similar issue does exist, then you may consider participating in the work on the existing issue. | ||
| 2. Comment on the issue with your plan for implementing the issue. Explain what pieces of the codebase you are going to touch and how everything is going to fit together. | ||
| 3. Warcbase committers will work with you on the design to make sure you are on the right track. | ||
| 3. The docker-aut committers will work with you on the design to make sure you are on the right track. | ||
| 4. Implement your issue, create a pull request (see below), and iterate from there. | ||
| ### Create a pull request | ||
| Take a look at [Creating a pull request](https://help.github.com/articles/creating-a-pull-request). In a nutshell you need to: | ||
| 1. [Fork](https://help.github.com/articles/fork-a-repo) the warcbase GitHub repository at [https://github.com/web-archive-group/warcbase_workshop_vagrant](https://github.com/web-archive-group/warcbase_workshop_vagrant) to your personal GitHub account. | ||
| 1. [Fork](https://help.github.com/articles/fork-a-repo) docker-aut GitHub repository at [https://github.com/archivesunleashed/aut](https://github.com/archivesleashed/docker-aut) to your personal GitHub account. | ||
| 2. Commit any changes to your fork. | ||
| 3. Send a [pull request](https://help.github.com/articles/creating-a-pull-request) to the warcbase GitHub repository that you forked in step 1. If your pull request is related to an existing issue -- for instance, because you reported a [bug/issue](https://github.com/web-archive-group/warcbase_workshop_vagrant/issues) earlier -- prefix the title of your pull request with the corresponding issue number (e.g. `issue-123: ...`). Please also include a reference to the issue in the description of the pull. This can be done by using '#' plus the issue number like so '#123', also try to pick an appropriate name for the branch in which you're issuing the pull request from. | ||
| 3. Send a [pull request](https://help.github.com/articles/creating-a-pull-request) to docker-aut GitHub repository that you forked in step 1. If your pull request is related to an existing issue -- for instance, because you reported a [bug/issue](https://github.com/archivesunleashed/docker-aut/issues) earlier -- prefix the title of your pull request with the corresponding issue number (e.g. `issue-123: ...`). Please also include a reference to the issue in the description of the pull. This can be done by using '#' plus the issue number like so '#123', also try to pick an appropriate name for the branch in which you're issuing the pull request from. | ||
| You may want to read [Syncing a fork](https://help.github.com/articles/syncing-a-fork) for instructions on how to keep your fork up to date with the latest changes of the upstream (official) `warcbase_workshop_vagrant` repository. | ||
| You may want to read [Syncing a fork](https://help.github.com/articles/syncing-a-fork) for instructions on how to keep your fork up to date with the latest changes of the upstream (official) `aut` repository. |
| @@ -0,0 +1,28 @@ | ||
| FROM ubuntu:16.04 | ||
| LABEL maintainer="Nick Ruest <ruestn@gmail.com>" | ||
| LABEL description="Docker image for the Archives Unleashed Toolkit." | ||
| LABEL website="http://archivesunleashed.org/" | ||
| EXPOSE 9000 | ||
| EXPOSE 4040 | ||
| RUN apt-get update && apt-get install -y wget git tar ca-certificates openjdk-8-jdk openjdk-8-jdk-headless openjdk-8-jre \ | ||
| && sed -i '$iJAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64' /etc/environment \ | ||
| && export JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64 | ||
| RUN git clone https://github.com/archivesunleashed/aut-resources.git \ | ||
| && mkdir /aut /spark /notebook | ||
| RUN cd /aut && wget -q "http://central.maven.org/maven2/io/archivesunleashed/aut/0.9.0/aut-0.9.0-fatjar.jar" | ||
| RUN cd /tmp \ | ||
| && wget -q "https://s3.eu-central-1.amazonaws.com/spark-notebook/tgz/spark-notebook-0.7.0-pre2-scala-2.10.5-spark-1.6.2-hadoop-2.7.3.tgz" \ | ||
| && tar -xf "/tmp/spark-notebook-0.7.0-pre2-scala-2.10.5-spark-1.6.2-hadoop-2.7.3.tgz" -C /notebook --strip-components=1 \ | ||
| && rm "/tmp/spark-notebook-0.7.0-pre2-scala-2.10.5-spark-1.6.2-hadoop-2.7.3.tgz" \ | ||
| && cd /notebook && bin/spark-notebook -Dhttp.port=9000 -J-Xms1024m & | ||
| RUN cd /tmp \ | ||
| && wget -q "http://d3kbcqa49mib13.cloudfront.net/spark-1.6.1-bin-hadoop2.6.tgz" \ | ||
| && tar -xf "/tmp/spark-1.6.1-bin-hadoop2.6.tgz" -C /spark --strip-components=1 \ | ||
| && rm "/tmp/spark-1.6.1-bin-hadoop2.6.tgz" |
| @@ -1,9 +1,11 @@ | ||
| The MIT License (MIT) | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| Copyright (c) <2016> <Nick Ruest> | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: | ||
| The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. | ||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. |
Oops, something went wrong.
0 comments on commit
8062d5e