docs/developer-setup.rst
15	that label (`docker-devs`) doesn't exist. The "docker-dev project" doesn't really exist anymore so it might be better to rephrase this?
docs/getting-started.rst
23	`cd swh-environment/docker`

This revision now requires changes to proceed.Jan 27 2020, 12:29 PM

ardumont added inline comments.Jan 27 2020, 12:31 PM

docs/developer-setup.rst
17	isn't it the label?

Adapt according to review

Harbormaster completed remote builds in B10291: Diff 9230.Jan 27 2020, 12:34 PM

vlorentz accepted this revision.Jan 27 2020, 1:22 PM

olasd accepted this revision.Jan 27 2020, 5:09 PM

olasd added inline comments.

docs/developer-setup.rst
15	no need for a possessive (`'s`) here.
17	The reference was plural and the label singular.

This revision is now accepted and ready to land.Jan 27 2020, 5:09 PM

Remove unneeded possessive form

Harbormaster completed remote builds in B10304: Diff 9245.Jan 27 2020, 5:14 PM

Closed by commit rDDOCdb1725926770: docs: Update swh-docker-dev mentions to swh-environment/docker (authored by ardumont). · Explain WhyJan 27 2020, 5:14 PM

This revision was automatically updated to reflect the committed changes.

ardumont added a commit: rDDOCdb1725926770: docs: Update swh-docker-dev mentions to swh-environment/docker.

Revision Contents
Changeset List

Path

Size

docs/

developer-setup.rst

5 lines

getting-started.rst

4 lines

Diff 9246

View Options

docs/developer-setup.rst

	.. _developer-setup:			.. _developer-setup:

	Developer setup			Developer setup
	===============			===============

	In this guide we describe how to set up a developer environment in which one			In this guide we describe how to set up a developer environment in which one
	can easily navigate the source code, make modifications, write and execute unit			can easily navigate the source code, make modifications, write and execute unit
	tests.			tests.

	For this, we will use a `virtualenv`_ in which all the \|swh\| packages will be			For this, we will use a `virtualenv`_ in which all the \|swh\| packages will be
	installed in 'develop' mode, this will allow you to navigate the source code,			installed in 'develop' mode, this will allow you to navigate the source code,
	hack it, and run locally the unit tests.			hack it, and run locally the unit tests.

	If you want to test the effect of your modifications in a running \|swh\|			If you want to test the effect of your modifications in a running \|swh\|
	instance, you should check the `documentation`_ of the swh-docker-dev_ project.			instance, you should check the swh-environment docker `documentation`_.
				olasdUnsubmitted Not Done Inline Actions that label (`docker-devs`) doesn't exist. The "docker-dev project" doesn't really exist anymore so it might be better to rephrase this? olasd: that label (`docker-devs`) doesn't exist. The "docker-dev project" doesn't really exist anymore…
				olasdUnsubmitted Not Done Inline Actions no need for a possessive (`'s`) here. olasd: no need for a possessive (`'s`) here.

	.. _`documentation`: https://forge.softwareheritage.org/source/swh-docker-dev/browse/master/README.md?as=remarkup			.. _`documentation`: https://forge.softwareheritage.org/source/swh-environment/browse/master/docker/README.md?as=remarkup
				ardumontAuthorUnsubmitted Done Inline Actions isn't it the label? ardumont: isn't it the label?
				olasdUnsubmitted Not Done Inline Actions The reference was plural and the label singular. olasd: The reference was plural and the label singular.
	.. _`swh-docker-dev`: https://forge.softwareheritage.org/source/swh-docker-dev
	.. _`virtualenv`: https://pypi.org/project/virtualenv/			.. _`virtualenv`: https://pypi.org/project/virtualenv/


	Install required dependencies			Install required dependencies
	-----------------------------			-----------------------------

	Software Heritage requires some dependencies that are usually packaged by your			Software Heritage requires some dependencies that are usually packaged by your
	package manager. On Debian/Ubuntu-based distributions::			package manager. On Debian/Ubuntu-based distributions::
	▲ Show 20 Lines • Show All 175 Lines • Show Last 20 Lines

View Options

docs/getting-started.rst

	Show All 14 Lines
	++++++++++++			++++++++++++

	The easiest way to run a Software Heritage instance is to use Docker and			The easiest way to run a Software Heritage instance is to use Docker and
	docker-compose. Please refer to the `docker-compose documentation			docker-compose. Please refer to the `docker-compose documentation
	<https://docs.docker.com/compose/>`_ if you do not have a working docker setup.			<https://docs.docker.com/compose/>`_ if you do not have a working docker setup.

	Then::			Then::

	git clone https://forge.softwareheritage.org/source/swh-docker-dev.git			git clone https://forge.softwareheritage.org/source/swh-environment.git
				olasdUnsubmitted Not Done Inline Actions `cd swh-environment/docker` olasd: `cd swh-environment/docker`
	cd swh-docker-dev			cd swh-environment/docker
	docker-compose up -d			docker-compose up -d

	When all the containers are up and running, you have a running Software			When all the containers are up and running, you have a running Software
	Heritage platform. You should open:			Heritage platform. You should open:

	- http://localhost:5080/ to navigate your (empty for now) SWH archive,			- http://localhost:5080/ to navigate your (empty for now) SWH archive,
	- http://localhost:5080/rabbitmq to access the rabbitmq dashboard (guest/guest),			- http://localhost:5080/rabbitmq to access the rabbitmq dashboard (guest/guest),
	- http://localhost:5080/grafana to explore the platform's metrics,			- http://localhost:5080/grafana to explore the platform's metrics,
	Show All 30 Lines

docs: Update swh-docker-dev mentions to swh-environment/dockerClosedPublicActions

Details

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 9246

docs/developer-setup.rst

docs/getting-started.rst

docs: Update swh-docker-dev mentions to swh-environment/docker
ClosedPublic
Actions

Revision Contents
Changeset List