Add the configerator config source doc.

[jieru-hu]

Motivation

Move the doc to hydra doc.

Have you read the Contributing Guidelines on pull requests?

Yes/No

Test Plan

Build it locally, verified it looked ok

Related Issues and PRs

(Is this PR part of a group of changes? Link the other relevant PRs and Issues here. Use https://help.github.com/en/articles/closing-issues-using-keywords for help on GitHub syntax)

[omry]

Cool.
I think this plugin is not as useful as it can be before we have support for configuring the config searchpath.
I don't mind landing this though but I think we should call out that things will be easier once #274 is done.
By the way: there is a chicken and egg here:
The primary config cannot be in configerator if we support that unless we also support arbitrary searchpath urls in @hydra.main():

@hydra.main(config_path="configerator://my_project", config_name="config")
def main(cfg):
  ...

[jieru-hu]

Cool.
I think this plugin is not as useful as it can be before we have support for configuring the config searchpath.
I don't mind landing this though but I think we should call out that things will be easier once #274 is done.
By the way: there is a chicken and egg here:
The primary config cannot be in configerator if we support that unless we also support arbitrary searchpath urls in @hydra.main():

@hydra.main(config_path="configerator://my_project", config_name="config")
def main(cfg):
  ...

I'm not sure I get this one. We can still read from configerator as primary if the SearchPathPlugin is defined and the config name exists in configerator. (and I've tested that in fbcode it works. ) maybe we can chat about this in person tomorrow.

[omry]

I'm not sure I get this one. We can still read from configerator as primary if the SearchPathPlugin is defined and the config name exists in configerator. (and I've tested that in fbcode it works. ) maybe we can chat about this in person tomorrow.

I am talking about the situation when we no longer need the SearchPathPlugin because we have the ability to configure the searchpath in the primary config.

[omry]

lgtm!

[jieru-hu]

I'm not sure I get this one. We can still read from configerator as primary if the SearchPathPlugin is defined and the config name exists in configerator. (and I've tested that in fbcode it works. ) maybe we can chat about this in person tomorrow.

I am talking about the situation when we no longer need the SearchPathPlugin because we have the ability to configure the searchpath in the primary config.

ah got it! thx for the clarification.