Documentation Enhancement Request: typeClassName Field in FunctionMesh CRDs
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- Half a day
- Newbie friendliness
- 45/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- kubernetes
- Domain
- documentation
Research direction
Open the Function CRD, Source CRD Config, and Sink CRD Config reference pages linked in the issue. Find the existing typeClassName entries and examples, then determine what explanation is missing from those references. Done means the field is documented consistently on all three pages.
Written by the indexing model from the issue text.
Description
Hi everyone!
I would like to request additional documentation for the typeClassName field that appears in FunctionMesh CRDs, particularly in Input/Output configurations for Functions, Sources, and Sinks. This field appears frequently in examples but is not properly documented in the following reference pages:
https://functionmesh.io/docs/reference/crd-config/function-crd
https://functionmesh.io/docs/reference/crd-config/source-crd-config
https://functionmesh.io/docs/reference/crd-config/sink-crd-config
- Dominant language
- Go
- Stars
- 228
- Forks
- 30
- Avg merge
- 2d 8h
- Merged PRs (30d)
- 2
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from streamnative/function-mesh
-
streamnative/function-mesh#811 · 1 assignee ·
-
streamnative/function-mesh#801 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
streamnative/function-mesh#796 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 25/100
streamnative/function-mesh#769 ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
streamnative/function-mesh#753 ·
All issues in streamnative/function-mesh
Similar issues
-
area/dev-productivity area/disaster-recovery area/ipcei kind/enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 70/100
-
Difficulty 1/5 Under an hour Newbie friendliness 85/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
kind/bug status/0-triage
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
-
🤔 refinement needed
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
equinor/radix-operator#1979 ·