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

Add instructions for if symlinking fails for newly-added extensions/skins #398

Open
hexmode opened this issue May 4, 2024 · 3 comments
Open
Labels
bug Something isn't working

Comments

@hexmode
Copy link
Contributor

hexmode commented May 4, 2024

At https://canasta.wiki/extensions-and-skins/#installing-additional-extensions the following is incorrect:

To install a non-Canasta extension, simply place it in the ./extensions directory and add a wfLoadExtension call to ./config/LocalSettings.php, e.g.:

wfLoadExtension( 'MyCustomExtension' );

The wfLoadExtension call should read:

wfLoadExtension( 'MyCustomExtension', "$IP/user-extensions/MyCustomExtension/extension.json" );
@hexmode hexmode added the bug Something isn't working label May 4, 2024
@yaronkoren
Copy link
Member

Well, the directions are "correct" - though whether or not they actually work is a different story. Adding an extension directory to the user-extensions/ directory is meant to cause a symlink to it in the extensions/ directory to automatically be created - so that you can then call wfLoadExtension() directly on that. If it didn't happen in your case, that's a bug.

@hexmode
Copy link
Contributor Author

hexmode commented May 6, 2024

With the symlink dependency that may not happen sometimes, it would be good to add a troubleshooting section.

@yaronkoren
Copy link
Member

That's a fair point - right now the documentation just assumes that it will always work. I suppose the best course of action to give to the user, if the symlinking fails, is to "symlink it yourself", i.e go to the extensions/ directory and call "ln -s ...".

Now I'm curious: did you try adding a new extension, and did the symlinking fail for you?

@yaronkoren yaronkoren changed the title Website gives wrong directions for installing additional extension. Add instructions for if symlinking fails for newly-added extensions/skins May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants