Shall we disable support for "mkdocs.yml"?

[oprypin]

Something possibly needs to be done regarding which file is used for configuration. There are a lot of possible options - at least four:

1. Support properdocs.yml, fall back to mkdocs.yml and show a warning if mkdocs.yml is used.

2. Support properdocs.yml, fall back to mkdocs.yml, but fail if both files exist.

3. Support only mkdocs.yml.

4. Support only properdocs.yml.

Currently (3) is active.

However we should seek to make an active decision regarding this, because introducing a breaking change later will be more painful.
It's less painful to ask users to switch to "properdocs.yml" immediately while they're switching everything, but on the other hand it's also very attractive to just not ask them to change the file in any way at all.

[oprypin]

I think I'm leaning towards option 1, because all other options have clear downsides:

2. This will mean checking for at least 3 files' existence every time. Wasteful and weird to do anyway.
3. Very bad for long-term recognition.
4. Very bad for immediate term.

If we show just a warning for long enough (1 year+), eventually removing support for mkdocs.yml will not be seen as so outrageous.

[Andre601]

Not entirely sure how 2 would check for 3 files here.

Also, I too think prefering properdocs.yml but falling back to mkdocs.yml would be the best aproach.
My question here is, if it just should take the info from properdocs.yml and ignore mkdocs.yml or if it would be doable (and maybe even beneficial) to have it merge the two files (include options from mkdocs.yml that aren't in properdocs.yml, but warn about this happening)

[oprypin]

Ah no, merging is out of the question. It's just not the expected action. And we don't even have a reasonable implementation of merging.

[ghost]

merge wuld be gr8! can have 2 file then

[oprypin]

Not entirely sure how 2 would check for 3 files here.

Best case:

1. properdocs.yml (found)
2. mkdocs.yml (found)

Worst case:

1. properdocs.yml (not found)
2. properdocs.yaml (found)
3. mkdocs.yml (not found)
4. mkdocs.yaml (found)

And average case being 3

[ghost]

@oprypin can ppl disable warnign for mkdoc.yml? y must we need new filename when all is same?

[Andre601]

To avoid confusion?

It makes no sense that for running ProperDocs you would use mkdocs.yml
Also, it would simply be a rename of the file. Nothing else would change.

[ghost]

oh okey! but can run mkdocs + porperdocs with mkdoc.yml, but only propredocs with proprdoc.yml? hmmmmmm

[Andre601]

No, you don't understand this right.

Depending on what option is selected, which right now is more towards 1, would ProperDocs work woth an mkdocs.yml file, but prioritize a properdocs.yml if it is present.

[ghost]

okey

[oprypin]

• Opened PR for option 1: Read the config from properdocs.yml and fall back to mkdocs.yml #27