Page MenuHomeSoftware Heritage
Create Task
Maniphest T917

Git loader: update README for YAML-based syntax
Closed, MigratedEdits Locked
Actions

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?

Related Objects
Search...

Event Timeline

zack renamed this task from Git loader: update README for YAML-based syntax. to Git loader: update README for YAML-based syntax.Jan 6 2018, 8:50 AM
zack created this task.
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/
zack removed zack as the assignee of this task.Nov 27 2018, 12:17 PM
zack added a parent task: T1388: Document the configuration system of each component.
zack mentioned this in T1388: Document the configuration system of each component.
zack closed this task as Resolved.May 25 2019, 5:13 PM
zack claimed this task.
zack updated the task description. (Show Details)
zack mentioned this in T1758: consistently document the configuration option of each module.

This is done, I've forked off the part about consistently documenting configuration options to T1758.

gitlab-migration changed the task status from Resolved to Migrated.Jan 8 2023, 9:57 PM
gitlab-migration claimed this task.
gitlab-migration added a subscriber: gitlab-migration.

This task has been migrated to GitLab.

About · Developer information · Legal