kairos-io/kairos

Expand webui tests to cover docs

Open

#1,583 opened on Jul 5, 2023

View on GitHubContributor guide
 (5 comments) (0 reactions) (1 assignee)Go (133 forks)github user discovery
cidocumentationenhancementgood first issuehacktoberfesthelp wanted

Repository metrics

Stars
 (1,782 stars)
PR merge metrics
 (Avg merge 2d 3h) (14 merged PRs in 30d)

Description

kairos-agent bundles the docs Also runs some webui basic tests

But we bundle the docs as well and we are not even checking if you can access them properly

We should expand the webui docs to at least:

  • Check that the docs link is there in the webui
  • Check that we can follow the link and get to the docs page
  • Maybe check a bit around the docs page to see if navigation is proper? At least to the basic pages like getting started and configuration or something to make sure that not only the index is working but also the subpages

Contributor guide

Research direction
Examine the existing webui test files to understand the testing framework and add test cases for verifying the docs link and its subpages.
Tech stack
go
Domain
frontendtesting
Issue type
Test
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75