Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Documentation is moved in an endless loop #133

Open
grinapo opened this issue Feb 14, 2018 · 1 comment
Open

Documentation is moved in an endless loop #133

grinapo opened this issue Feb 14, 2018 · 1 comment
Labels
component:documentation

Comments

@grinapo
Copy link

grinapo commented Feb 14, 2018

Readme says

For PyYAML tutorial and reference, see:
'http://pyyaml.org/wiki/PyYAMLDocumentation'.

and on pyyaml.org it says:

PyYAML and LibYAML are now maintained at https://github.com/yaml. 
This page is left for historical purposes.

so we go to the link which says the same as readme. We are caught in the endless loop forever and the world is halted.
@amansheim-bm-net
Copy link

amansheim-bm-net commented May 16, 2018 •
edited
Loading

To provide a correct and clear location for these materials, it would be enough to do any one of the following, wouldn't it?

  • Just make the README insist on referring to the wiki. Add a note at https://github.com/yaml to clarify that the tutorial http://pyyaml.org/wiki/PyYAMLDocumentation#tutorial and the reference information http://pyyaml.org/wiki/PyYAMLDocumentation#reference are current, not only historical, regardless that the caution "This page is left for historical purposes." may appear on the page http://pyyaml.org/wiki/PyYAMLDocumentation.
  • Just make the README stop referring to the wiki. Move the tutorial and reference to the repository https://github.com/yaml. Revise the repository's README to say where the tutorial and reference have been placed.
  • Just change the wiki. Remove the caution "This page is left for historical purposes." from http://pyyaml.org/wiki/PyYAMLDocumentation. That caution can remain in place at http://pyyaml.org/wiki/PyYAML.

@bsolomon1124 bsolomon1124 mentioned this issue May 28, 2020
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
component:documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@perlpunk @grinapo @amansheim-bm-net