Add documentation_url attribute to Specification DSL. #1273

Closed
fabiopelosin opened this Issue Aug 9, 2013 · 15 comments

Comments

Projects
None yet
4 participants
Owner

fabiopelosin commented Aug 9, 2013

No description provided.

Owner

fabiopelosin commented Aug 9, 2013

The proposed solution would be to introduce the documentation_url attribute (to avoid confusion with the deprecated documentation). If a Pod specifies a value for it the CocoaPods web properties will use that url as the documentation link. Moreover if this value has been specified the CocoaDocs will display a prominent notice indicating the canonical URL for the documentation.

incanus commented Oct 25, 2013

How is this used? It's not documented and it's not working on http://cocoapods.org/?q=mapbox (first result, the SDK) as changed in 280be09.

Member

keith commented Oct 25, 2013

Not 100% sure but the changelog makes it look like it's still just part of the master branch, not yet into the tool. https://github.com/CocoaPods/CocoaPods/blob/a15b69f7471e31db15228e897c71b7730d187215/CHANGELOG.md#master

incanus commented Oct 25, 2013

I'm seeing it in the tool -- or at least, it lints ok and says that the old 'documentation' is deprecated now.

Member

keith commented Oct 25, 2013

I reverted it since it isn't linting alright at all right now on Travis CocoaPods/Specs@d6c4e24

Owner

orta commented Oct 27, 2013

weird

Owner

fabiopelosin commented Oct 28, 2013

I think that we just need to update the bundle of the specs repo.

Member

keith commented Oct 28, 2013

Interesting, is the only purpose for it having a Gemfile at all because of Travis builds? If so we could probably delete the lock file so it would install the newest version on each run?

Owner

fabiopelosin commented Oct 28, 2013

I prefer to have some control on it. There have been a couple of situations where having the gem locked to a specific versions was handy. I.e. cleaning up the repo before introducing a stricter check or avoid using a bugged release versions. Also having the gemfile is useful for linting locally otherwise you could be using an outdated version of CocoaPods.

I think that the best approach is to update the bundle while we update the last know version (part of the release task), for the time being (i.e. before 1.0) this could be the best approach.

Member

keith commented Oct 28, 2013

Sounds good, should I update this now until the next release?

Owner

fabiopelosin commented Oct 28, 2013

@keithbsmiley 👍 I updated it locally but didn't push because there are a couple of Pods which need whitelisting (example homepage) and I won't have time.

Member

keith commented Oct 28, 2013

Hmm, I'm having trouble with building native extensions, so if someone else has a chance to make that happen

fabiopelosin added a commit to CocoaPods/Specs that referenced this issue Oct 28, 2013

incanus added a commit to CocoaPods/Specs that referenced this issue Dec 18, 2013

incanus commented Dec 18, 2013

I've updated my podspec per above but cocoapods.org is still linking to http://cocoadocs.org/docsets/MapBox/1.0.3/ as before. Any ideas?

Owner

orta commented Dec 18, 2013

This should go on the beta.cocoapods.org repo

Sent from my iPhone

On 18 Dec 2013, at 07:15, "Justin R. Miller" notifications@github.com wrote:

I've updated my podspec per above but cocoapods.org is still linking to http://cocoadocs.org/docsets/MapBox/1.0.3/ as before. Any ideas?


Reply to this email directly or view it on GitHub.

@incanus incanus referenced this issue in CocoaPods/cocoapods.org Dec 19, 2013

Closed

docs not pointing properly #23

umjames added a commit to umjames/Specs that referenced this issue Jan 27, 2014

umjames added a commit to umjames/Specs that referenced this issue Jan 27, 2014

incanus added a commit to CocoaPods/Specs that referenced this issue Jan 30, 2014

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment