Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Ingress Docs Misgenerated #6028

Open
cfitzw opened this issue Jan 13, 2025 · 6 comments
Open

Ingress Docs Misgenerated #6028

cfitzw opened this issue Jan 13, 2025 · 6 comments
Labels
area/documentation Documentation task

Comments

@cfitzw
Copy link
Contributor

cfitzw commented Jan 13, 2025

What happened?

As per #5996, the documentation generated the depreciation method on the new paths versus the old path.

The PR looks correct.

Steps to reproduce

See NEXT documentation:

https://camel.apache.org/camel-k/next/traits/ingress.html

Relevant log output

Camel K version

No response

@cfitzw cfitzw added the kind/bug Something isn't working label Jan 13, 2025
@squakez
Copy link
Contributor

squakez commented Jan 13, 2025

Not sure to understand which the issue is. I can see the documentation correctly report the deprecation notice.

@squakez
Copy link
Contributor

squakez commented Jan 13, 2025

Ah, ok, I got it, it would be paths that has to be used instead of path.

@squakez
Copy link
Contributor

squakez commented Jan 13, 2025

@cfitzw can you take care of it?

@squakez squakez added area/documentation Documentation task and removed kind/bug Something isn't working labels Jan 13, 2025
@cfitzw
Copy link
Contributor Author

cfitzw commented Jan 14, 2025

I re-reviewed the PR #5996, and the only thing that stands out is:

camel-k/helm/camel-k/crds/camel-k-crds.yaml --> line 31184-31188 got accidentally repeated and could be deleted.

  path:
    description: |-
      To configure the path exposed by the ingress (default `/`).
      Deprecated: In favor of `paths` - left for backward compatibility.
    type: string

HOWEVER, when I look at main branch now, in this same file, I see the depreciated text is incorrectly applied everywhere under paths, which differs from PR...

Could that duplicated block have caused this, even though everything in the PR otherwise looked correct?

Please advise.

@squakez
Copy link
Contributor

squakez commented Jan 14, 2025

The problem is here:

// Deprecated: In favor of `paths` - left for backward compatibility.

We need to put that line on the path field instead.

@cfitzw
Copy link
Contributor Author

cfitzw commented Jan 14, 2025

Copy. I'll submit a PR.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Documentation task
Projects
None yet
Development

No branches or pull requests

2 participants