Skip to content

Improvement proposal: YAML files should use recommended file extension in documentation recommendation #7460

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
AvdN opened this issue Sep 5, 2020 · 4 comments
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors Needed: documentation Documentation is required

Comments

@AvdN
Copy link
Contributor

AvdN commented Sep 5, 2020

The recommended extension for files containing YAML documents is .yaml ( http://yaml.org/faq.html ) and this has been the case since at least Sep 2006 ( https://web.archive.org/web/20060924190202/http://yaml.org/faq.html ).

Some (outdated) projects/libraries still tend to advertise the .yml, probably motivated with DOS 8.3 file naming compatibility (or by not bothering to investigate if what an example project does is correct). Not using the recommended extension should however never be done without proper motivation for divergence (if done at all)

Moreover an YML file format (a domain specific language derivation from XML, https://fdik.org/yml/) has been in existence for about as long as YAML, making the use of .yml unnecessarily ambiguous.

Readthedocs already supports filenames with the proper extension such as .readthedocs.yaml. The documentation should be updated to exclusively recommend files with .yaml extension, instead of those with .yml.

Readthedocs code should continue to support both extensions. And in general readthedocs should throw an error if multiple files exists for one configuration document (e.g. readthedocs.yml and .readthedocs.yaml), if it doesn't already do so, and not silently prefer one exension over the other in code.

I can provide a pull request with the appropriate changes (just let me know).

@stsewd stsewd added the Accepted Accepted issue on our roadmap label Sep 8, 2020
@stsewd
Copy link
Member

stsewd commented Sep 8, 2020

Sure, I think it's a good idea

@humitos humitos added the Needed: documentation Documentation is required label Sep 9, 2020
@stsewd
Copy link
Member

stsewd commented Dec 10, 2020

If someone wants to take this, the changes should be done in both v1 y v2 docs the https://docs.readthedocs.io/en/stable/config-file/index.html

@stsewd stsewd added the Good First Issue Good for new contributors label Dec 10, 2020
@humitos
Copy link
Member

humitos commented Mar 29, 2021

I think this is already done, but you can take a look @astrojuanlu and probably close it.

@astrojuanlu
Copy link
Contributor

Closed in #7918

astrojuanlu added a commit that referenced this issue Aug 17, 2021
"The recommended extension for files containing YAML documents is .yaml ( http://yaml.org/faq.html ) and this has been the case since at least Sep 2006 ( https://web.archive.org/web/20060924190202/http://yaml.org/faq.html )."

See #7460
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Accepted Accepted issue on our roadmap Good First Issue Good for new contributors Needed: documentation Documentation is required
Projects
None yet
Development

No branches or pull requests

4 participants