Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Register
  • Sign in
  • M Meta
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Issues 459
    • Issues 459
    • List
    • Boards
    • Service Desk
    • Milestones
  • Snippets
    • Snippets
  • Activity
  • Create a new issue
  • Issue Boards
Collapse sidebar
  • Platform
  • Meta
  • Issues
  • #917
Closed
Open
Issue created Jan 06, 2018 by Stefano Zacchiroli@zackMaintainer

Git loader: update README for YAML-based syntax

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?


Migrated from T917 (view on Phabricator)

Edited Jan 08, 2023 by Phabricator Migration user
Assignee
Assign to
Time tracking