encode / django-rest-framework

Web APIs for Django. 🎸
https://www.django-rest-framework.org
Other
28.53k stars 6.85k forks source link

Bootstrap 3 templates for the browsable API #1085

Closed hnarayanan closed 10 years ago

hnarayanan commented 11 years ago

I would like to migrate the templates in django-rest-framework to correspond to updates in Bootstrap 3. I did this for a personal site some months ago before Bootstrap 3 was released, and I am now in the process of updating those changes to 3.0.0. When ready, I would like to publish those changes so that it will be useful for others as well.

Is there some interest in this? I will submit a pull request if there is.

tomchristie commented 11 years ago

Sounds good to me. Maybe worth including screenshots of before and after on this ticket, so we can see how different it looks.

philipdouglas commented 11 years ago

I am interested in this. I had a go at doing it using just the replaceable blocks in the templates, but it wasn't possible.

Is there anything I can help with to make this happen?

hnarayanan commented 11 years ago

I am still working on this sporadically, but would like some input because the scale of the changes. Which of the following do you guys believe is easier to review (and thus more likely to be accepted in the main source tree):

a. A clean rewrite of the templates starting with best practices from the Bootstrap 3 documentation, and styling it to look like the current templates. b. A collection of incremental changes to the current templates to migrate them to Bootstrap 3, potentially leaving behind some legacy stuff that isn't relevant for the newer CSS.

tomchristie commented 11 years ago

I'm really not in a position to comment as I've not looked into what would be needed to port the templates across.

I'm not massively fussed about 'best practise' so long as it all works nicely on different screen sizes and looks good.

On 30 Sep 2013, at 12:44, Harish Narayanan notifications@github.com wrote:

I am still working on this sporadically, but would like some input because the scale of the changes. Which of the following do you guys believe is easier to review (and thus more likely to be accepted in the main source tree):

a. A clean rewrite of the templates starting with best practices from the Bootstrap 3 documentation, and styling it to look like the current templates. b. A collection of incremental changes to the current templates to migrate them to Bootstrap 3, potentially leaving behind some legacy stuff that isn't relevant for the newer CSS.

— Reply to this email directly or view it on GitHub.

hnarayanan commented 11 years ago

Thank you for the input. I will return to this starting with a rewrite rather than trying to migrate the current theme in small pieces.

carltongibson commented 11 years ago

I've migrated a couple of sites already. It wasn't too tough in the end.

Following the migration guide I found converting the class names to strip the -fluid — and making sure to update any custom CSS was about it.

I'd be inclined to just start with a fresh skeleton and then copy/paste the content blocks across (modifying as necessary).

tomchristie commented 11 years ago

Given that there's nothing actually broken with the current templates, I'm going to close this off. If someone proactively takes on a redesign based on Bootstrap 3 I'd be more than happy to consider a PR for it, but until that point I don't want to consider this as something that necessarily needs to be done.

tomchristie commented 10 years ago

Reopening, now that we have an active PR addressing this in #1873.

tomchristie commented 10 years ago

Now addressed in the upcoming version 3.0.