Page MenuHomeSoftware Heritage

Git loader: update README for YAML-based syntax
Open, LowPublic

Description

The Git loader README still reference the old ini-based syntax for configuration file. It should be updated to use the new yaml-based format.
Its content is also out-of-date in other ways (configuration path, keys, etc.).

While we are at it, it is nowadays probably pointless to document configuration in README. Rather, we should consistently store configuration information in the python documentation of each module, so that we can cross-reference from one module to another. For instance, instead of (re-)documenting the storage configuration requirements in the Git loader module, we should just point to the corresponding configuration documentation of the storage module.

How about a top-level "configuration" document in each module?

Event Timeline

zack created this task.Jan 6 2018, 8:50 AM
zack renamed this task from Git loader: update README for YAML-based syntax. to Git loader: update README for YAML-based syntax.
olasd added a comment.Jan 10 2018, 4:46 PM

Moving the documentation about the config to a top-level configuration document, in the docs directory, sounds like a very good plan. You assigned yourself the ticket, will you do it?

zack added a comment.Jan 11 2018, 8:25 AM
In T917#16911, @olasd wrote:

Moving the documentation about the config to a top-level configuration document, in the docs directory, sounds like a very good plan. You assigned yourself the ticket, will you do it?

Yep, and will try to do that for other modules too. I'll ask for review of what I wrote though :)

olasd added a comment.Jun 26 2018, 4:55 PM

$ cat .config/swh/loader/git-updater.yml

---
content_size_limit: 1000000
save_data: True
save_data_path: /home/ndandrim/.cache/swh/packfiles
storage:
  cls: remote
  args:
    url: http://localhost:5002/