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

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

Closed
ziyang-works opened this issue Jan 1, 2024 · 3 comments
Closed
Assignees
Labels
contribution Valuable Contribution follow-up-with/po Clarification with product owner needed. type/outdated Something is outdated in the documentation.

Comments

@ziyang-works
Copy link

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
Copy link
Contributor

KvM2 commented Jan 4, 2024

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

@KvM2 KvM2 assigned KvM2 and KlattG and unassigned KvM2 Jan 4, 2024
@KlattG
Copy link
Contributor

KlattG commented Jan 31, 2024

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 KlattG added the follow-up-with/po Clarification with product owner needed. label Feb 15, 2024
@KlattG
Copy link
Contributor

KlattG commented Mar 26, 2024

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

@KlattG KlattG closed this as completed Mar 26, 2024
@KlattG KlattG added the contribution Valuable Contribution label Mar 26, 2024
@KlattG KlattG added the type/outdated Something is outdated in the documentation. label Apr 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution Valuable Contribution follow-up-with/po Clarification with product owner needed. type/outdated Something is outdated in the documentation.
Projects
None yet
Development

No branches or pull requests

3 participants