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

Drop the "2" in QWC2 #375

Open
vpicavet opened this issue Jul 9, 2024 · 4 comments
Open

Drop the "2" in QWC2 #375

vpicavet opened this issue Jul 9, 2024 · 4 comments

Comments

@vpicavet
Copy link
Member

vpicavet commented Jul 9, 2024

Communication and identification of the project would be much clearer if we would not have the 2 in QWC2.

This proposal is to "drop the 2" in QWC, and just call the solution "QWC : QGIS Web Client".

QWC version 1 has been very confidential, and there is no need to keep version 2 identified as its successor.

Without the 2, it will be more straightforward, easier to identify the project, easier to type, easier to pronounce, easier to search, and will avoid users to ask why it is called version 2 in its title name.

@manisandro
Copy link
Member

This could make sense, one additional point which I believe could be addressed is the current qwc2-demo-app vs qwc2 modules structure. Indeed I believe that the "demo-app" designation has become suboptimal, as the number of customization options which were implemented in the past couple of years has greatly reduced the need for compiling a custom application for most users. This option should clearly remain available for advanced users, but maybe just renaming qwc2-demo-app to something like qwc-app (or perhaps just plain QWC, and renaming the current qwc2 to qwc-modules) could be an idea.

@manisandro manisandro transferred this issue from qgis/qwc2-demo-app Mar 6, 2025
@manisandro
Copy link
Member

As a first step, I've promoted https://github.com/qgis/qwc2 to a stock application, adding the various bits and pieces to allow running it as a standalone viewer, and demoted https://github.com/qgis/qwc2-demo-app to a skeleton showcasing how to build a custom application. I've moved all open issues to this repository. I've also adjusted the documentation at qwc-services.github.io and am now building the qwc-map-viewer docker image off this repository.

@vpicavet
Copy link
Member Author

vpicavet commented Mar 7, 2025

Thanks, let's just rename all the things now :-)

@manisandro
Copy link
Member

Superficially renaming it is pretty straight forward, however to remove all traces of the 2 in qwc2 is more complex as it appears in setting keys:

$ grep -ri qwc2 --include=*.json --exclude=search_index.json
qwc-ogc-service/schemas/qwc-ogc-service.json:          "description": "Name of the active user parameter for the QGIS Server. Will be set to the name of the logged in user in qwc2.",
qwc-admin-gui/schemas/qwc-admin-gui.json:        "qwc2_path": {
qwc-admin-gui/schemas/qwc-admin-gui.json:          "description": "The path to QWC2 files. Required for 'themes' and 'alkis' plugins.",
qwc-config-generator/schemas/qwc-config-generator.json:      "title": "QWC2 themes configuration",
qwc-config-generator/schemas/qwc-config-generator.json:          "description": "Corresponds to contents of standalone QWC2 themesConfig.json",
qwc-config-generator/schemas/qwc-config-generator.json:            "qwc2_config": {
qwc-config-generator/schemas/qwc-config-generator.json:              "description": "Additional config for QWC2 application configuration",
qwc-config-generator/schemas/qwc-config-generator.json:                "qwc2_config_file": {
qwc-config-generator/schemas/qwc-config-generator.json:                  "description": "Path to QWC2 config.json file. Example: /qwc2/config.json",
qwc-config-generator/schemas/qwc-config-generator.json:                "qwc2_index_file": {
qwc-config-generator/schemas/qwc-config-generator.json:                  "description": "Path to QWC2 index.html file. Example: /qwc2/index.html",
qwc-config-generator/schemas/qwc-config-generator.json:                "qwc2_config_file",
qwc-config-generator/schemas/qwc-config-generator.json:                "qwc2_index_file"
qwc-config-generator/schemas/qwc-config-generator.json:            "qwc2_config"
qwc-map-viewer/schemas/qwc-map-viewer.json:        "qwc2_path": {
qwc-map-viewer/schemas/qwc-map-viewer.json:          "description": "Path to QWC2 files",
qwc-map-viewer/schemas/qwc-map-viewer.json:        "qwc2_path",
qwc-map-viewer/schemas/qwc-map-viewer.json:        "qwc2_config": {
qwc-map-viewer/schemas/qwc-map-viewer.json:              "description": "QWC2 application configuration (config.json)",
qwc-map-viewer/schemas/qwc-map-viewer.json:        "qwc2_themes": {
qwc-map-viewer/schemas/qwc-map-viewer.json:          "description": "QWC2 themes configuration (themes.json)",
qwc-map-viewer/schemas/qwc-map-viewer.json:        "qwc2_config",
qwc-map-viewer/schemas/qwc-map-viewer.json:        "qwc2_themes"

I don't believe such an invasive change is worthwhile TBH.

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

No branches or pull requests

2 participants