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

[Test Case] - Test the Get Started guides #15129

Open
majakurcius opened this issue Aug 17, 2022 · 3 comments
Open

[Test Case] - Test the Get Started guides #15129

majakurcius opened this issue Aug 17, 2022 · 3 comments
Labels
area/documentation Issues or PRs related to documentation lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.

Comments

@majakurcius
Copy link
Contributor

majakurcius commented Aug 17, 2022

Summary

The purpose of the test is to make sure all the Get Started guides are up to date and working properly.

Test Steps

  1. Download the kubeconfig from Kyma.
  2. Go through the Get Started guides and make sure they are up to date and working properly.

CAUTION: Remember to test BOTH PATHS - CLI and Kyma Dashboard ❗ Just because one is working doesn't necessarily mean the other must be too. There might be new UI changes that haven't been accounted for, or some backend case that was not implemented in the UI, or a bug/typo in a CLI command, and so on.

Expected Results

All the tutorials are up to date and working properly.

@majakurcius majakurcius added area/documentation Issues or PRs related to documentation test-case lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. labels Aug 17, 2022
@Disper
Copy link
Member

Disper commented Sep 12, 2022

Suggested approach by @ameteiko:

How I would approach it, is:

  1. base the GSGs on the human readable End-to-End tests (preferably in Gherkin) written and supported by POs
  2. come-up with an automation test suite that runs the E2E tests from the step 1 on every GSG change and on every release
  3. establish a procedure for Technical Writers that reflects the scenarios from the E2E test suite in the GSGs

By doing this there is just one point of failure, which is the conformance of the human verbalisation in the GSG to the E2E test.
And an additional complexity of establishing the infrastructure and the orchestration for such a test suite that does not yet exists.

@Disper
Copy link
Member

Disper commented Sep 14, 2022

Two additional approaches

  • (Katakoda-like approach) Katakoda could be a nice tool that shows how to use Kyma, however it has been closed to public access recently. There is an alternative to it https://killercoda.com/creators but it would need to be further investigated.
  • (Very pragmatic approach) First, make sure that the parts of Get Started Guides are tested in the code. Either by having a separate test for the whole flow, or by finding already existing parts of code that is testing the same aspect as are steps in GSG. Add some comments that will remind people that are changing anything in the code to also verify if GSG are up to date. The work here can be split in the same way as GSG are split:

@Disper
Copy link
Member

Disper commented Sep 23, 2022

I will remove test-case label as this test case was split into a smaller tickets that are linked in the issue description.

@Disper Disper removed the test-case label Sep 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Issues or PRs related to documentation lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.
Projects
None yet
Development

No branches or pull requests

2 participants