Closed orta closed 11 years ago
General notes:
Anyone with push access can edit the above, and I encourage it. With some discussion below.
This is damn fine work, Orta. I’ll respond over the coming week, right now I need to enjoy some more sun :)
:+1:
edit: maybe a section with code-style and documentation rules would be helpful. Not sure if you've planned to include that in
:+1: @mneorr on those. Adding!
Also should be a section on doing pull requests, versus once you have push access? Not sure if that's important for public guides.
In addition, we should define a system for tagging issues and actually use it. Cocoapods/Cocoapods seems to have one, but the other repos don't.
@mtitolo I think once the push web app is up that shouldn't pose an issue for the specs repo.
Tagging Issues system makes sense
:+1: Terrific work @orta. I love how defined the different sections in term of user questions.
Togglable sections of documents, to hide long bits of supplementary info
I'm not sure whether I agree with this one. I would prefer to have links in dedicated pages which cover a topic in depth if needed. The documentation that you linked as good examples appear to do that.
Unfortunately, until we don't ship and app (and this might take a while) we need also a guide about how to install CocoaPods. Many users have issues with it.
I went through the current guides. Here's where I think they fit in to the new guides structure:
Awesome, perhaps it makes sense to try and get all this into one doc that we can edit and then start to chop out bits once the copy is in place?
Awesome, perhaps it makes sense to try and get all this into one doc that we can edit and then start to chop out bits once the copy is in place?
When you do that, be sure to simply delegate certain topics to @irrationalfab and me where you think it makes sense.
@orta https://gist.github.com/mtitolo/5470833 - Mainly just reformatted current guides. There are several TODOs.
@irrationalfab @alloy If either of you could help with content for the "What are the main components" section, that would be great =)
@mtitolo Will do. Do you think this info is intended only for developers that want to work on CP, or is it also meant for casual readers?
Only contribution.md is for people wanting to work on Cocoapods the ruby app itself, everything else is for casual readers.
After some discussion, @orta and I agreed to move guides into a separate subdomain. This will be handled with Cocoapods/guides.cocoapods.org#1.
Ace :star2:
Update: This will be handled with Cocoapods/guides.cocoapods.org#1.
I want to use Cocoapods
I want to make a Cocoapod
I want to hack on Cocoapods
Ways to keep this sane, we will need to have:
Useful navigation tools:
Good examples:
Not so good example: