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

Provide Credits Page For Attributions #1867

Open
FatihKoz opened this issue Aug 19, 2024 · 0 comments · Fixed by #1868 · May be fixed by #1886
Open

Provide Credits Page For Attributions #1867

FatihKoz opened this issue Aug 19, 2024 · 0 comments · Fixed by #1868 · May be fixed by #1886

Comments

@FatihKoz
Copy link
Contributor

Considering more developers providing addons for phpvms v7, requirements for attributions on page footers can easily grow and may render a crowded footer, and may cause unintentional errors.

Describe the solution you'd like
Provide a credits page or modules page, publicly visible, with attribution links of installed modules. For quests or generic users, that page can show only names and attribution links (or images of addons), logged in admins (or users) can see license and readme links if provided.

Describe alternatives you've considered
Addon developers should device if they want to have their work listed or not, if they wish so, then they can provide details for their addons, if not the module.json should not contain required data.

Added fields are below;

    "version": "3.6.13",
    "readme_url": "https://github.com/FatihKoz/DisposableBasic?tab=readme-ov-file#readme",
    "license_url": "https://github.com/FatihKoz/DisposableBasic?tab=License-1-ov-file#readme",
    "attribution": {
        "text": "Disposable Basic by DH Addons",
        "url": "https://github.com/FatihKoz",
        "img": null
    },

An example module.json would be something like below

{
    "name": "DisposableBasic",
    "alias": "disposablebasic",
    "description": "phpVMS v7 module for Basic VA features",
    "version": "3.6.13",
    "readme_url": "https://github.com/FatihKoz/DisposableBasic?tab=readme-ov-file#readme",
    "license_url": "https://github.com/FatihKoz/DisposableBasic?tab=License-1-ov-file#readme",
    "attribution": {
        "text": "Disposable Basic by DH Addons",
        "url": "https://github.com/FatihKoz",
        "img": null
    },
    "keywords": [],
    "active": 0,
    "order": 9001,
    "providers": [
        "Modules\\DisposableBasic\\Providers\\DB_ServiceProvider",
        "Modules\\DisposableBasic\\Providers\\DB_EventProvider"
    ],
    "aliases": {},
    "files": [
        "db_helpers.php", 
        "db_helpers_tech.php"
    ],
    "requires": []
}

image

We can work on the layout, or decide on what to show to who, when to show (like if attribution is null, then skip the module completely etc)

This is an open idea, as being discussed on discord 😉 So any thoughts will be greatly appreciated.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants