Skip to content

Conversation

@kayx23
Copy link
Contributor

@kayx23 kayx23 commented May 21, 2025

  1. Update CRD doc title and description in the template. Initially was planning to mention supported Gateway API and Ingress resources in the same doc; but now these content are separated.
  2. Update template with more string substitution to avoid the need of manual editing after generation.
  3. Remove unused Addresses section from configure.md which is a missed update from fix: remove gateway config items from the config file. #96

Type of change:

  • Bugfix
  • New feature provided
  • Improve performance
  • Backport patches
  • Documentation
  • Refactor
  • Chore
  • CI/CD or Tests

What this PR does / why we need it:

Pre-submission checklist:

  • Did you explain what problem does this PR solve? Or what new features have been added?
  • Have you added corresponding test cases?
  • Have you modified the corresponding document?
  • Is this PR backward compatible? If it is not backward compatible, please discuss on the mailing list first

@github-actions
Copy link
Contributor

github-actions bot commented May 21, 2025

conformance test report

apiVersion: gateway.networking.k8s.io/v1
date: "2025-05-21T10:02:22Z"
gatewayAPIChannel: standard
gatewayAPIVersion: v1.2.0
implementation:
  contact: null
  organization: APISIX
  project: apisix-ingress-controller
  url: https://github.com/apache/apisix-ingress-controller.git
  version: v2.0.0
kind: ConformanceReport
mode: default
profiles:
- core:
    result: partial
    skippedTests:
    - HTTPRouteHTTPSListener
    - HTTPRouteInvalidCrossNamespaceBackendRef
    - HTTPRouteInvalidReferenceGrant
    - HTTPRoutePartiallyInvalidViaInvalidReferenceGrant
    - HTTPRouteReferenceGrant
    statistics:
      Failed: 0
      Passed: 28
      Skipped: 5
  name: GATEWAY-HTTP
  summary: Core tests partially succeeded with 5 test skips.

@kayx23 kayx23 changed the title docs: update CRD doc title and description docs: update CRD doc title & description; update template with more replace May 21, 2025
{{- else -}}
{{- /* First replace makes paragraphs separated, second merges lines in paragraphs. */ -}}
{{ $field.Doc | replace "\n\n" "<br /><br />" | replace "\n" " " }}
{{ $field.Doc | replace "\n\n" "<br /><br />" | replace "\n" " " | replace " *" "<br /> •" | replace "<br /><br /><br />" "<br /><br />" }}
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Before:

Screenshot at May 21 17-23-59

After:

Screenshot at May 21 17-23-26

@kayx23 kayx23 changed the title docs: update CRD doc title & description; update template with more replace docs: update CRD doc template and remove dated info from configuration file doc May 21, 2025
controllerName: "apisix.apache.org/apisix-ingress-controller"
```
### Addresses
Copy link
Contributor Author

@kayx23 kayx23 May 21, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this section should be removed. It was missed out from #96.

@kayx23 kayx23 merged commit 683bd4f into release-v2-dev May 22, 2025
9 checks passed
@kayx23 kayx23 deleted the fix-doc-title branch May 22, 2025 03:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants