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

Update README to point to docs website for setup instructions #208

Merged
merged 2 commits into from
May 20, 2022

Conversation

MikeGoldsmith
Copy link
Contributor

@MikeGoldsmith MikeGoldsmith commented May 18, 2022

Which problem is this PR solving?

Updates README to direct readers to Honeycomb docs for instructions on how to setup and use the distro. This helps ensure we have a single place to update documentation.

Short description of the changes

  • Update README to point to docs website instead of having local instructions

@MikeGoldsmith MikeGoldsmith added type: maintenance The necessary chores to keep the dust off. version: no bump A PR with maintenance or doc changes that aren't included in a release. labels May 18, 2022
@MikeGoldsmith MikeGoldsmith self-assigned this May 18, 2022
@MikeGoldsmith MikeGoldsmith marked this pull request as ready for review May 18, 2022 08:09
@MikeGoldsmith MikeGoldsmith requested a review from a team May 18, 2022 08:09
README.md Show resolved Hide resolved
@MikeGoldsmith MikeGoldsmith requested a review from vreynolds May 20, 2022 15:04
@MikeGoldsmith MikeGoldsmith merged commit 3c85352 into main May 20, 2022
@MikeGoldsmith MikeGoldsmith deleted the mike/update-readme branch May 20, 2022 17:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: maintenance The necessary chores to keep the dust off. version: no bump A PR with maintenance or doc changes that aren't included in a release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Readme still documents configuring dataset
2 participants