Skip to content

Commit

Permalink
Merge pull request #411 from metabrainz/update-dataset-text
Browse files Browse the repository at this point in the history 
Improve text according to aerozols's improvements
  • Loading branch information
@mayhem
mayhem authored May 5, 2023
2 parents 94ed143 + 111075a commit 000d23a
Show file tree
Hide file tree
Showing 4 changed files with 76 additions and 91 deletions.
15 changes: 7 additions & 8 deletions metabrainz/templates/index/datasets.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,16 @@ <h1 class="page-title">{{ _('The MetaBrainz Datasets') }}</h1>

<p>
The MetaBrainz core mission is to curate and maintain public datasets that anyone can download
and use for their own purposes. We ask <a href="{{ url_for('users.account_type') }}">commercial users</a> to
and use. We ask <a href="{{ url_for('users.account_type') }}">commercial users</a> to
<a href="{{ url_for('users.account_type') }}">support us</a> in order to help fund the
creation and maintenance of these datasets, but personal use of our datasets will always be free,
though we do appreciate <a href="{{ url_for('payments.donate') }}">end user donations</a> as well.
creation and maintenance of these datasets. Personal use of our datasets will always be free.
We appreciate <a href="{{ url_for('payments.donate') }}">end user donations</a> as well!
</p>

<p>
Our available datasets fit into two main categories: Main project data dumps, containing the entirety of the
data for a given project, and derived data dumps that are based on the data in our main project databases
and have a more specific purpose.
Our datasets fit into two main categories: Main project data dumps, containing the entirety of
the data for a given project, and derived data dumps that are based on the data in our main project
databases and have a more specific purpose.
</p>

<h2>Database Dumps</h2>
Expand Down Expand Up @@ -130,8 +130,7 @@ <h4>
<h2>Derived Dumps</h2>

<p>
We have also made available the following <em>derived dumps</em> that take data from one project
and transform it into a new dataset that solves a different problem.
Derived dumps take data from one project and transform it into a new dataset that solves a different problem.
</p>
</div>
</div>
Expand Down
89 changes: 39 additions & 50 deletions metabrainz/templates/index/datasets/postgres-dumps.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,47 +6,38 @@
<h1 class="page-title">MetaBrainz Database Dumps</h1>

<p>
All of our data dumps are available under Creative Commons licenses.
All data dumps are available under Creative Commons licenses.
</p>

<p>
However, in order to keep the MetaBrainz Foundation operating so that these datasets
can be maintained and updated further, <b>we require
<a href="{{ url_for('users.account_type') }}">financial support</a>
from our commercial users</b>. Without this support, the future of the datasets
cannot be guaranteed. As such, even when a specific dataset is available
under the Creative Commons Zero (CC0) license (public domain), we still need
commercial users of the data to support us, on a moral basis rather than a legal one!
In order to keep the MetaBrainz Foundation operating, and these datasets maintained and
updated, <b>we require <a href="{{ url_for('users.account_type') }}">financial support</a>
from our commercial users</b>. Without this support maintaining these datasets would not be possible.
As such, even when a dataset is available under the Creative Commons Zero (CC0) license (public
domain), we need the support of commercial users.
</p>

<h3 id="musicbrainz">MusicBrainz PostgreSQL Data Dumps</h3>

<p>
The MusicBrainz data dumps include all public portions of the data from our MusicBrainz project.
This includes artists, releases, labels and the relationships between them, and much more data
that you can find in the MusicBrainz database. In addition, there is a full history of
all the changes that the MusicBrainz community has made to the data, and average ratings
and tag counts (including genre tags) added by the community are also made available.
MusicBrainz data dumps include all public data from our MusicBrainz project. This includes artists,
releases, labels and the relationships between them and much, much more. In addition, we provide a
full history of changes that the MusicBrainz community has made to the data, and the average ratings
and tag counts (including genre tags) added by the community.
</p>

<p>
These data dumps are intended to be imported into a PostgreSQL database; we recommend that you use
the <a href="https://github.com/metabrainz/musicbrainz-docker">musicbrainz-docker</a> project to
import these dumps. Working with them on their own or attempting to import that data into a different
database system than PostgreSQL represents a non-trivial amount of work and we strongly recommend
against doing that.
import these dumps. We do not recommend working with them on their own, or attempting to import the
data into a different database system than PostgreSQL, which represents a non-trivial amount of work.
</p>


<p>
MetaBrainz provides full database exports of the MusicBrainz database twice a week. More regular
(and comfortable) updates are available via the <a href="https://musicbrainz.org/doc/Live_Data_Feed">Live Data Feed</a>,
which allows keeping a local mirror in sync with the main MusicBrainz database every hour. The
MusicBrainz data dumps can be found on the
<a href="http://ftp.musicbrainz.org/pub/musicbrainz/data/fullexport/">MusicBrainz FTP Server</a>
and more information on the contents of the various dump files, including licensing information,
can be found in the
<a href="https://musicbrainz.org/doc/MusicBrainz%20Database/Download">database download page</a>
on MusicBrainz itself.
MetaBrainz provides full database exports of the MusicBrainz database twice a week. More regular (and
comfortable) updates are available via the <a href="https://musicbrainz.org/doc/Live_Data_Feed">Live Data Feed</a>,
which allows keeping a local mirror in sync with the main MusicBrainz database every hour.
</p>

<div class="dataset-summary">
Expand Down Expand Up @@ -93,16 +84,15 @@ <h3 id="musicbrainz">MusicBrainz PostgreSQL Data Dumps</h3>

<a id="musicbrainz-json"><h3>MusicBrainz JSON Data Dumps</h3></a>
<p>
MetaBrainz also provides access to the music metadata in the MusicBrainz database in the easily
consumable format of JSON documents. If you simply cannot work with PostgreSQL or you prefer
to work with a document oriented data store, then this data dump is for you.
MetaBrainz provides access to the music metadata in the MusicBrainz database in the easily consumable
format of JSON documents. If you cannot work with PostgreSQL or you prefer to work with a document
oriented data store, then this data dump is for you.
</p>

<p>
There are individual dump files for each of the following data entities in MusicBrainz:
Area, Artist, Event, Instrument, Label, Place, Recording, Release Group, Release, Series and Work.
Please note that in order to make these data dumps easy to import, the data is not normalized
and will contain duplicate data.
There are individual dump files for each of the following data entities in MusicBrainz: Area, Artist,
Event, Instrument, Label, Place, Recording, Release Group, Release, Series and Work. Please note that
the data is not normalized and will contain duplicate data, in order to make the data dumps easy to import.
</p>

<div class="dataset-summary">
Expand Down Expand Up @@ -146,19 +136,21 @@ <h3 id="musicbrainz">MusicBrainz PostgreSQL Data Dumps</h3>
<a id="listenbrainz"><h3>ListenBrainz PostgreSQL Data Dumps</h3></a>

<p>
The ListenBrainz project serves as an archive where users can store their music listening history.
ListenBrainz then provides users with insights into their listening behaviors by creating detailed
statistics reports from the provided data as well as other social features focused on music.
The ListenBrainz project serves as an archive where users can store their music listening history.
ListenBrainz provides these users with insights into their listening behaviors by creating detailed
statistics reports, as well as providing other music-focused social features.
</p>

<p>
This dataset can be used to create study music consumption patterns, and to create new music datasets.
ListenBrainz itself is using this data to power a music recommendation engine and to create other
derived datasets. The provided data dumps contain all the hundreds of millions of listens
in the ListenBrainz database and as such are rather large. Due to its size, we cannot provide this data
in other formats and we update the full dumps only twice a month. Incremental daily dumps
are also available, which provide all the listen data that was added since the last full dump
and come out every day.
This dataset can be used to create and study music consumption patterns, and to create new music
datasets. ListenBrainz itself is using this data to power a music recommendation engine and to create
other derived datasets.
</p>

<p>
The data dumps are large, containing hundreds of millions of listens. Due to its size, we cannot provide
this data in other formats and we update the full dumps only twice a month. Incremental dumps are also
available daily, which provide all the listen data that was added since the last full dump.
</p>

<div class="dataset-summary">
Expand Down Expand Up @@ -202,16 +194,13 @@ <h3 id="musicbrainz">MusicBrainz PostgreSQL Data Dumps</h3>
<a id="critiquebrainz"><h3>CritiqueBrainz PostgreSQL Data Dumps</h3></a>

<p>
CritiqueBrainz is a repository for Creative Commons licensed music and book reviews. It allows connecting
the factual music metadata in the MusicBrainz database and book metadata in the BookBrainz database
with the opinions about music from music critics and listeners and books from book critics and
readers by providing a platform to store their reviews.
CritiqueBrainz is a repository for Creative Commons licensed music and book reviews. It connects
factual metadata from the MusicBrainz and BookBrainz databases with opinions from critics, listeners,
and readers by providing a platform for their reviews.
</p>

<p>
The MetaBrainz foundation provides full dumps of the CritiqueBrainz database as well as JSON dumps
containing reviews in an easily consumable format. These datasets are updated every day and can be
downloaded from the MusicBrainz FTP Server.
MetaBrainz provides full dumps of the CritiqueBrainz database as well as JSON dumps containing reviews
in an easily consumable format. These datasets are updated every day.
</p>

<div class="dataset-summary">
Expand Down
24 changes: 13 additions & 11 deletions metabrainz/templates/index/datasets/signup.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@
<h1 class="page-title">Please sign up!</h1>

<p>
Before you begin your data download, please consider signing up with us to give us a little
information about how you plan to use our data. As per our <a href="/privacy">Privacy Policy</a>,
we will never share any of the sign-up information with anyone -- we use this data internally
to understand how and who is using our data so that we can improve these datasets to better
meet your needs.

Before you begin your data download, please consider signing up with us. As per our
<a href="/privacy">Privacy Policy</a>, we will never share any of your sign-up information
with anyone. We use this data internally to understand how and who is using our data so that
we can improve the datasets.
</p>

<div id="dataset-signup">
<div class="panel panel-warning" >
<h4 class="panel-heading">Commercial users</h4>
<div class="panel-body">If you plan to use our data in a commercial setting you are required
to sign up with us and to financially support us in an effort to keep the MetaBrainz Foundation
operating and creating more data. For more information on how we define commercial use, please
click the signup button below.

<div class="panel-body">
If you use our data in a commercial setting you are required to sign up with us, and to
financially support us. This keeps the MetaBrainz Foundation operating and supplying data.
For more information on how we define commercial use, please click the sign up button below.
<div class="buttons">
<a class="btn btn-md btn-success" href="{{ url_for("users.account_type") + "#commercial" }}">
Sign up
Expand All @@ -29,7 +29,9 @@ <h4 class="panel-heading">Commercial users</h4>
</div>
<div class="panel panel-warning" >
<h4 class="panel-heading">Non-commercial users</h4>
<div class="panel-body">If you plan to use our data in a personal project, you are not required to sign up, but we would really appreciate it if you would sign up, so that we may better understand our data users.
<div class="panel-body">
If you use our data in a personal project, you are not required to sign up. By choosing to sign
up anyway, you allow us to better understand our data users, and improve the datasets accordingly.
<div class="buttons" >
<a class="btn btn-md btn-success" href="{{ url_for("users.account_type") + "#non-commercial" }}">
OK, I'll sign up!
Expand Down
39 changes: 17 additions & 22 deletions metabrainz/templates/users/account-type.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,25 +6,22 @@
<h1 class="page-title">{{ _('Support us') }}</h1>

<p>
{{ _('If you rely on data from MetaBrainz, please remember that we rely on contributions
to keep providing it. For commercial use of our data or to get access to the
<a href="%(mb_data_feed)s">MusicBrainz Live Data Feed</a>,
please choose between non-commercial and commercial use below. You will need a
<a href="%(mb_register_url)s">MusicBrainz account</a> with a verified email address to sign-up.',
mb_data_feed='https://musicbrainz.org/doc/Live_Data_Feed', mb_register_url='https://musicbrainz.org/register') }}
Do you rely on data from MetaBrainz? We rely on contributions to keep providing it. To access our
datasets or the <a href="https://musicbrainz.org/register">MusicBrainz Live Data Feed</a>, please
choose between non-commercial and commercial use below. You will need a
<a href="https://musicbrainz.org/register">MusicBrainz account</a> with a verified email address to
sign-up.
</p>
<p>


<h3 id="non-commercial">{{ _('Non-commercial / Personal') }}</h3>

<p>
{{ _('Non-commercial includes personal use and university course assignment use of our data.
If you are an open source developer, a small non-profit or are using our data as part of an official
university or research project, please sign up as a commercial user using the non-profit tier below.
If you are a non-profit with more than 10 employees/contractors or a pre-revenue start-up and expect
to have revenue in the future, please sign up with a commercial account &mdash; see below for more
details. Please <a href="%(donate_url)s">consider making a donation</a> to support
Non-commercial includes personal use and university course assignment use of our data. If you are an
open source developer, a small non-profit, or are using our data as part of an official university or
research project, please sign up as a commercial user using the non-profit tier below. If you are a
non-profit with more than 10 employees/contractors, or a pre-revenue start-up and expect to have
revenue in the future, please sign up with a commercial account - see below for more details.
Please <a href="%(donate_url)s">consider making a donation</a> to support
our efforts!', donate_url=url_for('payments.donate')) }}
</p>

Expand All @@ -36,14 +33,12 @@ <h3 id="non-commercial">{{ _('Non-commercial / Personal') }}</h3>
<h3 id="commercial" >{{ _('Commercial') }}</h3>

<p>
{{ _('If you are a company with a current revenue stream or an expected revenue stream,
please select a support tier below that fits your current situation. We welcome working
with companies that are just getting started and we\'re happy for your support for MetaBrainz to grow as
you grow. If you would like to use our data, but are not ready to state this publicly
yet, please sign up for the <em>Stealth start-up</em> tier; we will keep your
data-usage confidential and contact you to discuss your future plans. If you are an established company,
please choose a tier that appropriately fits the size and revenue of your company to properly support
our non-profit foundation.') }}
If you are a company with a current revenue stream or an expected revenue stream, please select a
support tier below that fits your current situation. We welcome working with companies that are just
getting started and we're happy for your MetaBrainz support to grow as you grow. If you would like
to use our data, but are not ready to state this publicly yet, sign up for the stealth start-up tier;
we will keep your data-usage confidential and contact you to discuss your plans. If you are an
established company, choose the tier that appropriately fits the size and revenue of your company.
</p>

{% if tiers %}
Expand Down

0 comments on commit 000d23a

Please sign in to comment.