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.

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

Documentation: add link to release announcements #44

Conversation

jrfnl
Copy link
Collaborator

@jrfnl jrfnl commented Apr 27, 2019

I was having trouble finding the older ones, so figured having a link to the page somewhere might be useful.

@jrfnl jrfnl force-pushed the feature/add-link-to-announcements-in-documentation branch from 1f3fcd3 to 17a39a4 Compare April 28, 2019 01:30
@@ -43,6 +43,7 @@ <h1>Documentation for PHPUnit</h1>
<li><a href="https://phpunit.readthedocs.io/es/latest/">Spanish</a></li>
</ul>
<p>Documentation for PHPUnit 6.5 (and older) is archived at <code>https://phpunit.de/manual/6.5/en/index.html</code>. Simply replace <code>6.5</code> with the version number you are looking for. Simply replace <code>en</code> with <code>fr</code>, <code>pt_br</code>, <code>ja</code>, or <code>zh_cn</code> to access the French, Brazilian Portuguese, Japanese, or Simplified Chinese translation, respectively.</p>
<p>Important information about changes in major releases can be found in the <a href="announcements/">release announcements</a>, for changes in minor versions more information can be found in the <a href="https://github.com/sebastianbergmann/phpunit/wiki/">wiki</a>.</p>

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"for changes in minor versions more information can be found in the wiki" is not correct. This information can be found in the ChangeLog-X.Y.md files.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sebastianbergmann I'd be happy to change this, however IMO those are very unwieldy to work with as older changelogs are deleted from the master branch which means in effect that the user would need to switch branches a lot of times to be able to find all those. As I did find them in the wiki as well (after a google search), that seemed the more user friendly option to point people to.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The wiki is no longer used for release announcements or ChangeLogs. If you want to link to changes in minor releases then you have to use https://github.com/sebastianbergmann/phpunit/blob/8.1/ChangeLog-8.1.md#810---2019-04-05 for PHPUnit 8.1, for example.

@sebastianbergmann
Copy link
Owner

Thank you for your contribution. I appreciate the time you invested in preparing this pull request. However, I have decided not to merge it.

I will take care of this shortly in #45.

@jrfnl
Copy link
Collaborator Author

jrfnl commented Apr 30, 2019

Seen the commit with the additional changelog links. Awesome! 🎉 Much appreciated.

@jrfnl jrfnl deleted the feature/add-link-to-announcements-in-documentation branch April 30, 2019 23:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants