Create "howto" / tutorials in the developer documentation
Closed, MigratedEdits Locked
Actions

Assigned To

Authored By

	vlorentz
	Mar 18 2021, 11:33 AM

Description

copy:

how to create a lister

add:

how to create a loader (package + vcs)
how to enable optional docker-compose (search, keycloak, replayer)

Revisions and Commits

rDENV Development environment
	D5464	rDENVdd70988e12f7 docker: Document alternative docker-compose files.
rDLDBASE Generic VCS/Package Loader
	D5443	rDLDBASE134c828efea4 Write an overview of how to write VCS loaders.
	D5412	rDLDBASE320938cf1892 package-loader-tutorial: Add 'Making your loader incremental' section
	D5415	rDLDBASEf3c24776627a package-loader-tutorial: Add 'Loading metadata' and 'Final words' sections.
	D5410	rDLDBASEcdaad2122951 package-loader-tutorial: Add 'Testing your loader' section
	D5401	rDLDBASE0eeb712bb162 Start writing a package loader tutorial.
rDDOC Development documentation
	D5276	rDDOCe9b4982e04db Add links to the lister tutorials in the index

Related Objects

Mentioned In: D5464: docker: Document alternative docker-compose files.
D5443: Write an overview of how to write VCS loaders.
D5276: Add links to the lister tutorials in the index
Mentioned Here: D5069: docs: Add new "howto write a lister tutorial" with unified lister api

Event Timeline

vlorentz triaged this task as Normal priority.Mar 18 2021, 11:33 AM

vlorentz created this task.

FYI there is a lister tutorial already in the docs updated with D5069

You can find it here: https://docs.softwareheritage.org/devel/swh-lister/index.html

Tutorial: list the content of your favorite forge in just a few steps
Tutorial: run a lister within docker-dev in just a few steps

The direct links can be added to the main devel docs page.

vlorentz renamed this task from Create "howto" / tutorials in the developer documentation from the blog to Create "howto" / tutorials in the developer documentation.Mar 18 2021, 11:59 AM

vlorentz added a revision: D5276: Add links to the lister tutorials in the index.Mar 18 2021, 12:00 PM

vlorentz mentioned this in D5276: Add links to the lister tutorials in the index.Mar 18 2021, 12:00 PM

vlorentz added a commit: rDDOCe9b4982e04db: Add links to the lister tutorials in the index.Mar 18 2021, 1:18 PM

vlorentz added revisions: D5401: Start writing a package loader tutorial., D5410: package-loader-tutorial: Add 'Testing your loader' section, D5412: package-loader-tutorial: Add 'Making your loader incremental' section, D5415: package-loader-tutorial: Add 'Loading metadata' and 'Final words' sections..Apr 2 2021, 6:15 PM

vlorentz added a commit: rDLDBASE0eeb712bb162: Start writing a package loader tutorial..Apr 6 2021, 3:39 PM

vlorentz added a commit: rDLDBASEcdaad2122951: package-loader-tutorial: Add 'Testing your loader' section.

vlorentz added a commit: rDLDBASE320938cf1892: package-loader-tutorial: Add 'Making your loader incremental' section.

vlorentz added a commit: rDLDBASEf3c24776627a: package-loader-tutorial: Add 'Loading metadata' and 'Final words' sections..

vlorentz mentioned this in D5443: Write an overview of how to write VCS loaders..Apr 7 2021, 4:17 PM

vlorentz added a revision: D5443: Write an overview of how to write VCS loaders..Apr 7 2021, 4:17 PM

vlorentz added a commit: rDLDBASE134c828efea4: Write an overview of how to write VCS loaders..Apr 8 2021, 1:13 PM

vlorentz mentioned this in D5464: docker: Document alternative docker-compose files..Apr 8 2021, 4:58 PM