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

Harmonize project name #4035

Merged
merged 2 commits into from
May 27, 2020
Merged

Harmonize project name #4035

merged 2 commits into from
May 27, 2020

Conversation

waldyrious
Copy link
Member

Follow-up of #1109, in particular of this comment.

I've already updated/renamed the wiki pages (see here, here and here).

If I may add: now that I went through all the places where we used "tldr-pages" (with hyphen) and replaced them with "tldr pages" (with a space), I am now convinced that removing the hyphen is a the wrong direction to do the normalization, as it makes all the phrases where the project name appears more ambiguous. A good brand/name should achieve, if anything, the opposite!

Considering that the discussion in #1109 actually never produced a clear decision regarding the hyphenization of the project name (it was merely a no-consensus, as described here), I'm inclined to make the reverse change in this PR, i.e. normalize everything towards tldr-pages. I'll wait for others to chime in before doing so, but please review the diff of commit ca3cca5 to inform your comments.

@agnivade
Copy link
Member

I don't have any strong opinions. tldr-pages looks fine to me.

@waldyrious waldyrious marked this pull request as draft May 11, 2020 10:16
@waldyrious
Copy link
Member Author

Marked this as a draft to ensure it isn't merged until we make a decision. @zdroid does your approval mean you are OK with me changing to tldr-pages (with hyphen), as I mentioned above?

@zlatanvasovic
Copy link
Contributor

zlatanvasovic commented May 11, 2020

I'm approving any change that standardizes the project's name. Either work fine. Perhaps tldr-pages makes it more clear we are talking about the organization, while tldr pages is just plural of tldr page.

@ivanhercaz
Copy link
Collaborator

@waldyrious, I am totally agree with changing to tldr-pages (with hyphen), at least it is what has more sense for me. As @zdroid indicated in the previous message, tldr pages seems like a plural of a tldr page, while tldr-pages sounds like a real project name!

@ivanhercaz ivanhercaz added the decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc. label May 11, 2020
Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree, I think tldr-pages is better than tldr pages as a brand name.

@waldyrious
Copy link
Member Author

Alright, I'll make the change to tldr-pages then 👍

@waldyrious
Copy link
Member Author

This is now ready for review, but I'd like your input about related changes that I held off making yet: should we also rename the following items?

  • tldr.pdf --> tldr-pages.pdf
  • tldr.zip --> tldr-pages.zip
  • lint-tldr --> lint-tldr-pages (package.json script)

I suppose they should mostly be safe except perhaps the tldr.zip filename, but do let me know if I'm missing something regarding the other two.

Also: when merging, please use the rebase method so that the formatting tweaks commit isn't mixed up with the name standardization one.

@zlatanvasovic
Copy link
Contributor

tldr-pages.zip can be kept for the new pages structure.

@zlatanvasovic
Copy link
Contributor

@waldyrious tldr-pages.github.io should be updated too. I tried to do a part of the job in tldr-pages/tldr-pages.github.io@43a767b.

@mebeim
Copy link
Member

mebeim commented May 18, 2020

@waldyrious indeed the ZIP filename is pretty hard to rename. Many clients use it and renaming it would definitely break those. We could keep it as is and it also kind of makes sense to me since the client programs are always named tldr, not tldr-pages anyway, so it seems consistent with that.

Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again, @waldyrious 😺

@waldyrious
Copy link
Member Author

waldyrious commented May 21, 2020

@zdroid, @mebeim, @sbrl: no objections to including the following renames in this PR, then?

  • tldr.pdf --> tldr-pages.pdf
  • lint-tldr --> lint-tldr-pages (package.json script)

@zlatanvasovic
Copy link
Contributor

@waldyrious Those includes are alright.

@mebeim
Copy link
Member

mebeim commented May 21, 2020

@waldyrious oh sorry I slipped over them, those are fine to me :)

@waldyrious
Copy link
Member Author

waldyrious commented May 23, 2020

Alright, I've added the two renames mentioned above. Ready to merge at your discretion!

(ps - make sure to use the "rebase" option to keep the unrelated cleanup commit separate from the name normalization one)

Copy link
Member

@sbrl sbrl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, looks great to me! Thanks, @waldyrious 😺

@zlatanvasovic zlatanvasovic merged commit 75b9a11 into master May 27, 2020
@zlatanvasovic
Copy link
Contributor

Geronimo!

@zlatanvasovic zlatanvasovic deleted the project-name branch May 27, 2020 20:22
@waldyrious waldyrious mentioned this pull request Jun 21, 2020
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
decision A (possibly breaking) decision regarding tldr-pages content, structure, infrastructure, etc.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants