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

Formatting for books with many versions #2353

Closed
eshellman opened this issue May 10, 2017 · 5 comments
Closed

Formatting for books with many versions #2353

eshellman opened this issue May 10, 2017 · 5 comments
Labels
👥 discussion This Repo is guided by its community! Let's talk!

Comments

@eshellman
Copy link
Collaborator

Many books, especially manuals, have an edition for every version of the software. Some of our lists are presenting one entry per version(for example PR #2350 ), others are only listing the latest version, sometimes a single link for multiple versions is presented.

What's the best way for these to be listed? When is a version so old we should omit it? Should the the practice be different for different language lists?

@eshellman eshellman added the 👥 discussion This Repo is guided by its community! Let's talk! label May 19, 2017
@scraggo
Copy link
Contributor

scraggo commented Aug 30, 2017

I agree, I think they should be visually grouped. Here's a thought: sublists, most recent book first. One example:

@eshellman
Copy link
Collaborator Author

that seems reasonable. Could you take a look at what the linter says about that? https://github.com/vhf/free-programming-books-lint

@scraggo
Copy link
Contributor

scraggo commented Aug 31, 2017

I changed my mind, making the latest version the toplist element and the previous versions the sublist elements. I'll do a PR and you can tell me what you think. The linter didn't find any issues :)

For reference: PR #2517

eshellman pushed a commit that referenced this issue Sep 2, 2017
* Python books: Formatting for multiple editions

* added ref to issue 2353

* .
eshellman pushed a commit that referenced this issue Sep 20, 2017
* Python books: Formatting for multiple editions

* added ref to issue 2353
@eshellman
Copy link
Collaborator Author

Thanks everyone who contributed, the suggestions are now implemented!

benjnse pushed a commit to benjnse/free-programming-books that referenced this issue Dec 5, 2017
…oundation#2521)

* Python books: Formatting for multiple editions

* added ref to issue 2353

* .
benjnse pushed a commit to benjnse/free-programming-books that referenced this issue Dec 5, 2017
…bookFoundation#2517)

* Python books: Formatting for multiple editions

* added ref to issue 2353
ruimartinsptl pushed a commit to ruimartinsptl/free-programming-books that referenced this issue May 22, 2019
…oundation#2521)

* Python books: Formatting for multiple editions

* added ref to issue 2353

* .
ruimartinsptl pushed a commit to ruimartinsptl/free-programming-books that referenced this issue May 22, 2019
…bookFoundation#2517)

* Python books: Formatting for multiple editions

* added ref to issue 2353
@tunggnu
Copy link
Contributor

tunggnu commented Feb 16, 2021

I have found an issue. When we have a title with more than 3 editions, we can't list them in descending chronological order, due to the rule "titles must be in alphabetical order".

For example, in the #5299 PR, my first commit could not pass Travis CI because it contains:

I have to make a new commit to rearrange the editions and add 1st Edition to the title of the 1st edition to meet the rule "titles must be in alphabetical order".

The new commit passed the Travis-CI but the old editions are not in descending chronological order.

Are you okay with ascending chronological order of old editions? If not, you should limit the rule "titles must be in alphabetical order" to level 1 titles only.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
👥 discussion This Repo is guided by its community! Let's talk!
Projects
None yet
Development

No branches or pull requests

3 participants