Skip to content
This repository was archived by the owner on Nov 2, 2023. It is now read-only.

sort sections by 'programming language' #69

Merged
merged 2 commits into from
Jan 20, 2017
Merged

sort sections by 'programming language' #69

merged 2 commits into from
Jan 20, 2017

Conversation

agebhar1
Copy link
Contributor

The list of validators exceeds the visual part of the
»Software« page. In order to find the right (sub) list
sort it by 'programming language' with common order.

Non programming languages, mainly 'Online (web tool)',
were shifted to the end of the list.

@handrews
Copy link
Contributor

I sympathize with the layout problem but I strongly prefer to organize by use first. It highlights what the different uses are, which is what we want people to learn about JSON Schema (people already know about programming languages). What other layouts can we use to solve the problem?

@agebhar1
Copy link
Contributor Author

agebhar1 commented Jan 17, 2017

[...] organize by use first.

Did you mean that the current order is or should be based on the number of utilization?

@handrews
Copy link
Contributor

Er... no, I mean that I misunderstood what you were trying to do :-/
Sorry, this kind of diff is unavoidably a bit noisy and I skimmed it too fast.

I'm going to leave this for @Relequestual . I get your point but the alphabetical ordering pushes languages that tend to be less associated with JSON and JSON Schema up to the front which feels a bit odd.

Maybe we should just put in a sortable table rather than trying to figure out some single optimal presentation.

@agebhar1
Copy link
Contributor Author

👍 for sortable table

@Relequestual
Copy link
Member

Thanks for your effort on this. The worry about ordering being odd can be fixed by having a comma seperated list at the top of the section, which links to that section on the page. Would you be able to update your PR with this functionality please? Would be super appreciated!

@agebhar1
Copy link
Contributor Author

My pleasure! Temporarily I host a preview of this MR by GitHub Pages as a project page to be not confused by the diff @handrews ;)

@Relequestual am I right to drop the current commit in favour of adding a sorted list of programming languages (right under each section headline) which are links to the start of the specific list?

Would you be able to update your PR with this functionality please? Would be super appreciated!

I'd be glad to!

@Relequestual
Copy link
Member

@agebhar1 GREAT! Thanks for digging into this.

am I right to drop the current commit in favour of...

No, I was suggesting in addition to. I'm actually for logically clear ordering.
Thanks again =]

@handrews
Copy link
Contributor

Cool, if @Relequestual is for the new ordering than I'll support that- my objections were pretty weak to start with.

@agebhar1
Copy link
Contributor Author

Cool - I updated the preview with a 'button' area for all programming languages and introduce two new h3 headlines to distinguish libraries and online (tools). Thanks for your feedback!

@handrews
Copy link
Contributor

Ooh! could we get a button for the main sections? Only having a button for the languages within validators reinforces the impression that it's all about validators.

@Relequestual
Copy link
Member

The "main" section?

@agebhar1
Copy link
Contributor Author

[...] the "main" section?

I would say for 'Validators', 'Validator Benchmarks', 'Schema Generation' ... a 'table of content' (TOC)

The list of validators exceeds the visual part of the
»Software« page. In order to find the right (sub) list
sort it by 'programming language' with common order.

Non programming languages, mainly 'Online (web tool)',
were shifted to the end of the list.
@handrews
Copy link
Contributor

Yes- main sectionS (plural) is what I wrote, not singular. Validators, Validator Benchmarks', etc.

That will highlight the things that are really hidden, which I find far more important than languages.
@agebhar1 if you don't mind one more update that would be awesome. If you won't get to it for a while I'd be OK with merging this as is and then following up (but @Relequestual has to merge, I don't have permissions on this repo, only the other two).

@agebhar1
Copy link
Contributor Author

That will highlight the things that are really hidden, which I find far more important than languages.

I agree, a TOC should be added to get an impression on all (most) aspects of 'JSON Schema'. The heading 'Software' is maybe a bit misleading, but this should part of another issue.

I'm busy at the weekend and will have a look next week with pleasure. It's also possible from my side to split the MR into two parts - one for sorting by programming language(s) and another for TOC and programming language links/overview.

@Relequestual
Copy link
Member

OK. In the interest of improving what we have now, might as well merge this one and let you follow up with another when you're free to do so.

Thanks for your contribution =D

@Relequestual Relequestual merged commit aa9b176 into json-schema-org:master Jan 20, 2017
@agebhar1 agebhar1 deleted the feature/sort-implementations branch January 20, 2017 18:38
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants