search

SAP-docs / sapui5

This is the markdown version of the official SAPUI5 documentation from the SAPUI5 Demo Kit for external contributions.
Creative Commons Attribution 4.0 International
84 stars 137 forks source link

Documentation missing for important `sap-ui-xx-viewCache` url parameter #102

Closed nicoschoenteich closed 6 months ago

nicoschoenteich commented 9 months ago

Issue description

Hi there,

I noticed that the sap-ui-xx-viewCache url parameter is not documented (at least not in this camel case form), although it is being used in a lot of samples and templates. While the sap-ui-xx-view-cache (in kebab case) parameter is documented (and seems to be doing the same thing), it is unfortunate that there are no useful hits when searching for sap-ui-xx-viewCache in the global search - despite this being one of the most used url parameters, especially during development. To further improve the search, I would also suggest to include the actual url parameters in their long form somewhere on the page (sap-ui-xx-viewCache), instead of just the short forms (xx-viewCache).

Best, Nico

Feedback Type (Optional)

content gaps

Page Title on SAP Help Portal (prefilled)

Deprecated and Experimental Configuration Options

Page URL on SAP Help Portal (prefilled)

https://sapui5.hana.ondemand.com/#/topic/b474a712ca364d40a1b0a804baf2d734

BorisDafov commented 9 months ago

Thank you for your feedback! We’ll look into it and come back to you if we have any questions.

KlattG commented 8 months ago

Hi @nicoschoenteich , thank you for your patience. We understand that an explanation of the switch from camel-case to kebab-case notation for the config options is required for our documentation. We are working on your concern and will be updating the documentation soon.

KlattG commented 6 months ago

Hi @nicoschoenteich , we have added a note explaining the new casing convention and are currently busy harmonizing the casing in our sample code. I expect our documentation to use consistent casing for the config parameters as of the next release. Kind regards Günter