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

Simplify README to recommend default setup and refer to docs #1815

Merged
merged 1 commit into from
Jul 31, 2023

Conversation

henrymercer
Copy link
Contributor

  • Recommend default setup by default :)
  • Refer to the docs for setting up advanced setup, rather than recommending a multi-language DB build. Customers will get a better experience setting up a matrixed build for repos with multiple languages.
  • Configuration information re the config file and the config input is now included in the docs. Refer to the docs rather than duplicating that information here.

Merge / deployment checklist

  • Confirm this change is backwards compatible with existing workflows.
  • Confirm the readme has been updated if necessary.
  • Confirm the changelog has been updated if necessary.

@henrymercer henrymercer requested a review from a team as a code owner July 28, 2023 16:33
Copy link
Contributor

@angelapwen angelapwen left a comment

Choose a reason for hiding this comment

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

Also looks good to me ✨

Copy link
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

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

The changes look good to me. Thanks for the ping ✨

We're going to be changing some of these docs URLs, but we'll have redirects in place as usual for the short term.

I'll create an issue for us to update the URLs once the next stage of the docs refactoring is complete.

@henrymercer henrymercer merged commit 245422d into main Jul 31, 2023
342 checks passed
@henrymercer henrymercer deleted the henrymercer/update-readme branch July 31, 2023 10:56
@github-actions github-actions bot mentioned this pull request Aug 8, 2023
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants