An open API service indexing awesome lists of open source software.

https://github.com/datalad/faq

DataLad Frequently Asked Questions
https://github.com/datalad/faq

Last synced: 4 months ago
JSON representation

DataLad Frequently Asked Questions

Awesome Lists containing this project

README

          

# FAQ

[![](https://img.shields.io/badge/project-DataLad-blue.svg?style=flat-square)](http://datalad.org/)
[![](https://img.shields.io/badge/project%20of-CON-blue.svg?style=flat-square)](http://centerforopenneuroscience.org)
[![](https://img.shields.io/badge/oftc-%23datalad-blue.svg?style=flat-square)](http://webchat.oftc.net/?channels=%23datalad)
[![](https://img.shields.io/badge/discussion_repo-go_to_issues-brightgreen.svg?style=flat-square)](https://github.com/datalad/datalad/issues)
[![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)

> Frequently Asked Questions

This repository was "deprecated" in favor of just containing all questions, including frequently asked ones, withing the [main DataLad github repository](https://github.com/datalad/datalad/issues).
Please ask your question in an [DataLad Issues](https://github.com/datalad/datalad/issues). Make sure to search existing issues, as your question may already have been asked and answered. The FAQs have `FAQ` label attached.

### [View All Questions](https://github.com/datalad/datalad/issues)
### [View FAQs](https://github.com/datalad/datalad/issues)
### [Ask a new Question](https://github.com/datalad/datalad/issues/new)
_Please search first!_

We close `question` issues which have been answered: if you would like to help answer questions, you can use [this search](https://github.com/datalad/datalad/issues?utf8=%E2%9C%93&q=is%3Aopen+is%3Aissue+-label%3Aanswered) to find unanswered questions.

## Table of Contents

- [Usage](#usage)
- [Comment!](#comment)
- [Use "WIP" in the question title to denote a "Work In Progress" answer.](#use-wip-in-the-question-title-to-denote-a-work-in-progress-answer)
- [Rendering to a page](#rendering-to-a-page)
- [Contribute](#contribute)
- [License](#license)

## Usage

#### Comment!

We hope that this FAQ would help answering a lot of questions, and it might become difficult for the DataLad team to go through the backlog and refine answers for older questions. If you think a question hasn't been answered adequately, comment on it, and we'll look at it. Unlike on the rest of GitHub, using :thumb: or '+1' is actively encouraged as a way to show that a question should be brought back to our attention.

#### Use "WIP" in the question title to denote a "Work In Progress" answer.

We will mark any Q/As with `WIP` when the answer is long, complex, and likely to evolve over time. It is very important to signal when we think something is roughly "a final answer", versus "a place to jot down notes and point others for quick disambiguation". Many answers, like comparisons to other systems, will be WIPs for a while.

#### Rendering to a page

The "best" questions and answers will later be compiled into a webpage rendered at http://docs.datalad.org (still TODO)

## Contribute

Feel free to join in and ask or answer questions in the issues. No helpful comment is too small, no answer too big.

**Want to hack on DataLad?**

We welcome contributions beyond Q/As. If you would like to contribute to the code-base, you might benefit from glancing over
[CONBTRIBUTING.md](https://github.com/datalad/datalad/blob/master/CONTRIBUTING.md)

## License

Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

The idea of FAQ repo was given by @satra with [IPFS FAQ](https://github.com/ipfs/faq) was given as an example, from which the base for this `README.md` was taken.