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

README: add link to PDF version #5185

Merged
merged 4 commits into from
Feb 3, 2021
Merged

Conversation

older-pack
Copy link
Contributor

@older-pack older-pack commented Jan 25, 2021

Added a reference to the PDF version at the start of the "How do I use it" section

Fixes #4975

Added a reference to the PDF version at the start of the "How do I use it" section
@CLAassistant
Copy link

CLAassistant commented Jan 25, 2021

CLA assistant check
All committers have signed the CLA.

@bl-ue bl-ue requested review from bl-ue and waldyrious January 25, 2021 21:41
@bl-ue bl-ue added the community Issues/PRs dealing with role changes and community organization. label Jan 25, 2021
Co-authored-by: bl-ue <54780737+bl-ue@users.noreply.github.com>
@bl-ue bl-ue changed the title Update README.md README: link PDF version Jan 25, 2021
Copy link
Contributor

@bl-ue bl-ue left a comment

Choose a reason for hiding this comment

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

Thank you @older-pack!!

@navarroaxel navarroaxel changed the title README: link PDF version README: add link to PDF version Jan 26, 2021
Co-authored-by: Axel Navarro <navarroaxel@gmail.com>
@bl-ue bl-ue requested a review from sbrl January 30, 2021 03:13
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'm wary of presenting the PDF version as the first option under "How do I use it", as it implies this is the preferred way of using tldr pages - when in reality I would think we prefer people to use the reference Node.js client. Would it be possible to swap the two around, to mention the reference client first, followed by the PDF version, and then the community clients list?

Alternatively, we could just add it to the list of clients?

@bl-ue
Copy link
Contributor

bl-ue commented Jan 31, 2021

I'd prefer switching them 👍🏻

@older-pack
Copy link
Contributor Author

If you'd prefer to add it to the list of clients instead that's fine by me.

I didn't intend it to be the first option, I just meant it as an easy way to have a quick look for the curious.
It was easier to just drop the sentence in front of the existing paragraph. But it really doesn't matter where it's listed.

Either way suits me, switch or just add to the list of clients (or if you don't want it on the README at all that's fine too).

@bl-ue
Copy link
Contributor

bl-ue commented Feb 1, 2021

I say switch them. That separates the node client from the rest, making it clear that it's the preferred method.

In case you're unsure how to edit README.md in this PR, you can click on your branch:

Screen Shot 2021-02-01 at 1 43 29 PM

and then click the pencil icon on the README, or you can simply click here.

@older-pack
Copy link
Contributor Author

older-pack commented Feb 3, 2021

Sorry guys, I'm clueless here 😬 I've zero experience editing via git. I presumed it was similar to wiki editing where anyone can make edits on top of edits. By that logic I thought sbrl would execute her idea on top of mine. I'm getting the vibe that I'm meant to implement @sbrl's proposal?

Copy link
Contributor

@bl-ue bl-ue left a comment

Choose a reason for hiding this comment

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

@older-pack it is very similar to the wiki editing. You can make edits on top of edits.

See my comment #5185 (comment). Please switch the two (the pdf and the node.js client) around. To edit the file as it is in this PR, see my comment. In it I provide two ways to edit the file, the first was is slightly more involved but will work for any PR on any repo, the second way is much simpler (just clicking a link.)

@bl-ue
Copy link
Contributor

bl-ue commented Feb 3, 2021

@older-pack to save you the trouble and because I thought of something else, I went ahead and made the switch for you :)

@bl-ue bl-ue merged commit e64ec92 into tldr-pages:master Feb 3, 2021
@older-pack
Copy link
Contributor Author

Sorry, I got back too late. The job's done. Thanks for making the edit. I'll stay away from making pull requests in future, I've no idea what's going on.

@bl-ue
Copy link
Contributor

bl-ue commented Feb 3, 2021

No problem @older-pack! You can always take a look at the GitHub docs for PRs in case you want to ;)

@older-pack older-pack deleted the patch-1 branch February 4, 2021 19:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
community Issues/PRs dealing with role changes and community organization.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

List the pdf version on the README.md
6 participants