Better datasource documentation

[languitar]

What would you like Renovate to be able to do?

Right now, the documentation on datasources at https://docs.renovatebot.com/modules/datasource/#gitlab-tags-datasource is pretty sparse. Apart from the mere existence, most source are not documented at all. This makes understanding when to use them and what corner cases exist pretty hard. Especially when using things like the regex manager, such an understanding is often necessary, though.

[github-actions[bot]]

This issue has been labeled with status:requirements. This indicates that we don't know enough to start work and further requirements or a reproduction are needed first.

This label will be replaced with status:ready once all requirements and reproductions necessary to start work have been met.

If it's not clear what is missing to move this issue forward, ask for clarification in a new comment. If you think we already have what we need to move forward, mention this in a new comment.

[HonkingGoose]

I'm labeling this status:requirements because we need to figure out what "proper documentation for datasources" would look like.

[languitar]

I think the Repology Datasource is a pretty good example of how things can look like.

[HonkingGoose]

Also there's this part of the docs:

You do not need to ever configure/override datasources directly, but you may use them in a packageRules array to configure other aspects of Renovate's behavior, e.g.

So do we even intend to cover datasources in depth anyways?

[rarkins]

The extended description of each datasource is present if the datasource has a readme.md in its directory. e.g. here is repology's: https://github.com/renovatebot/renovate/blob/master/lib/datasource/repology/readme.md

[HonkingGoose]

Pasting a comment from @viceice https://github.com/renovatebot/renovate/discussions/16418#discussioncomment-3102853

@HonkingGoose we probably should add some details about auth for datasource to docs. by default it needs to match the datasource id ( internal name). 🤔

[viceice]

• 19190

[rarkins]

Anything left to do?

[viceice]

i think the default config would probably also helpful