Skip to content

Add classifier FAQ, link to from filters #3484

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

Merged
merged 4 commits into from
Apr 4, 2018
Merged

Add classifier FAQ, link to from filters #3484

merged 4 commits into from
Apr 4, 2018

Conversation

nlhkabu
Copy link
Contributor

@nlhkabu nlhkabu commented Mar 31, 2018

Closes #3452

screenshot from 2018-03-30 20-38-44

screenshot from 2018-03-30 20-38-37

@nlhkabu nlhkabu requested a review from brainwane March 31, 2018 06:48
Copy link
Contributor

@brainwane brainwane left a comment

Choose a reason for hiding this comment

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

Sorry for not taking the time to run this branch myself, but:

I get that we're pointing the user to the help page anchor ("Each project's maintainers....") when clicking on the "?" icon. Do we do that with just a regular link or do we do anything fancy here like open a new little window/tab? Either way is fine, just trying to assess.

@@ -55,6 +56,7 @@ <h1 class="page-title">Common Questions</h1>
<h2 class="faq-group__first"><a href="#basics">Basics</a></h2>
<ul>
<li><a href="#packages">{{ packages() }}</a></li>
<li><a href="#trove-classifier">{{ trove_classifier() }}</a></li>
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd put the trove classifier item below "How do I package and publish my code for PyPI?".

<h3 id="trove-classifier">{{ trove_classifier() }}</h3>

<p>Each project's maintainers provide PyPI with a list of "trove classifiers" to categorize each release, describing who it's for, what systems it can run on, and how mature it is.</p>
<p>These classifiers can then be used by community members to find projects based on their desired criteria.</p>
Copy link
Contributor

Choose a reason for hiding this comment

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

I showed this wording to another maintainer (my spouse Leonard, thanks Leonard!) and he suggested:

These standardized classifiers can then be used

so let's do that to get across that they're standardized across the community.

Copy link
Contributor

@brainwane brainwane left a comment

Choose a reason for hiding this comment

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

Sorry, my previous review should have been "request changes".

@nlhkabu nlhkabu self-assigned this Apr 2, 2018
@nlhkabu
Copy link
Contributor Author

nlhkabu commented Apr 3, 2018

Updated and ready to re-review @brainwane. The link is just a standard link (opens in the same tab). This is how our other help tooltips currently work. If we want to change this, I think we should make a separate PR to change all at the same time.

Copy link
Contributor

@brainwane brainwane left a comment

Choose a reason for hiding this comment

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

Thanks!

@brainwane brainwane merged commit 95f37b5 into master Apr 4, 2018
@brainwane brainwane deleted the classifier-info branch April 4, 2018 17:10
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.

2 participants