.. Dataverse Documentation master file, created by
   sphinx-quickstart on Mon Jan 13 15:30:58 2014.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Dataverse Documentation v. |version|
====================================

These documentation guides are for the |version| version of Dataverse. To find guides belonging to previous or future versions, :ref:`guides_versions` has a list of all available versions.

.. toctree::
  :glob:
  :titlesonly:
  :maxdepth: 2

  user/index
  admin/index
  ai/index
  api/index
  installation/index
  contributor/index
  developers/index
  container/index
  style/index
  qa/index.md

How the Guides Are Organized
----------------------------

The guides are documentation that explain how to use Dataverse,
which are divided into the following sections: User Guide,
Installation Guide, Developer Guide, API Guide, Style Guide and Container Guide.
The User Guide is further divided into primary activities: finding & using
data, adding Datasets, administering dataverses or Datasets, and Dataset exploration/visualizations. Details
on all of the above tasks can be found in the Users Guide. The
Installation Guide is for people or organizations who want to host their
own Dataverse. The Container Guide gives information on how to deploy Dataverse with containers.
The Developer Guide contains instructions for
people who want to contribute to the Open Source Dataverse
project or who want to modify the code to suit their own needs. Finally, the API Guide is for
Developers that work on other applications and are interested in connecting with Dataverse through our APIs.

Other Resources
---------------

**Dataverse Project Site**

Additional information about the Dataverse Project itself
including presentations, information about upcoming releases, data
management and citation, and announcements can be found at
`https://dataverse.org/ <https://dataverse.org/>`__

**User Group**

As the user community grows we encourage people to shares ideas, ask
questions, or offer suggestions for improvement. Go to
`https://groups.google.com/group/dataverse-community <https://groups.google.com/group/dataverse-community>`__ to register to our dataverse community group.

**Follow Us on Twitter**

For up to date news, information and developments, follow our twitter account: `https://twitter.com/dataverseorg <https://twitter.com/dataverseorg>`__

**Support**

We maintain an email based support service that is free of charge. We
attempt to respond within one business day to all questions and if it
cannot be resolved immediately, we will let you know what to expect.

The support email address is `support@dataverse.org <mailto:support@dataverse.org>`__.

**Reporting Issues and Contributing**

Report bugs and add feature requests in `GitHub Issues <https://github.com/IQSS/dataverse/issues>`__
or use `GitHub pull requests <https://guides.dataverse.org/en/latest/developers/version-control.html#how-to-make-a-pull-request>`__,
if you have some code, scripts or documentation that you'd like to share.
If you have a **security issue** to report, please email `security@dataverse.org <mailto:security@dataverse.org>`__. See also :ref:`reporting-security-issues`.


Indices and Tables
------------------

* :ref:`search`