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

Promote interactive tutorial through repository's description #247

Merged
merged 1 commit into from
Nov 20, 2018

Conversation

rigaspapas
Copy link
Contributor

No description provided.

README.md Outdated
@@ -5,6 +5,8 @@ Transifex Command-Line Tool
[![codecov](https://codecov.io/gh/transifex/transifex-client/branch/master/graph/badge.svg)](https://codecov.io/gh/transifex/transifex-client)
[![PyPI version](https://badge.fury.io/py/transifex-client.svg)](https://badge.fury.io/py/transifex-client)

[Learn how to use the Transifex CLI through an interactive tutorial](https://www.transifex.com/learn/txclient/)
Copy link
Member

Choose a reason for hiding this comment

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

Suggestion: Maybe we could create a new section called Usage and add

Click here for complete documentation on the Transifex Command-line Tool via our documentation site or learn how to use it through an interactive tutorial.

with a link to the interactive tutorial part.

The "Click here..." is in the Description section right now.
@rigaspapas @mikegianno @nelefth

Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion #1:
New section after Description called "Getting started with TX client"

Suggestion #2:
Whether you have experience with the Linux command line or not, this interactive tutorial is intended for everyone who wishes to learn how Transifex Client works. There is no need to download anything - Just click on the link provided above, and follow the instructions. Good luck!

For more information about TX client, please visit our documentation guide here.
@rigaspapas @codegaze @mikegianno

Copy link

Choose a reason for hiding this comment

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

@nelefth May I suggest we drop the "Linux" word from the Linux command line phrase? Just command line should be more than enough.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I updated this PR using Nina's suggestions. Can you please check again?

Copy link
Member

Choose a reason for hiding this comment

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

+1.
I would only omit the Good Luck part.

Copy link
Contributor

Choose a reason for hiding this comment

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

It looks good :)

@rigaspapas rigaspapas merged commit a80b2a3 into master Nov 20, 2018
@rigaspapas rigaspapas deleted the promote-tutorial branch November 20, 2018 11:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants