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

Update links in documentation #459

Merged
merged 3 commits into from
Dec 25, 2022
Merged

Update links in documentation #459

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8248f8d
Add link to GitHub repository
namurphy Dec 21, 2022
be28cce
Rename link from 'News' to 'Release Notes'
namurphy Dec 21, 2022
7125c1d
Add news fragment
namurphy Dec 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,5 +41,5 @@ Project Links

- **PyPI**: https://pypi.org/project/towncrier/
- **Documentation**: https://towncrier.readthedocs.io/
- **News**: https://github.com/twisted/towncrier/blob/trunk/NEWS.rst
- **Release Notes**: https://github.com/twisted/towncrier/blob/trunk/NEWS.rst
- **License**: `MIT <https://github.com/twisted/towncrier/blob/trunk/LICENSE>`_
1 change: 1 addition & 0 deletions docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ Development

contributing
release
GitHub Repository <https://github.com/twisted/towncrier>
Copy link
Member

Choose a reason for hiding this comment

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

And a very minor comment... mostly a matter of taste.
We can keep it short. Since we are on the towncrier page, I think that people will assume that we will not go to the start github page, but to the repo page.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm slightly inclined to keep both words in case someone does a page search for either of "GitHub" or "Repo", but I'm content with either.


.. include:: ../README.rst
:start-after: .. links
2 changes: 2 additions & 0 deletions src/towncrier/newsfragments/459.misc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Added a link to the GitHub repository on the landing page of the
documentation, and renamed the link for the release notes.