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(README): Document how to test an in-development version of Baseplate in Snoodev #756

Merged
merged 3 commits into from
Nov 18, 2022

Conversation

KTAtkinson
Copy link
Contributor

Closes #

πŸ’Έ TL;DR

πŸ“œ Details

Design Doc

Jira

πŸ§ͺ Testing Steps / Validation

βœ… Checks

  • CI tests (if present) are passing
  • Adheres to code style for repo
  • Contributor License Agreement (CLA) completed if not a Reddit employee

@KTAtkinson KTAtkinson marked this pull request as ready for review October 20, 2022 00:36
@KTAtkinson KTAtkinson requested a review from a team as a code owner October 20, 2022 00:36
@KTAtkinson KTAtkinson requested review from nsheaps, aba-ca-xi and ghirsch-reddit and removed request for aba-ca-xi October 20, 2022 00:36
README.md Outdated
@@ -47,3 +47,25 @@ actions on push.
Specific hooks can be [temporarily disabled](https://pre-commit.com/#temporarily-disabling-hooks).

You can install hooks only for a specific step (i.e. [pre-push](https://pre-commit.com/#pre-commit-during-push)).

# Testing in Snoodev
Copy link
Contributor

Choose a reason for hiding this comment

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

πŸ”• Not against it here, and these instructions seem fine, but seems a little strange to me for this to be here but testing sidecars to be in the wiki

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Note that talks about how to release sidecars and then test them, not how to test them locally. Also currently this approach doesn't work with sidecars.

Copy link
Member

Choose a reason for hiding this comment

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

πŸ”• nit: Multiple top-level headings in the same document

In this case the ref can be either a commit hash or a branch name. After making
this update you can check if the service works in Snoodev.

> **Warning**
Copy link
Contributor

Choose a reason for hiding this comment

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

TIL markdown syntax formats this

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I had to look it up :D

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Co-authored-by: Ryan Balfanz <[email protected]>
@KTAtkinson KTAtkinson merged commit 3ebe86c into develop Nov 18, 2022
@KTAtkinson KTAtkinson deleted the katie-atkinson-document-test-process branch November 18, 2022 00:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

4 participants