apache / apache/accumulo-fluo-website

Create "test cases" to help users contribute to release testing

Open
#127 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
7
Forks
27
PR merge metrics
No merged PRs in 30d

Description

To help with release candidate testing, and to give people a way to give feedback who may not really be familiar with Fluo, we should have some test cases documented on the website, and linked to from the releasing section of our docs.

A test case is a simple series of instructions that tells a user exactly what to do, and what should happen. It should *NOT* be a HOWTO or instructions on what is going on. A test case is not intended to be a teaching tool (although users running test cases) may learn something... but *EXTREMELY* simple step-by-step instructions that requires no thought whatsoever to follow and report back the results.

Some examples of test cases can be found here on the [Fedora wiki][1]. Two simple ones are [opening PDFs in evince][2] and [verifying basic yum commands][3]. There are other examples, but I think these two represent the idea best. One provides simple instructions for testing a GUI application, and the other for CLI. What they have in common I think best represents the idea.

Good test cases will allow people to contribute to Fluo releases without knowing anything about Fluo.

[1]: https://fedoraproject.org/wiki/Category:Test_Cases
[2]: https://fedoraproject.org/wiki/QA:Testcase_evince_file_display
[3]: https://fedoraproject.org/wiki/QA:Testcase_Yum_basics

Contributor guide

Open the contributing guide

Research direction

Review the website's releasing section and the Fedora test-case examples linked in the issue. Define simple release-testing procedures that require no Fluo knowledge, document them on the website, and link them from the releasing documentation; done means users can follow each case and report the result.

Written by the indexing model from the issue text.

Assessment

Tech stack
jekyll
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
32/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.