Implement Jazzband guidelines for project django-oauth-toolkit

[jazzband-bot]

This issue tracks the implementation of the Jazzband guidelines for the project django-oauth-toolkit

It was initiated by @synasius who was automatically assigned in addition to the Jazzband roadies.

See the TODO list below for the generally required tasks, but feel free to update it in case the project requires it.

Feel free to ping a Jazzband roadie if you have any question.

TODOs

• Fix all links in the docs (and README file etc) from old to new repo
• Add the Jazzband badge to the README file
• Add the Jazzband contributing guideline to the CONTRIBUTING.md file
• Check if continuous testing works (e.g. Travis-CI, CircleCI, AppVeyor, etc)
• Check if test coverage services work (e.g. Coveralls, Codecov, etc)
• Add jazzband account to PyPI project as maintainer role (URL: https://pypi.python.org/pypi?:action=role_form&package_name=<PROJECTNAME>)
• Add jazzband-bot as maintainer to the Read the Docs project (URL: https://readthedocs.org/dashboard/<PROJECTNAME>/users/)
• Fix project URL in GitHub project description
• Review project if other services are used and port them to Jazzband

Project details

Description	OAuth2 goodies for the Djangonauts!
Homepage	http://dot.evonove.it/
Stargazers	1242
Open issues	105
Forks	404
Default branch	master
Is a fork	False
Has Wiki	False
Has Pages	False

[jezdez]

@synasius Hey there, about the homepage http://dot.evonove.it/, it'd be best to move that to GitHub pages and set up a redirect from the old URL.

[jleclanche]

The README also has a reference to a security email which is not maintained by jazzband. @jezdez how does jazzband usually handle security issues?

[jezdez]

@jleclanche We don't go into detail about the response time etc (by design), but there is also an email address: https://jazzband.co/security

[synasius]

@jezdez Sure we can move the homepage to github pages!

[synasius]

@jezdez I just checked and dot.evonove.it is already on Github Pages using a custom domain
here is the pubic repository https://github.com/evonove/dot.evonove.it

[jleclanche]

@synasius iirc we can move it to a gh-pages branch on the django-oauth-toolkit repo and thatll get picked up automatically.

[jezdez]

@jleclanche That'd be great, yeah.

[synasius]

@jezdez @jleclanche I just pushed the gh-pages branch. I guess we need to set it up in the repo's settings

[jezdez]

Hmpf, it's enabled, but I think https://help.github.com/articles/user-organization-and-project-pages/ makes it clear it needs to live in an own repo called django-oauth-toolkit.github.io, which isn't something we should do to make maintenance easier. Instead, please let's just move the page into a Sphinx project or something, it's just not worth the exception to have separate repos for the static pages.

[synasius]

@jezdez thought it should be available under http://jazzband.github.io/django-oauth-toolkit

Project Pages sites are connected to a specific project, and the site files live on a branch within the project repository.

[jezdez]

Uh, lemme check again..

[jezdez]

Okay, changing the source and resaving it worked at least for the rendering: https://jazzband.github.io/django-oauth-toolkit/

That said, a few questions:

1. The content of the branch seems to be the static output from the https://github.com/evonove/dot.evonove.it repo, which is not what we want, since it's hard to maintain it without the original content.

2. The paths in the static files are still linking to the old URL.

Unless there is an easy (read: trivial for me) way to maintain this I'm going to have to decline hosting the static site. Instead, please move the content to the Sphinx docs so we can use ReadTheDocs for automated rendering. The goal is to have as little maintenance burden going forward as possible.

[jleclanche]

The content of the branch seems to be the static output from the https://github.com/evonove/dot.evonove.it repo, which is not what we want, since it's hard to maintain it without the original content.

gh-pages don't support hugo so we'll probably have to convert to jekyll

[n2ygk]

See #101

[jezdez]

I think this is done, please let me know if there is anything else needed for the GitHub pages bit to be fixed.