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

docs: Deprecate use of git.io URL shortener #1851

Merged
merged 3 commits into from
Apr 27, 2022

Conversation

matthewfeickert
Copy link
Member

Description

GitHub is killing off the git.io URL shortening service this Friday (2022-04-29) so all URLs in the docs that use it need to be updated.

Checklist Before Requesting Reviewer

  • Tests are passing
  • "WIP" removed from the title of the pull request
  • Selected an Assignee for the PR to be responsible for the log summary

Before Merging

For the PR Assignees:

  • Summarize commit messages into a comprehensive review of the PR
* Replace all instances of git.io shortened URLs with full URLs as git.io is
being killed off by GitHub on 2022-04-29.
   - c.f. https://github.blog/changelog/2022-04-25-git-io-deprecation/

@matthewfeickert matthewfeickert added docs Documentation related fix A bug fix labels Apr 27, 2022
@matthewfeickert matthewfeickert self-assigned this Apr 27, 2022
@matthewfeickert
Copy link
Member Author

@kratsg if you have a favorite URL shortener that we can rely on to be stable for a long time to come it would be good to switch to that instead of using the full URLs.

@codecov
Copy link

codecov bot commented Apr 27, 2022

Codecov Report

Merging #1851 (115b437) into master (afa49e0) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master    #1851   +/-   ##
=======================================
  Coverage   98.16%   98.16%           
=======================================
  Files          68       68           
  Lines        4315     4315           
  Branches      725      725           
=======================================
  Hits         4236     4236           
  Misses         46       46           
  Partials       33       33           
Flag Coverage Δ
contrib 26.44% <ø> (ø)
doctest 60.78% <ø> (ø)
unittests-3.10 96.03% <ø> (ø)
unittests-3.7 96.02% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
src/pyhf/cli/infer.py 97.61% <ø> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update afa49e0...115b437. Read the comment docs.

@matthewfeickert
Copy link
Member Author

@matthewfeickert
Copy link
Member Author

@kratsg @lukasheinrich This doesn't look too bad and it turns out that we already use the full URL in other examples in the CLI API docs, so I think this is fine.

e.g.

$ curl -sL https://raw.githubusercontent.com/scikit-hep/pyhf/master/docs/examples/json/2-bin_1-channel.json | pyhf inspect

@matthewfeickert matthewfeickert merged commit e7996e5 into master Apr 27, 2022
@matthewfeickert matthewfeickert deleted the docs/deprecate-git.io-urls branch April 27, 2022 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation related fix A bug fix
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants