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

Documentation for KUDO test harness. #359

Merged
merged 4 commits into from
Jun 20, 2019

Conversation

jbarrick-mesosphere
Copy link
Member

What type of PR is this?

/kind documentation

What this PR does / why we need it:

Adds documentation for the KUDO test harness.

Which issue(s) this PR fixes:

Fixes #340

Special notes for your reviewer:

Depends on kudobuilder/operators#23

Does this PR introduce a user-facing change?:

* Initial release of KUDO test harness for testing Frameworks and KUDO.

@@ -1,7 +1,7 @@
---
title: Community
type: docs
weight: 5
weight: 6
Copy link
Member Author

Choose a reason for hiding this comment

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

I thought it made sense to put this after the Frameworks Repository in the list.

docs/testing.md Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
docs/testing.md Outdated Show resolved Hide resolved
@orsenthil
Copy link
Contributor

@jbarrick-mesosphere : It feels like this document with the concentration on frameworks should be in frameworks repo instead of the kudo repo.

What do you think about this structure:

  1. Explaining integration test of kudo. Giving as much detail as required, but focused on integration testing kudo.

  2. Explaining framework test, and giving a link to entire self-contained setup of framework tests in the framework repo, so that the read can follow the link and read about the test harness and test suite in the frameworks repo?

@jbarrick-mesosphere
Copy link
Member Author

@jbarrick-mesosphere : It feels like this document with the concentration on frameworks should be in frameworks repo instead of the kudo repo.

What do you think about this structure:

1. Explaining  integration test of kudo. Giving as much detail as required, but focused on integration testing kudo.

2. Explaining framework test, and giving a link to entire self-contained setup of framework tests in the framework repo, so that the read can follow the link and read about the test harness and test suite in the frameworks repo?

As this is the KUDO user documentation, if anything, we should be removing the integration test information and putting it in CONTRIBUTING.md or similar.

This is for the site: https://kudo.dev/docs/

@orsenthil
Copy link
Contributor

As this is the KUDO user documentation, if anything, we should be removing the integration test information and putting it in CONTRIBUTING.md or similar.

Got it. Yes, that will be better.

Testing KUDO itself, should be the README.md of the KUDO.

@jbarrick-mesosphere
Copy link
Member Author

As this is the KUDO user documentation, if anything, we should be removing the integration test information and putting it in CONTRIBUTING.md or similar.

Got it. Yes, that will be better.

Testing KUDO itself, should be the README.md of the KUDO.

How's it look now?

Copy link
Contributor

@orsenthil orsenthil left a comment

Choose a reason for hiding this comment

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

LGTM.

Thank you!

@jbarrick-mesosphere jbarrick-mesosphere merged commit 458605e into kudobuilder:master Jun 20, 2019
@jbarrick-mesosphere jbarrick-mesosphere deleted the test-docs branch June 20, 2019 21:45
@jbarrick-mesosphere jbarrick-mesosphere added this to In progress in KUDO via automation Jun 28, 2019
@jbarrick-mesosphere jbarrick-mesosphere added this to the v0.3.0 milestone Jun 28, 2019
@gerred gerred moved this from In progress to Done in KUDO Jun 28, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
KUDO
  
Done
Development

Successfully merging this pull request may close these issues.

Getting Started Testing Guide for FW authors
3 participants