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
71 stars 116 forks source link

[doc issue] Inconsistent casing for configuration options in doc #105

Closed ziyang-works closed 3 months ago

ziyang-works commented 6 months ago

Issue description

I was browsing through sample code from the documents and wanted to find clarification for some configuration options used for UI5 loading. However, I was unable to find some configuration options used in sample code from Configuration Options and URL Parameters.

Upon further investigation, I realize the issue was inconsistent casing. The documentation presented sample code lines with camelCase or lowercase for options, whereas Configuration Options and URL Parameters exclusively showcased kebab-case.

I find it would be easier for me (and fellow UI5 beginners) if all sample code in the documentation uses the same casing convention for configuration options.

Example samples not using kebab-case:

Step 1: Ready...:

    <script id="sap-ui-bootstrap"
        src="https://sdk.openui5.org/resources/sap-ui-core.js"
        data-sap-ui-theme="sap_belize"
        data-sap-ui-libs="sap.m"
+       data-sap-ui-resourceroots='{"Quickstart": "./"}'
+       data-sap-ui-onInit="module:Quickstart/index"
+       data-sap-ui-compatVersion="edge"
        data-sap-ui-async="true">
    </script>

We can find more relevant pages by searching for resourcingroots, onInit, or compatVersion in doc.

Example:

image

Feedback Type (Optional)

examples or samples

Page Title on SAP Help Portal (prefilled)

Configuration Options and URL Parameters

Page URL on SAP Help Portal (prefilled)

https://sapui5.hana.ondemand.com/sdk/#/topic/91f2d03b6f4d1014b6dd926db0e91070

KvM2 commented 6 months ago

Hi @ziyang-works , thanks for your contribution . We appreciate it and will look into this.

KlattG commented 5 months ago

Hi @ziyang-works , 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 3 months ago

Hi @ziyang-works , we have added a note explaining the new casing convention and are currently busy harmonizing the casing in our sample code. I expect the issue to be fixed in the next release. Kind regards Günter