Updated documentation #173

Merged
merged 1 commit into from Apr 4, 2015

Conversation

Projects
None yet
3 participants
@ashfurrow
Contributor

ashfurrow commented Apr 2, 2015

So you asked for feedback on the setup process, and I thought some updates to the documentation might help other developers get set up. There is a tonne of awesome information in this repo, but it seems to have grown organically over time, so it's not necessarily the most organized.

There were two goals I had in mind for this pull request:

  • Make the README more of a sales pitch: "this is what fastlane is, this is why it's useful, this is how to install it, and here's where to go for more information."
  • Make the documentation easy to find, read, and reference.

I made some major changes to accomplish these goals:

  • Moved the documentation into a new /docs directory.
  • Moved a lot of the README into the /docs/README.md file, which is parsed by GitHub when you look at that directory.
  • Moved a lot of the README into other, more specific markdown files in the /docs directory.
  • Reorganized the Actions.md file to group all the actions into one of several categories: Building, Testing, Deploying, Modifying Project, Developer Portal, Using git, and Notifications. Keeping all of these straight was actually one of the biggest challenges for me when I was setting up fastlane, so hopefully this makes things easier.

There're also some smaller things I changed throughout, like consistently ending lists with periods, consistent capitalization, and consistent use of H1, H2, H3 in markdown files. I almost certainly missed some of these, but it's a start.

You can preview any changes on my fork.

This is just an idea of how things could be – really looking forward to hearing your feedback. If you like something, we can more more in that direction. If you don't like something, we can change it.

@orta

This comment has been minimized.

Show comment
Hide comment
@orta

orta Apr 2, 2015

Contributor

With them separated out you can also use these markdown files to generate a guides page on your website

Contributor

orta commented Apr 2, 2015

With them separated out you can also use these markdown files to generate a guides page on your website

@ashfurrow

This comment has been minimized.

Show comment
Hide comment
@ashfurrow

ashfurrow Apr 3, 2015

Contributor

Updated docs for add_git_tag based on #175

Contributor

ashfurrow commented Apr 3, 2015

Updated docs for add_git_tag based on #175

@KrauseFx

This comment has been minimized.

Show comment
Hide comment
@KrauseFx

KrauseFx Apr 3, 2015

Member

Hey Ash,

First off, thank you for working on this. It is super helpful and will help a lot of users.

Introducing the /doc directory is a great idea. I love how you improved and re-worked some poorly written sentences and code examples.

The Actions.md is perfect! I love it 😍

I'd like to move the fastlane Toolchain entry from the docs/README.md to the project's README.

While you're at it, you can add a few links to eidolon as real world example setup 👍

Thanks again for working on this, really appreciated 🚀

Member

KrauseFx commented Apr 3, 2015

Hey Ash,

First off, thank you for working on this. It is super helpful and will help a lot of users.

Introducing the /doc directory is a great idea. I love how you improved and re-worked some poorly written sentences and code examples.

The Actions.md is perfect! I love it 😍

I'd like to move the fastlane Toolchain entry from the docs/README.md to the project's README.

While you're at it, you can add a few links to eidolon as real world example setup 👍

Thanks again for working on this, really appreciated 🚀

@ashfurrow

This comment has been minimized.

Show comment
Hide comment
@ashfurrow

ashfurrow Apr 3, 2015

Contributor

Awesome, glad you feel it fits. Moving the fasten Toolchain back into the main README makes sense. I'll get it pushed up shortly.

Contributor

ashfurrow commented Apr 3, 2015

Awesome, glad you feel it fits. Moving the fasten Toolchain back into the main README makes sense. I'll get it pushed up shortly.

@KrauseFx

This comment has been minimized.

Show comment
Hide comment
@KrauseFx

KrauseFx Apr 4, 2015

Member

I think it's ready to merge, right? Anything missing from your side? 👍

Member

KrauseFx commented Apr 4, 2015

I think it's ready to merge, right? Anything missing from your side? 👍

@ashfurrow

This comment has been minimized.

Show comment
Hide comment
@ashfurrow

ashfurrow Apr 4, 2015

Contributor

All good to me!

Contributor

ashfurrow commented Apr 4, 2015

All good to me!

KrauseFx added a commit that referenced this pull request Apr 4, 2015

@KrauseFx KrauseFx merged commit 974f2dd into fastlane:master Apr 4, 2015

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
@KrauseFx

This comment has been minimized.

Show comment
Hide comment
@KrauseFx

KrauseFx Apr 4, 2015

Member

Thank you so much 👍

Member

KrauseFx commented Apr 4, 2015

Thank you so much 👍

maclover7 pushed a commit to maclover7/fastlane that referenced this pull request Dec 14, 2015

Merge pull request #173 from milch/patch-2
Added instructions for device boot timeout to README

@fastlane fastlane locked and limited conversation to collaborators Feb 4, 2017

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