-
Notifications
You must be signed in to change notification settings - Fork 523
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
Comments
Thoughts on separating both: Current state:
Both have approx. same content: Some manual Possible future state:
|
Having the action docs removed from the tool page, it would enable us to add some interesting information:
|
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. |
Notes on future maintenance: Relevant code:
|
How could/should navigation work for tools?
|
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. |
Maybe where we talk about Whereas right now, we just mention what tools have what aliases. It's probably not clear to noobs that they can ignore that. |
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. |
I was convinced via Slack that this is not the way to go - tools are just actions. |
Currently e.g. both
supply
andupload_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 offersfastlane supply
,fastlane supply init
and similar commands, whileupload_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 aliassupply
).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:
supply
,gym
etc. to ToolsThe text was updated successfully, but these errors were encountered: