Changeset View
Changeset View
Standalone View
Standalone View
docs/faq/index.rst
Show All 10 Lines | |||||
.. _faq_prerequisites: | .. _faq_prerequisites: | ||||
Prerequisites for code contributions | Prerequisites for code contributions | ||||
==================================== | ==================================== | ||||
What are the Skills required to be a code contributor? | What are the Skills required to be a code contributor? | ||||
------------------------------------------------------ | ------------------------------------------------------ | ||||
It depends on what area you want to work on. The `internships`_ postings | Generally, only Python and basic Git knowledge are required to contribute. | ||||
list specific skills | Other than that, it really depends on what technical areas you want to work on. | ||||
required. Generally, only Python and basic Git knowledge are required. Feel free to | |||||
contact us on one of the `development channels | For student internships, the `internships`_ page details specific prerequisites | ||||
<https://www.softwareheritage.org/community/developers/>`__ for details. | needed to pick up a topic. | ||||
Feel free to contact us via our `development channels | |||||
<https://www.softwareheritage.org/community/developers/>`__ to inquiry about | |||||
specific skills needed to work on any topic of your interest. | |||||
What are the minimum system requirements (hardware/software) to run SWH locally? | What are the minimum system requirements (hardware/software) to run SWH locally? | ||||
-------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- | ||||
Python3.7 or newer is required. See the :ref:`developer setup documentation | Python 3.7 or newer is required. See the :ref:`developer setup documentation | ||||
<developer-setup>` for more details. | <developer-setup>` for more details. | ||||
.. _faq_getting_started: | .. _faq_getting_started: | ||||
Getting Started | Getting Started | ||||
=============== | =============== | ||||
What are the must read docs before I start contributing? | What are the must read docs before I start contributing? | ||||
-------------------------------------------------------- | -------------------------------------------------------- | ||||
We recommend you read the top links listed at from the :ref:`documentation home page | We recommend you read the top links listed at from the :ref:`documentation home page | ||||
<swh-docs>` in order: getting started, | <swh-docs>` in order: getting started, | ||||
contributing, and architecture, as well as the data model. | contributing, and architecture, as well as the data model. | ||||
Where can I see the getting started guide for developers? | Where can I see the getting started guide for developers? | ||||
--------------------------------------------------------- | --------------------------------------------------------- | ||||
See :ref:`getting-started` tutorial. | For hacking on the Software Heritage code base you should start from the | ||||
:ref:`developer-setup` tutorial. | |||||
How do I find an easy ticket to get started? | How do I find an easy task to get started? | ||||
-------------------------------------------- | ------------------------------------------ | ||||
We maintain a `list of easy tickets | We maintain a `list of easy tickets | ||||
<https://forge.softwareheritage.org/maniphest/query/WcCLxlHnXok9/>`__ to work on, see | <https://forge.softwareheritage.org/maniphest/query/WcCLxlHnXok9/>`__ to work on, see | ||||
the `Easy hacks page <https://wiki.softwareheritage.org/wiki/Easy_hacks>`__ for more | the `Easy hacks page <https://wiki.softwareheritage.org/wiki/Easy_hacks>`__ for more | ||||
details. | details. | ||||
I am skilled in one specific technology, can I find tickets requiring that skill? | I am skilled in one specific technology, can I find tickets requiring that skill? | ||||
--------------------------------------------------------------------------------- | --------------------------------------------------------------------------------- | ||||
Show All 15 Lines | |||||
* `development channels`_ | * `development channels`_ | ||||
* `contact form`_ for any enquiries | * `contact form`_ for any enquiries | ||||
.. _faq_run_swh: | .. _faq_run_swh: | ||||
Running an SWH instance locally | Running an SWH instance locally | ||||
=============================== | =============================== | ||||
How do I run a local "toy version" of the archive? | |||||
-------------------------------------------------- | |||||
The :ref:`getting-started` tutorial shows how to run a local instance of the | |||||
Software Heritage software infrastructure, using Docker. | |||||
I have SWH stack running in my local. How do I get some initial data to play around? | I have SWH stack running in my local. How do I get some initial data to play around? | ||||
------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ||||
You can setup a job on your local machine, for this you can | You can setup a job on your local machine, for this you can | ||||
:ref:`schedule a listing task <docker-schedule-lister-task>` | :ref:`schedule a listing task <docker-schedule-lister-task>` | ||||
for example. Doing so on small forge, will allow you to load some repositories. | for example. Doing so on small forge, will allow you to load some repositories. | ||||
Or you can also trigger directly :ref:`loading from the cli <docker-run-loader-cli>`. | Or you can also trigger directly :ref:`loading from the cli <docker-run-loader-cli>`. | ||||
▲ Show 20 Lines • Show All 170 Lines • Show Last 20 Lines |