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

[docs] modernize markdown syntax of auto-generated README documentation #19643

Merged
merged 2 commits into from
Dec 10, 2021

Conversation

rogerluan
Copy link
Member

@rogerluan rogerluan commented Nov 25, 2021

Checklist

  • I've run bundle exec rspec from the root directory to see all new and existing tests pass
  • I've followed the fastlane code style and run bundle exec rubocop -a to ensure the code style is valid
  • I've read the Contribution Guidelines
  • I've updated the documentation if necessary.

Motivation and Context

This PR modifies the behavior of the README.md generator (the one that generates documentation for your lanes, under fastlane/README.md directory).

Since this doc generator was written (probably haha) the markdown syntax has evolved a bit, and the generated docs don't follow markdown best practices (of leaving line breaks around headers and code snippets, for instance), causing some markdown parsers (like MacDown) to not parse them properly.

Description

I've modernized the markdown syntax, and made minor changes to the messages. I also removed manual (duplicated) fastlane installation instructions, pointing users to our latest documentation at https://docs.fastlane.tools/#installing-fastlane (which strongly suggests using bundler).

Testing Steps

To test this branch, modify your Gemfile as:

gem "fastlane", :git => "https://github.com/fastlane/fastlane.git", :branch => "rogerluan-modernize-docs-generation"

And run bundle install to apply the changes.

@google-cla google-cla bot added the cla: yes label Nov 25, 2021
@rogerluan rogerluan changed the title [docs] Modernize Markdown Syntax of Auto-Generated README Documentation [docs] modernize markdown syntax of auto-generated README documentation Nov 25, 2021
Copy link
Member

@joshdholtz joshdholtz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is 🔥 Thank you for updating this!

@joshdholtz joshdholtz merged commit 5d55364 into master Dec 10, 2021
@rogerluan rogerluan deleted the rogerluan-modernize-docs-generation branch December 10, 2021 02:27
@fastlane-bot
Copy link

Hey @rogerluan 👋

Thank you for your contribution to fastlane and congrats on getting this pull request merged 🎉
The code change now lives in the master branch, however it wasn't released to RubyGems yet.
We usually ship about once a week, and your PR will be included in the next one.

Please let us know if this change requires an immediate release by adding a comment here 👍
We'll notify you once we shipped a new release with your changes 🚀

Copy link

@fastlane-bot fastlane-bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Congratulations! 🎉 This was released as part of fastlane 2.199.0 🚀

@fastlane fastlane locked and limited conversation to collaborators Feb 9, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants