openshift / openshift/node-feature-discovery

s390x CPU features not documented in 'quick start'

Open
#29 19 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/bug lifecycle/frozen
Dominant language
Go
Stars
18
Forks
37
Avg merge
9h 38m
Merged PRs (30d)
14

Description

What happened:

Opened https://github.com/openshift/node-feature-discovery/blob/master/docs/get-started/features.md

What you expected to happen:

Expect to see CPU feature documentation for s390x architecture

How to reproduce it (as minimally and precisely as possible):

Open https://github.com/openshift/node-feature-discovery/blob/master/docs/get-started/features.md

Anything else we need to know?:

The s390x CPU features are defined in https://github.com/openshift/node-feature-discovery/blob/master/source/internal/cpuidutils/cpuid_s390x.go

Environment:

  • Kubernetes version (use kubectl version): browser
  • Cloud provider or hardware configuration: Z15 KVM Cluster
  • OS (e.g: cat /etc/os-release): RHEL 8.3
  • Kernel (e.g. uname -a): N/A
  • Install tools: N/A
  • Network plugin and version (if this is a network-related bug): N/A
  • Others:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with docs/get-started/features.md and compare its CPU feature documentation with source/internal/cpuidutils/cpuid_s390x.go. Document the s390x CPU features defined by the source in the quick-start features guide, then verify that the guide covers the expected Z15 KVM case.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.