-
Notifications
You must be signed in to change notification settings - Fork 7
Make Entire Codebase Brand-Agnostic and Apply Default FreeCAD Branding #42
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
base: main
Are you sure you want to change the base?
Make Entire Codebase Brand-Agnostic and Apply Default FreeCAD Branding #42
Conversation
updates default rss url to freecad blogs updates default banner content
and updates related error messages & function names
…ecks - Remove isTripe field from backend schema, resolvers, and hooks - Replace isTripe checks with verifySiteAdministrativePower in backend - Add isSiteAdministrator Vuex action to frontend - Update all Xavier admin views to use new action Ensures consistent permission checking using Admin organization membership and isAdmin flag instead of deprecated isTripe field.
…nal download URLs - Redesign XavierUpdateSoftwareReleases admin page with improved UI and bulk operations - Add migration to set default FreeCAD downloads
… disable open in desktop app functionality
…rences with generic Lens platform terms
…ckward compatibility
|
Feel free to review the PR and share your feedback. |
pieterhijma
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great work!
I have only a couple of remarks:
The README could have more information:
- Running the backend for the first time could mention
entry.sh. I totally missed this script with the necessasry migrations. - It would also good to mention this in the README: http://localhost:3000/xavier-68373833
The REUSE information is not up to date any longer. It would be good to have that up-to-date. If you want, I can submit a PR for this as well.
$ reuse lint
# MISSING COPYRIGHT AND LICENSING INFORMATION
The following files have no copyright and licensing information:
* .gitmodules
* backend/entry.sh
* backend/uploads/.gitignore
* backend/uploads/public/.gitignore
* backend/uploads/public/branding/.gitignore
* backend/uploads/public/sample_thumbnail.PNG
* backend/uploads/sample.FCStd
* backend/uploads/sample_generated.FCSTD
* docker-compose.dev.yml
* docker-compose.prebuilds.yml
* docker-compose.yml
* docs/services.md
* docs/technical.md
* docs/test-models/assembly.zip
* docs/upgrade.md
* docs/workflows.md
* env.example
* env.with-aws.example
* frontend/entry.sh
* frontend/public/img/icon-apple.svg
* frontend/public/img/icon-linux.svg
* frontend/public/img/icon-windows.svg
# SUMMARY
* Bad licenses: 0
* Deprecated licenses: 0
* Licenses without file extension: 0
* Missing licenses: 0
* Unused licenses: 0
* Used licenses: AGPL-3.0-or-later, BSD-2-Clause, CC-BY-SA-4.0, LGPL-2.1-only
* Read errors: 0
* Invalid SPDX License Expressions: 0
* Files with copyright information: 507 / 529
* Files with license information: 507 / 529
Unfortunately, your project is not compliant with version 3.3 of the REUSE Specification :-(
# RECOMMENDATIONS
* Fix missing copyright/licensing information: For one or more files, the tool
cannot find copyright and/or licensing information. You typically do this by
adding 'SPDX-FileCopyrightText' and 'SPDX-License-Identifier' tags to each
file. The tutorial explains additional ways to do this:
<https://reuse.software/tutorial/>
Co-authored-by: Pieter Hijma <[email protected]>
Co-authored-by: Pieter Hijma <[email protected]>
|
Earlier, when Ondsel was handling the development, we were using the following text as the file header: Now that FreeCAD is sponsoring the project, so for the new files should I continue using the same license and file copyright text? What are your thoughts? |
Hi @amrit3701, In principle, you should use the same license. For copyright holder I would advise to use your own name, own email address (not strictly necessary), and the current year. I'm not a lawyer of course, but I believe that the creative output is the thing on which you can claim copyright. So, I use the following rules: If there is only a minor change that does not change any logic, for example rename functions, add an if-statement here and there: This is not enough for me to claim copyright, so I leave the copyright text as is. If there is a major change that adds new logic, so there is a creative process behind it, I would add myself as copyright holder, so: If you introduce new files, you claim full copyright: Although the FPA is sponsoring the project, what you do is not prescribed by the FPA. Additionally, the proposal that you submitted is your own creative process. Finally, I'm pretty sure that you don't have a contract that tells you to transfer copyright to the FPA. It would be different if the FPA hires you for a thing that they specifically want. An example is Ondsel itself that hired me to work on the Addon and I had a contract which stated that copyright would be Ondsel's. In any case, I claimed copyright in FreeCAD on the projects sponsored by the FPA and this is a new file I introduced in the Addon where I claimed copyright: https://github.com/FreeCAD/Ondsel-Lens-Addon/blob/develop/components/edit_profile_dialog.py This is an example where I added myself a second time with a new email address (for a different project): I now realize that I should probably also update the addon with more precise copyright info. |
|
@pieterhijma please have another look at the PR. I’ve added the copyright headers to the new files: I’ve also updated the FC-Worker revision. I’m currently working on the documentation and will create a separate PR for that. Pieter, in my earlier PRs I changed the root organization from |
|
Thanks, sorry for the delay, I will try to look at it the coming days. |
I believe this is indeed problematic. I have the following in the addon: However, I can try to adapt to this as well. |
|
I fixed this error with FreeCAD/Ondsel-Lens-Addon#23. |
pieterhijma
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. Would still like to have the thing below in the README though (or is there any reason not to include it?)
The README could have more information:
Running the backend for the first time could mention entry.sh. I totally missed this script with the necessasry migrations.
It would also good to mention this in the README: http://localhost:3000/xavier-68373833
There is a PR for the change of the Ondsel/Admin organization.
Summary
This PR updates the codebase to be fully brand-agnostic and aligns the default configuration with FreeCAD branding. It includes UI updates, backend changes, migrations, and improvements to the download and admin systems.
Changes Included
🖼️ Branding Updates
ondsel_logo.svg, addedlogo.svgondsel.FCStd→sample.FCStd)👤 Admin & Permissions
@ondsel.comadmin logicisTripelogic with new organization-based admin checks📦 Download Section Enhancements
XavierUpdateSoftwareReleasesadmin page (improved UI/UX)🏗️ Platform-Wide Refactor: Brand-Agnostic
ondsel_→lens_(with backward compatibility)TODO (Before Merge)
Notes
This PR ensures that the platform can be deployed under any brand while using FreeCAD as the default configuration.
Output Screenshots