Skip to content

Documents updates with alias names#1936

Merged
venmanyarun merged 4 commits intoOpenLiberty:mainfrom
sajeerzeji:GH1676-Document_parameter_alias_names
Oct 30, 2025
Merged

Documents updates with alias names#1936
venmanyarun merged 4 commits intoOpenLiberty:mainfrom
sajeerzeji:GH1676-Document_parameter_alias_names

Conversation

@sajeerzeji
Copy link
Contributor

Fixes #1676

Updated

common-parameters.md and common-server-parameters.md to document both the alias names and actual parameter names.

Changes Made

docs/common-parameters.md
runtimeArchive: Added actual parameter name assemblyArchive in parentheses
runtimeArtifact: Added actual parameter name assemblyArtifact in parentheses
runtimeInstallDirectory: Added actual parameter name assemblyInstallDirectory in parentheses

docs/common-server-parameters.md
serverXmlFile: Added alias name configFile in parentheses
serverEnvFile: Added alias name serverEnvFile in parentheses

Copy link
Member

@cherylking cherylking left a comment

Choose a reason for hiding this comment

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

We do not want to document these old names for configuration. The new configuration names were part of the 3.0 release when we had a lot of changes in configuration. If you have a valid reason to document them, it should be in some separate paragraph that explains the new names should be used but the old names are still supported.

@cherylking
Copy link
Member

See documentation for the 3.0 release here.

Sajeer and others added 2 commits October 29, 2025 12:42
@sajeerzeji
Copy link
Contributor Author

sajeerzeji commented Oct 29, 2025

We do not want to document these old names for configuration. The new configuration names were part of the 3.0 release when we had a lot of changes in configuration. If you have a valid reason to document them, it should be in some separate paragraph that explains the new names should be used but the old names are still supported.

Hi @cherylking I have updated the documents by adding separate section for Backward compatibility parameters

@venmanyarun venmanyarun merged commit 2c866fd into OpenLiberty:main Oct 30, 2025
30 of 36 checks passed
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.

Document parameter alias names

3 participants