canonical/open-documentation-academy

Netplan: Add guidance on testing how-to results

Open

#104 opened on Jun 21, 2024

View on GitHub
 (2 comments) (0 reactions) (1 assignee)Python (99 forks)auto 404
help wantedhow-tonewsize 3

Repository metrics

Stars
 (119 stars)
PR merge metrics
 (PR metrics pending)

Description

Context

Three of the how-to guides for Netplan feature very similar scenarios, and all of them conclude with the user having configured some bridges and/or bonds. These are the how-tos:

At the end of each how-to, the user is asked to test the new set up, but specific instructions on how to perform such test or verification is missing.

Task

Either develop the content (instructions) on how to test the new configuration at the end of each how-to and include it in the how-tos, or find suitable instructions in other docs and link to them (such as in existing Netplan how-tos).

Note: It is rather probable that the same instructions on testing the new configuration will apply to all three of the how-tos.

Reference

Contributor guide

Research direction
Review the three linked how to guides and existing Netplan docs for verification steps. If a shared testing approach exists, add or link to it at the end of each guide. Focus on simple network commands like 'ip', 'bridge', and 'ping'.
Tech stack
None
Domain
documentationnetworking
Issue type
Documentation
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