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

add definition for cds.env.features #5

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

Conversation

arleytm
Copy link

@arleytm arleytm commented Dec 8, 2023

No description provided.

@arleytm arleytm self-assigned this Dec 8, 2023
@arleytm arleytm marked this pull request as ready for review December 8, 2023 12:05
apis/env.d.ts Outdated
*/
serve_on_root: boolean,

with_mocks: boolean,
Copy link
Contributor

Choose a reason for hiding this comment

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

This is only mentioned in an archive article on CAPire. Still should we link it for completeness sake?
https://cap.cloud.sap/docs/releases/archive/2021/dec21#developer-experience

apis/env.d.ts Outdated Show resolved Hide resolved
apis/env.d.ts Outdated
/**
* @private
*/
hybrid_instance_manager: boolean,
Copy link
Contributor

Choose a reason for hiding this comment

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

apis/env.d.ts Outdated
/**
* @private
*/
keys_in_data_compat: boolean,
Copy link
Contributor

Choose a reason for hiding this comment

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

apis/env.d.ts Outdated
/**
* @private
*/
skip_unused: false | "all",
Copy link
Contributor

Choose a reason for hiding this comment

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

apis/env.d.ts Outdated
/**
* @private
*/
with_parameters: boolean
Copy link
Contributor

Choose a reason for hiding this comment

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

Copy link
Contributor

@daogrady daogrady left a comment

Choose a reason for hiding this comment

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

Thank you for adding in these types! Looks pretty clean to me -- see my few nits and suggestions, but they are no blockers imo.

Regarding the missing documentation links: this may actually be a wakeup call that CAPire is incomplete in this regard. I don't think users should have to refer to change logs for reference. So this is probably more a gap in our documentation. @johannes-vogel what do you think?

@daogrady daogrady marked this pull request as draft December 11, 2023 09:54
apis/env.d.ts Outdated Show resolved Hide resolved
@arleytm arleytm marked this pull request as ready for review December 11, 2023 10:21
@arleytm
Copy link
Author

arleytm commented Dec 11, 2023

this may actually be a wakeup call that CAPire is incomplete in this regard. I don't think users should have to refer to change logs for reference.

This was a process issue in the cds runtime that was addressed recently. Records of internal CDS changes within the changelogs were maintained in the past. This inadvertently led to internal feature toggles being documented. For that reason, internal change logs are now kept separate from the public ones.

The perception is that a feature toggle can be utilized if documented in CAPire without any disclaimer. Otherwise, why document the feature toggle in the first place?

@arleytm
Copy link
Author

arleytm commented Dec 11, 2023

@johannes-vogel is working in a PR to close this documentation gap.

@daogrady
Copy link
Contributor

Sorry for the late reply. Johannes and I discussed this PR earlier and came to the conclusion, that we want to at least postpone this PR until all features are officially documented. So I changed it to draft for now.

@chgeo chgeo marked this pull request as draft December 12, 2023 11:14
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.

2 participants