cocoapods / cocoapods.org

That website https://cocoapods.org/ - pretty useful

cocoapods.org

Setup

Ideally this website should be run through a sub-folder of Strata.

1. Clone a copy of Strata and run rake clone. Or if you just want this website rake clone["cocoapods.org"].
2. Run rake db:migrate in Strata to update the database to the latest version.
3. Add a .env file with in CocoaPods.org ENVIRONMENT variables, see sample.env.

Alternatively, direct set up:

1. git clone [email protected]:CocoaPods/cocoapods.org.git && cd cocoapods.org
2. rake bootstrap

Running

1. bundle exec rake serve

The server will run on http://localhost:3000

Things to note

• Large scale design changes should be discussed in a new issue first.
• By default the server will use the production search database in a development environment. This is so you don't have to run your own instance of search.

What is this?

This app is a Sinatra app. We use slim as a templating language, and flounder as our ORM against the trunk database.

A lot of the logic around search is based on work from @floere in picky. All of the CocoaPods-specific parts of search are in search.config.js.

cocoapods.org's Issues

Platform selector should not disappear when selecting a platform that has no results

This creates a very poor user experience if a visitor selects a platform that has no search results for the chosen platform, but did for the previous one.

I suggest we keep the platform selector above the search results as all times.

Another suggestion in relation to this is to display the number of pods found for each of the platforms inside the actual platform selector. Could improve usability.

Publish via Travis CI

http://blog.mathieu-leplatre.info/publish-your-pelican-blog-on-github-pages-via-travis-ci.html

Github stars next to CocoaPod listings

Could be useful so you can see at a glance which CocoaPods are most widely used.

e.g.:

pod search platform filter should be sticky

When searching for pods, the platform filter should remember what I've previously selected.

Awesome new site 👍

About page should have link to twitter profiles.

The icon for copy a pod dependency is not retina

SEARCH text field on cocoa pods.org not always obvious that it's a text field

This is from someone who has not been to the cocoapods.org page before.

I looked around the page and I must have clicked somewhere because then when I wanted to do a search of cocoa pods I scrolled back up to the top of the page and there was no visual clue that the red "SEARCH_" text was actually an edit text field. After looking around for an editable search field I tried clicking on the red "SEARCH_" text.

I think there needs to be an extra visual clue that the search field is an editable text field. Is cocoa pods trying to mimic iOS 7 because if so that could be my problem as I don't have a device with iOS 7.

[Search] Inserting : only works at the end of a string

If you insert a : before the end of a string it won't be included and you have to hit enter before it is.

Step's to reproduce:

1. Go to http://cocoapods.org.
2. Enter OPENSSL into the search.
3. Move your cursor to the start and type PODS:.

Expected behaviour:

My search should be for PODS:OPENSSL showing just OpenSSL's result.

Actual Behaviour

SORRY. NO PODS FOUND.

Example:

docs not pointing properly

See background at CocoaPods/CocoaPods#1273. For projects that use documentation_url, this should link to the external docs, not to cocoadocs.org.

Results should check that they are what the query still is before showing

Ideally this shouldn't be possible

After selecting a platform, using "back" is not possible anymore.

CocoaPods accounts still have the old logo on GitHub

• The organisation
• The bot

Platform picker loses link cursor/pointer while going over the text secion

The platform filter (iOS, OSX, etc) displays an anchor mouse pointer when hovering over the background section, however when going over the label, the pointer disappears, making it seem like its not click-able.

Darker search background doesn't load sometimes

Sometimes the darker background doesn't load and there is un-readable text:

I cannot reproduce it all the time. Looks like some kind of timing issue. Perhaps the results loads before the style? Is that possible?

Issues with search

As discussed with @alloy on Twitter I'm having issue with searching for a pod.

The network tab in Chrome's dev tools shows that repeated requests (apparently it's retrying) for http://search.cocoapods.org/api/v1/pods.picky.hash.json?query=transformerkit&ids=20&offset=0 are failing.

Also, http://cocoapods.org/javascripts/jquery-2.0.3.min.map is failing but may be unrelated.

Move web fonts to S3

https://twitter.com/grillitype/status/419181047956250624

Keeps them out of plain sight.

Buggy search behavior when search term includes a plus

Try searching for "Parse+NSCoding". As soon as you enter the plus key it removes it from the query, causing it to fail. Also, searching for "NSCoding" alone should return this spec, but it does not.

Able to replicate on:
Safari 6.1.1 on OSX 10.8.5
Chrome 32.0.1700 on Windows 7 SP1
IE 11.0.9600 on Windows 7 SP1

Suggested dependency should not lock minor version

The suggested dependency locks the minor version:

pod 'AFNetworking', '~> 2.2.0'

This is not desirable because, according to SemVer, the minor version should be backwards compatible. Therefore it would be more appropriate to lock only the major version.

pod 'AFNetworking', '~> 2.2'

Use grunt?

It's what all the web dev kids do nowadays.
And then we can use https://github.com/addyosmani/grunt-uncss which could save us a lot of download time initially.

Search results are missing copy to clipboard functionality

Could be implemented using the ZeroClipboard by itself, or via the jquery.clipboard plugin wrapper.

I suggest we use a simplistic icon to indicate the copy action, or follow the example of the div.os style, except display it only on hover, and with eg. a lighter background.

Clipboard version number is truncated and separated by comma instead of period

his happens in multiple browsers on multiple platforms. Confirmed in Safari & Chrome on Mac and IE and Chrome on Windows.

Support up &down arrow keys and pressing return to load site

CocoaDocs does this pretty well, but doesn't scroll when offscreen.

plugins JSON should include owner metadata, names / twitter etc

https://github.com/CocoaPods/cocoapods.org/blob/master/data/plugins.json

Hitting “search” on mobile should hide keyboard

otherwise you have to scroll

Keep labels to filter

When I select a label to filter a category (name, author, summary...), all the labels get lost.

Wonder if it could be like the OS labels, just highlighting the clicked label.

beta.cocoapods.org

Very good work guys. The new website will be awesome. Only two suggestions while you are developing or in beta:

• expose the libraries version number on search result
• expose download number or number of people are using library (if it's possible). This is useful for new people who are looking to decide which lib is best to use.

Don't know if github issue is the right place for these suggestions.
bye
marco

CocoaPods logo is offset when active

The non-active image needs to be offset the same amount.
The edges of the text feels harder too, perhaps an issue with scaling at some point?

Firefox

The search field is slightly broken in Firefox (works but hint is not displayed, and neither is the X to clear the field).

About page avatars should link to GitHub profiles

I'm referring to the avatars presented in the Contributors to the CocoaPods Projects section.

Download Statistics for Pods

Layout issue in the multiple projects section of the about page

The title doesn't fit the box.

Problems with Chrome

• The X button when searching doesn't work in Chrome. Just try to search something, then click the X button, and it doesn't work. Works in Safari. There's already an issue with Firefox.
• Suddenly, links stop working and I have to reset the website. When I do a couple of searches, links stop responding, when I click in any button or link it just doesn't work and I have to reload the website. I know that is a little weird, I'll try to reproduce it with more computers.

Copy to clipboard error

Search doesn't match results properly

When searching for "omniauth", I can't find any pods, but with "omni" I can find the SHOmniAuth pod I was looking for.

The search sections should not display duplicates

The PODS WITH SUMMARY section often displays many of the results included in the PODS NAMED section. This creates noise which doesn’t allow to see easily if there is any pod not matched by the name which might be interesting.

An implementation could be to define an order of importance (the current vertical ordering would do fine) for the various sections and just don’t display a pod if it was already included in a more important section.

New Design Feedback

Just throwing in my 2¢ about the new CocoaPods.org:

In general, I don’t like your new design for the site. I think that the color scheme is too glaring. The current color scheme on Cocoadocs, reminiscent of the old CocoaPods.org, is much better.

In addition, the new logo is horrible. Not only does it not suggest “CocoaPods”, it also looks too small, too blurry, and annoyingly off-balance. I liked the old logo better (as currently visible on the CocoaPods org page). If you want to improve the existing logo instead of changing back to the old one, I would get rid of the bright-red background behind the “Cocoa” part of the logo, leaving everything else as-is.

On the other hand, I really like the design and functionality of the new site’s search box. I couldn’t have come up with anything better myself. Excellent!

What is CocoaPods?

This should be on the index.

Support showing deprecation warnings in results

See CocoaPods/Core#87

Platform "segmented control" cursor should be changed to pointer

I believe we should change the cursor to a pointer, just because that's how clickable things should work.

Off topic: Is there a chat or something small things like this could be discussed? I feel like that would be a nicer way for me to give my input.

GRMustache 7.0.0 documentation won't generate

Hello,

http://cocoadocs.org/docsets/GRMustache/7.0.0 returns a 404 error, even after clicking the regenerate button.

I have myself generated GRMustache reference using the last appledoc installed by homebrew, without any trouble: http://groue.github.io/GRMustache/Reference/

The cocoapods doc for v6.9.2 is online at http://cocoadocs.org/docsets/GRMustache/6.9.2/, so I guess I have introduced changes to the doc that your own appledoc doesn't like. Please ask for further information if you need any.

Platform selector sticks around on "no pods found"

Search 1.2

Which has a slot machine like cycle through a shuffled hardcoded list of pods ( we once generated a list of the most popular via search results, so we could have the top 15 in there ( plus any of ours cause I'm all into self promotion ) )

Ideally we want to make some more affordances for obviousness, there's a few options:

• Add blinking underscore
• always have a blinking bar on the left edge ( right now deselecting gets rid of that entirely )
• Add a search loupe before the cycling pod names

I have no major preference, and would be open to trying any and then re can try another and get a feel for it.

FWIW the original mockups had a loupe.

About structure

About

• Blurb about CocoaPods made in x by y, then z helped etc - 2 paragraphs
• Show Dev team, reduce the size of these maybe
• Show Sponsors logos
• Show core commiters

Will ping @andymyers / @andyrmyers
Think a great example of this is http://www.vagrantup.com/about.html

Make changes to highlighted semantic versioning in search results

Eloy D. orta: I’ve been thinking about the ~> 0.0 thing and I’m not sure it’s a good idea.
Because until v1 semver specifically states you cannot expect backward compatibility.
orta If we do '> x.y.z', we might as weel just do 'x.y.z'
Eloy D. No, bugfixes are still bugfixes.
orta so you think 1.0.0+ gets '> x.y", but otherwise we do 'x.y.z' ?
Eloy D. Ideally we would do ~> x.y.z if the version is < 1.0.0. If the version is >= 1.0.0 then it makes sense to do ~> 1.0.

Navigation selection state isn't correct on Home / About

This is due to the logic in here not working in this repo correctly.

I've struggled to have the shared_include function include context about the current page but I think that's the way it should be done.

Create a Mediapack

logos, urls, colors, font choice etc

What does 'Either OS' do?

On the new beta we have four options:

• Either OS
• iOS & OSX
• iOS
• OSX

What does 'Either OSX' do? I guessed that it meant "Any OS" ? . . 'Either OS' seems redundant with 'iOS & OSX'

Add a Favicon

We should have a nice little icon there :)

Badges

Apparently NPM has some new cool badges, we should catchup. Badges are like emoji and are the foundation of good software.

I vote for something along the following lines

The install and docs button are separated static images were only the link is customized. Install links to a page in cocoapods.org which features with a big font and allows to copy the following line:

pod 'ObjectiveSugar', '~> 1.0.0'

The sketch file used for the preview is available here: http://cl.ly/2l0W1c2s1B2w.

Correctly use platform hint in URL to set toggle button

This:
http://beta.cocoapods.org/?q=on%3Aios%20highlight
does not result in the platform toggle button to be set to iOS at the moment.