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

rebrand: frappedesk -> helpdesk #1080

Merged
merged 93 commits into from
Apr 4, 2023
Merged

rebrand: frappedesk -> helpdesk #1080

merged 93 commits into from
Apr 4, 2023

Conversation

ssiyad
Copy link
Contributor

@ssiyad ssiyad commented Mar 27, 2023

Warning! Do NOT skip this!

Before upgrading, please make sure you are using latest version. Then,

  1. In your bench directory, edit sites/apps.txt to replace frappedesk with helpdesk

  2. Run a console for your site

    bench --site your-site.localhost console

    This is a python console, attached to your site and it's database. In this console,

    from frappe.installer import add_to_installed_apps, remove_from_installed_apps
    
    remove_from_installed_apps("frappedesk")
    add_to_installed_apps("helpdesk")
  3. You should now be able to upgrade your site

Perks

  • Standardise DocTypes
    • Prefix with HD
      No more conflict with others. eg: Ticket and Agent becomes HD Ticket and HD Agent
    • Adjust names to make better sense
      eg: Category will become HD Article Category
  • Standard path for frontend (Merge /frappedesk and /support into /helpdesk)
  • Standardise socket events. Prefix with helpdesk:

Steps

  1. Prefix all DocTypes with HD
  2. Fix setup/install
  3. Fix api paths (frappedesk.api to helpdesk.api)
  4. Rename imports (py)
  5. Rename imports (vue)
  6. Rename routes
  7. Write patches
  8. Remove possible deadweight

Route Changes

  • /support -> /helpdesk (eg: /support/tickets will become /helpdesk/tickets
  • /frappedesk -> /helpdesk/dashboard (eg: /frappedesk/tickets will become /helpdesk/dashboard/tickets
  • /frappedesk -> /helpdesk/ (eg: /frappedesk/tickets will become /helpdesk/tickets
  • /support/tickets -> /helpdesk/my-tickets
  • /support/kb -> /helpdesk/knowledge-base

Misc

  • Role Frappedesk Contact (reference only, there is no actual declaration) has been renamed to Helpdesk Contact
  • Change naming rules
    • HD Ticket: Auto-increment
    • HD Ticket Comment: Random
    • HD Ticket Activity: Random

Todo

  • Patch for DocType renames
  • Patch for Workspace deletion (Frappe Desk)

Planned (Can be scrapped)

  • Change ticket name to autoinc

- `Agent` -> `HD Agent`
- `Agent Group` -> `HD Team`
- `Frappe Desk Settings` -> `HD Settings`
- `Ticket Priority` -> `HD Ticket Priority`
- `Teams User` -> `HD Team Member`
- `Article` -> `HD Article`
- `User Article Feedback` -> `HD Article Feedback`
- `Category` -> `HD Article Category`
- `Sub Category Item` -> `HD Article Sub Category Item`
- `Article Item` -> `HD Article Item`
- `Agent Group Item` -> `HD Team Item`
@ssiyad ssiyad marked this pull request as ready for review April 3, 2023 10:24
@ssiyad ssiyad merged commit 902c5df into frappe:main Apr 4, 2023
@ssiyad ssiyad deleted the refactor/rebrand branch April 4, 2023 08:10
ssiyad added a commit to ssiyad/helpdesk that referenced this pull request Apr 19, 2023
ssiyad added a commit to ssiyad/helpdesk that referenced this pull request Apr 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Status: Done
1 participant