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

Why are the docs not reflecting the CRD's #1958

Open
vmanikes opened this issue Nov 28, 2024 · 8 comments
Open

Why are the docs not reflecting the CRD's #1958

vmanikes opened this issue Nov 28, 2024 · 8 comments

Comments

@vmanikes
Copy link

What did you do to encounter the bug?
Steps to reproduce the behavior:
On the official docs for AtlasProject, the customRole should have a name called roleName https://www.mongodb.com/docs/atlas/operator/current/atlasproject-custom-resource/#mongodb-setting-spec.customRoles.roleName

But on the CRD its expecting name

What did you expect?
I expect docs and CRD's to have same field specifications

What happened instead?
Docs and CRD's differ in terms of documentation

Screenshots
If applicable, add screenshots to help explain your problem.

Operator Information

  • 2.5.0
@josvazg
Copy link
Collaborator

josvazg commented Nov 28, 2024

Thanks for the report @vmanikes !
Yep that seems to be a mistake in the docs, will report it internally to get it fixed.

@vmanikes
Copy link
Author

@josvazg Thank you. Are the docs internal to mongo or can they be fixed via a PR? I am interested to contribute to this if they can be fixed via a PR

@josvazg
Copy link
Collaborator

josvazg commented Nov 28, 2024

@josvazg Thank you. Are the docs internal to mongo or can they be fixed via a PR? I am interested to contribute to this if they can be fixed via a PR

Let me get back to you on that

@josvazg
Copy link
Collaborator

josvazg commented Nov 28, 2024

Sorry @vmanikes , but docs for this are internal only. No worries, though, we already created a ticket internally for this.

@vmanikes
Copy link
Author

Thank you @josvazg

@RafaelBroseghini
Copy link

what's the project's release cadence? When is 2.6.0 expected to land?

@josvazg
Copy link
Collaborator

josvazg commented Dec 19, 2024

what's the project's release cadence? When is 2.6.0 expected to land?

Release 2.6 is in progress now: #1958

Copy link
Contributor

This issue has gone 30 days without any activity and meets the project’s definition of 'stale'. This will be auto-closed if there is no new activity over the next 60 days. If the issue is still relevant and active, you can simply comment with a 'bump' to keep it open. Thanks for keeping our repository healthy!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants