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

Consolidate all usage of wiki ID within Meza #100

Open
Tracked by #99
freephile opened this issue Apr 26, 2024 · 1 comment
Open
Tracked by #99

Consolidate all usage of wiki ID within Meza #100

freephile opened this issue Apr 26, 2024 · 1 comment
Labels
code health best practices doc Improvements or additions to documentation php PHP Hypertext Preprocessor python Python programming yaml yaml ain't markup language

Comments

@freephile
Copy link
Owner

freephile commented Apr 26, 2024

In LocalSettings.php (and other PHP code generated by Meza), the wiki identifier variable name is $wikiId. In CLI scripts and the shell environment, the variable default name is WIKI. In YAML files or Ansible commands, the variable name is wiki_id. Why are there three different names for the same thing? This difference no doubt causes some confusion, while respecting traditional naming conventions in PHP, BASH and YAML. Convention could be ignored to use a consistent variable name e.g. WIKI_ID or SITE_ID throughout.

Variable Name Language
$wikiId PHP
WIKI BASH
wiki_id YAML
SITE_ID proposed
@freephile freephile added doc Improvements or additions to documentation python Python programming php PHP Hypertext Preprocessor code health best practices yaml yaml ain't markup language labels Apr 26, 2024
@freephile
Copy link
Owner Author

I referred to this in documentation https://www.mediawiki.org/wiki/Meza/Commands#MediaWiki_Maintenance to help new users not get confused by 3 different names for the same thing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code health best practices doc Improvements or additions to documentation php PHP Hypertext Preprocessor python Python programming yaml yaml ain't markup language
Projects
None yet
Development

No branches or pull requests

1 participant