Skip to content
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

Separate actions and tools? #652

Closed
janpio opened this issue Aug 1, 2018 · 9 comments · May be fixed by #657
Closed

Separate actions and tools? #652

janpio opened this issue Aug 1, 2018 · 9 comments · May be fixed by #657

Comments

@janpio
Copy link
Member

janpio commented Aug 1, 2018

Currently e.g. both supply and upload_to_play_store are listed as "Actions" and have very similar documentation:

https://docs.fastlane.tools/actions/supply/
https://docs.fastlane.tools/actions/upload_to_play_store/

But in reality supply is a command line tool that offers fastlane supply, fastlane supply init and similar commands, while upload_to_play_store is an action that can be used to do part of the CLI functionality via lanes (and is historically also available as the action alias supply).

This applies to other tools and actions as well, of course.

In my opinion the fastlane docs would benefit from separating these two different concepts more clearly:

  • Add new "Tools" menu option on the left
  • Separate tool and action documentation, move supply, gym etc. to Tools
  • Tools is a new overview page list similar to the Actions list, that explains what it is all about and lists the tools in a list or table
@janpio
Copy link
Member Author

janpio commented Aug 1, 2018

Thoughts on separating both:

Current state:

  1. https://docs.fastlane.tools/actions/sigh/
  2. https://docs.fastlane.tools/actions/get_provisioning_profile/

Both have approx. same content: Some manual sigh docs, then the normal get_provisioning_profile action docs.

Possible future state:

  1. https://docs.fastlane.tools/tools/sigh/
  2. https://docs.fastlane.tools/actions/sigh/
  3. https://docs.fastlane.tools/actions/get_provisioning_profile/
  • 1 has the manual sigh docs, with focus about CLI usage. It has a new prominent link to 3 that explains how to use its functionality via an action.
  • 2 has links to both 1 and 3 explaining that the CLI usage is via the tool, action usage via get_provisioning_profile. It is clearly "depromoted" in the list of actions as "deprecated" or similar.
  • 3 does not have the tool stuff any more, but a new prominent link to 1 that mentions that setup etc is done with the tool.

@janpio
Copy link
Member Author

janpio commented Aug 1, 2018

Having the action docs removed from the tool page, it would enable us to add some interesting information:

  • Commands list
  • Parameters list (probably quite identical to that of action?)
  • Configuration file

@janpio
Copy link
Member Author

janpio commented Aug 1, 2018

With extracted tool documentation, fastlane could get rid of the special handling of some action documentation where an additional markdown file is attached before the actual action docs. These markdown files would then be used for the new tools docs.

@janpio
Copy link
Member Author

janpio commented Aug 1, 2018

How could/should navigation work for tools?

  • Similar to "Actions", we don't want to list all the tool names all the time.
  • But when you are on the page of a tool, "Tools" definitely should be highlighted.
  • As tools are not that numerous, we can even list all available tools in the navigation when on the Tools page or on an individual tool.
  • When on an individual tool page, the headlines of the document can also directly be shown in the navigation.

@janpio
Copy link
Member Author

janpio commented Aug 1, 2018

The connected PR has most of this implemented for demonstration:

All the new content of course would need some serious improvement, and it would all probably benefit very much from an "Introduction to fastlane" article where lanes, actions, tools etc are explained.

@taquitos
Copy link
Collaborator

taquitos commented Aug 1, 2018

Maybe where we talk about alias we should make it known that people aren't expected to understand aliases.
Like, Advanced fastlane users: ___ is an alias for ___

Whereas right now, we just mention what tools have what aliases. It's probably not clear to noobs that they can ignore that.

@janpio
Copy link
Member Author

janpio commented Aug 1, 2018

A bit OT, but: For brand new users, aliases shouldn't be relevant at all. Only for the old timers we should have some backwards compatibility available so they have the necessary context available.

@janpio janpio added the question label Aug 2, 2018
@janpio janpio changed the title Separate actions and tools Separate actions and tools? Aug 2, 2018
@janpio
Copy link
Member Author

janpio commented Aug 2, 2018

I was convinced via Slack that this is not the way to go - tools are just actions.

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

Successfully merging a pull request may close this issue.

2 participants