Change configuration file name

[ehuelsmann]

The old instructions are not valid YAML.

[haarg]

The existing instructions aren't really wrong. Using a metacpan_web_local.conf file using Config::General syntax should still work.

The file name also needs to be updated with the format.

[ehuelsmann]

The file name also needs to be updated with the format.

The confusion came from the fact that - although the docs list metacpan_web.conf, there actually is only a metacpan_web.yaml. All I did was add the _local suffix to the filename on disk (that is, before the extension), which resulted in metacpan_web_local.yaml instead of the documented metacpan_web_local.conf.

[ehuelsmann]

Indeed, both work (I've tested that now).

[haarg]

I think we should change the example to also use YAML, like you originally had. But both file names need their extensions changed.

I just wanted to clarify that a _local.conf will still work. But we don't need it in the docs.

[ehuelsmann]

Ah! No problem. Reverted the last change (reinstating metacpan_web_local.yaml) and changed the base name of the standard configuration to metacpan_web.yaml as it is on disk.

[guest20]

The reason to not use YAML for the config of Catalyst apps is that putting YAML in POD is pure hate‡.

Both pod and YAML use different indents to indicate stuff and so:

• editors will assume that the whole expanse of space is the same type of space and any edit will turn your 4 spaces for pod indent, 6 spaces for 3 levels of keys in yaml into a factor of tabstop
• different renders care different amounts about whitespace, so now the manual looks weird on ancient BSD or the latest macos
• copy/pasting example YAML configs from the pod (rendered or otherwise) pretty much never works because of different levels of collapsing space or because of non-breaking spaces being forced in so it renders right. Maybe the renderer doesn't strip the leading "this is a verbatim block" spaces

... nearly all of this is also true for pasting yaml into markdown, a thing which people will likely need to do if they ever have to report a bug

__
‡. when are we getting =yaml in pod?

[oalders]

I think we should change the example to also use YAML

+1 Let's not encourage any config formats other than YAML. We were in a transitional state there for a while, but now it's time for the docs to catch up.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.46%. Comparing base (dd7274a) to head (30160b1).
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #3361      +/-   ##
==========================================
+ Coverage   73.41%   73.46%   +0.04%     
==========================================
  Files          68       68              
  Lines        2389     2389              
  Branches      335      335              
==========================================
+ Hits         1754     1755       +1     
+ Misses        508      507       -1     
  Partials      127      127              

see 1 file with indirect coverage changes

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[oalders]

Thanks @ehuelsmann!