django-vanilla-views icon indicating copy to clipboard operation
django-vanilla-views copied to clipboard

Docs at http://django-vanilla-views.org/ not up to date

Open adamchainz opened this issue 6 years ago • 12 comments

I just looked to adding this to a project, I was surprised to read that only Django up to 1.8 is supported on: http://django-vanilla-views.org/#requirements . This isn't the case on the repo, has the documentation build been failing?

adamchainz avatar Oct 02 '18 14:10 adamchainz

Hey @adamchainz.

I suspect it's just a mkdocs gh-deploy (or such) — but updating is needed. (Lack of bandwidth...)

I suspect it'd all just work with an update to tox.ini (and the readme). If you want to use your superpowers to bring it up-to-date that would be amazing!

carltongibson avatar Oct 03 '18 08:10 carltongibson

i.e. https://travis-ci.org/tomchristie/django-vanilla-views/builds/357418285 (is already 90% what's needed)

carltongibson avatar Oct 03 '18 08:10 carltongibson

tox.ini or .travis.yml?

adamchainz avatar Oct 03 '18 09:10 adamchainz

Ah, yes. My pet hate. 😄

Alas, the answer is probably both. (But we might argue we don't really need tox locally for development...)

carltongibson avatar Oct 03 '18 09:10 carltongibson

Just .travis.yml would be fine. I'd be okay with us dropping tox.

tomchristie avatar Oct 03 '18 09:10 tomchristie

I reckon it's worth us bringing this back up to date and getting it under the encode umbrella. https://github.com/encode/

tomchristie avatar Oct 03 '18 09:10 tomchristie

Can I do anything to help with move to encode/updating docs?

adamchainz avatar Oct 14 '18 16:10 adamchainz

Ok so I figured out changing the docs in #75 , #76, and #77. Currently it relies on running the mkdocs.py script in the repo (not mkdocs the tool, perhaps an early prototype @tomchristie ?) and copying the results over to the gh-pages branch as I did in #77. They're up to date now at least.

@tomchristie can you give me access to the repo settings, then I'll move them to HTTPS using the new free Lets Encrypt on github pages :)

adamchainz avatar Dec 29 '18 20:12 adamchainz

@adamchainz I don't think I can do that against a personal repo. What do you need, just enforcing HTTPS?

screenshot 2019-01-03 at 11 41 46

Settings currently look like this, I think it means I need to first update the DNS records.

tomchristie avatar Jan 03 '19 12:01 tomchristie

Fair enough, yeah you can't make me admin of a personal repo. And yes, it looks like you might need to go through custom domain setup to find some new DNS records to add, so they can LetsEncrypt.

adamchainz avatar Jan 14 '19 22:01 adamchainz

I've just updated the docs for the 1.1.0 release.

If you could check "Enforce HTTPS" @tomchristie that'd be neat.

adamchainz avatar Jun 15 '20 12:06 adamchainz

@tomchristie I appreciate you're busy - perhaps you could add me as collaborator on the repo so I can do this and not ask you for other things in the future?

adamchainz avatar Jul 08 '20 15:07 adamchainz