From 66ad9afc3fed49adaad5ae7300cf47147db49271 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Fri, 25 Oct 2024 09:53:28 -0400 Subject: [PATCH 01/22] docs(uc-doc): migrate from old to new website --- .../system/wazo-webhookd/mobile-push.puml | 29 ----------- website/docusaurus.config.ts | 9 ++++ .../administration/boss_secretary_filter.md | 0 .../uc-doc/administration/call_logs/index.md | 0 .../uc-doc/administration/call_permissions.md | 0 .../uc-doc/administration/call_policy.md | 9 ++-- .../administration/call_recording/index.md | 0 .../uc-doc/administration/callerid.md | 0 .../uc-doc/administration/cli_tools/index.md | 0 .../contact_directories/general.md | 0 .../contact_directories/index.md | 0 .../contact_directories/phonebook.md | 0 .../uc-doc/administration/direct_media.md | 0 .../uc-doc/administration/directed_pickup.md | 0 .../uc-doc/administration/fax/index.md | 0 .../uc-doc/administration/graphics/index.md | 0 .../administration/group_pickup/index.md | 0 .../uc-doc/administration/import_export.md | 0 .../uc-doc/administration/incall.md | 0 .../uc-doc/administration/index.md | 0 .../administration/interconnections/index.md | 0 .../interconnections/introduction.md | 0 .../interconnections/two_wazo.md | 0 .../wazo_with_voip_provider.md | 0 .../uc-doc/administration/ivr/index.md | 0 .../uc-doc/administration/meetings.md | 0 .../uc-doc/administration/music_on_hold.md | 0 .../uc-doc/administration/nat.md | 0 .../uc-doc/administration/paging.md | 0 .../uc-doc/administration/parking.md | 0 .../provisioning/adv_configuration.md | 0 .../provisioning/basic_configuration.md | 0 .../administration/provisioning/directory.md | 0 .../provisioning/http-auth-strategy.md | 0 .../administration/provisioning/index.md | 0 .../provisioning/introduction.md | 0 .../administration/provisioning/jitsi.md | 2 +- .../uc-doc/administration/sccp/index.md | 0 .../uc-doc/administration/schedules/index.md | 0 .../uc-doc/administration/security.md | 0 .../uc-doc/administration/sip_templates.md | 3 +- .../uc-doc/administration/sound_files.md | 0 .../uc-doc/administration/users/csv_import.md | 0 .../uc-doc/administration/users/index.md | 0 .../uc-doc/administration/users/users.md | 0 .../uc-doc/administration/voicemails.md | 0 {content => website}/uc-doc/api_sdk/index.md | 0 .../uc-doc/api_sdk/message_bus.md | 6 +-- .../uc-doc/api_sdk/mobile/index.md | 0 .../api_sdk/mobile/push_notification.md | 0 .../uc-doc/api_sdk/rest_api/acl.md | 2 +- .../uc-doc/api_sdk/rest_api/changelog.md | 0 .../api_sdk/rest_api/confd/func_keys.md | 0 .../uc-doc/api_sdk/rest_api/confd/index.md | 3 +- .../api_sdk/rest_api/confd/user_import.md | 0 .../api_sdk/rest_api/confd/user_management.md | 0 .../uc-doc/api_sdk/rest_api/conventions.md | 0 .../uc-doc/api_sdk/rest_api/examples.md | 0 .../uc-doc/api_sdk/rest_api/index.md | 0 .../uc-doc/api_sdk/rest_api/quickstart.md | 2 +- .../uc-doc/api_sdk/rest_api/reference.md | 2 +- .../rest_api/sysconfd/asterisk_voicemail.md | 0 .../rest_api/sysconfd/common_configuration.md | 0 .../rest_api/sysconfd/dhcpd_configuration.md | 0 .../uc-doc/api_sdk/rest_api/sysconfd/dns.md | 0 .../uc-doc/api_sdk/rest_api/sysconfd/ha.md | 0 .../api_sdk/rest_api/sysconfd/handlers.md | 0 .../uc-doc/api_sdk/rest_api/sysconfd/index.md | 0 .../api_sdk/rest_api/sysconfd/services.md | 0 .../api_sdk/rest_api/sysconfd/status_check.md | 0 .../rest_api/sysconfd/xivo_services.md | 0 .../api_sdk/rest_api/troubleshooting.md | 0 .../uc-doc/api_sdk/rest_api/webhookd/index.md | 0 .../api_sdk/rest_api/webhookd/templates.md | 2 +- .../api_sdk/rest_api/webhookd/user_filter.md | 0 .../uc-doc/api_sdk/subroutine.md | 0 .../uc-doc/api_sdk/websocket.md | 0 {content => website}/uc-doc/attribution.md | 0 {content => website}/uc-doc/changelog.md | 0 .../uc-doc/community/index.md | 0 .../uc-doc/contact_center/agents.md | 0 .../uc-doc/contact_center/index.md | 0 .../uc-doc/contact_center/introduction.md | 0 .../uc-doc/contact_center/queues.md | 0 .../uc-doc/contact_center/reporting.md | 0 .../contact_center/skillbasedrouting.md | 0 .../uc-doc/contributors/contributing_doc.md | 3 +- .../contributors/contributing_to_wazo.md | 0 .../uc-doc/contributors/debug_asterisk.md | 2 +- .../uc-doc/contributors/debug_daemon.md | 0 .../uc-doc/contributors/diagrams.md | 0 .../contributors/generate_custom_prompts.md | 2 +- .../uc-doc/contributors/guidelines.md | 0 .../uc-doc/contributors/index.md | 0 .../uc-doc/contributors/integration-tests.md | 0 .../uc-doc/contributors/network.md | 0 .../uc-doc/contributors/plugins.md | 0 .../uc-doc/contributors/profile_python.md | 0 .../provisioning/add_phone_to_plugin.md | 0 .../provisioning/developing_plugins.md | 0 ...ftp-requests-processing-in-provd-part-1.md | 0 ...ftp-requests-processing-in-provd-part-2.md | 0 .../uc-doc/contributors/provisioning/index.md | 0 ...in-model-of-the-new-provisioning-server.md | 0 .../managing_dhcp_server_configuration.md | 0 .../provisioning/managing_plugins.md | 0 .../provisioning/nat_environment.md | 0 .../provisioning/testing_new_sip_phone.md | 0 .../uc-doc/contributors/sccp.md | 0 .../uc-doc/contributors/style_guide.md | 0 .../uc-doc/contributors/translate.md | 4 +- .../uc-doc/contributors/typing.md | 0 .../uc-doc/ecosystem/index.md | 0 .../uc-doc/high_availability/index.md | 0 .../uc-doc/high_availability/introduction.md | 6 +-- {content => website}/uc-doc/index.md | 0 .../uc-doc/installation/index.md | 0 .../uc-doc/installation/install-system.md | 3 +- .../uc-doc/installation/postinstall.md | 0 {content => website}/uc-doc/introduction.md | 0 .../uc-doc/system/backup_restore.md | 0 .../uc-doc/system/configuration_files.md | 0 .../uc-doc/system/dhcp/index.md | 0 .../uc-doc/system/https_certificate.md | 0 {content => website}/uc-doc/system/index.md | 0 .../uc-doc/system/log_files.md | 0 .../uc-doc/system/network/index.md | 2 +- {content => website}/uc-doc/system/nginx.md | 0 {content => website}/uc-doc/system/ntp.md | 0 .../uc-doc/system/performance.md | 0 {content => website}/uc-doc/system/proxy.md | 0 .../uc-doc/system/purge_logs.md | 0 {content => website}/uc-doc/system/service.md | 0 .../system/service_authentication/index.md | 0 .../uc-doc/system/service_discovery.md | 0 .../uc-doc/system/wazo-auth/developer.md | 0 .../uc-doc/system/wazo-auth/index.md | 0 .../uc-doc/system/wazo-auth/introduction.md | 6 +-- .../uc-doc/system/wazo-auth/stock_plugins.md | 0 .../uc-doc/system/wazo-calld/developer.md | 0 .../uc-doc/system/wazo-calld/index.md | 0 .../uc-doc/system/wazo-confd/developer.md | 0 .../uc-doc/system/wazo-confd/index.md | 0 .../uc-doc/system/wazo-confd/introduction.md | 0 .../uc-doc/system/wazo-confgend/developer.md | 0 .../uc-doc/system/wazo-confgend/index.md | 0 .../system/wazo-confgend/introduction.md | 0 .../uc-doc/system/wazo-dird/configuration.md | 0 .../uc-doc/system/wazo-dird/developer.md | 4 +- .../uc-doc/system/wazo-dird/index.md | 0 .../uc-doc/system/wazo-dird/introduction.md | 0 .../uc-doc/system/wazo-dird/stock_plugins.md | 3 +- .../uc-doc/system/wazo-phoned.md | 0 .../uc-doc/system/wazo-sysconfd.md | 0 .../uc-doc/system/wazo-webhookd/index.md | 49 +++++++++++++++---- .../uc-doc/troubleshooting/index.md | 0 {content => website}/uc-doc/upgrade/index.md | 0 .../uc-doc/upgrade/introduction.md | 0 .../uc-doc/upgrade/migrate_i386_to_amd64.md | 0 .../uc-doc/upgrade/old_upgrade_notes.md | 0 .../uc-doc/upgrade/upgrade_from_wazo_18_03.md | 0 .../uc-doc/upgrade/upgrade_notes.md | 0 .../upgrade_notes_details/18-01/index.md | 0 .../upgrade_notes_details/18-01/stretch.md | 0 .../18-12/asterisk_16.md | 4 +- .../upgrade_notes_details/18-12/index.md | 0 .../upgrade_notes_details/19-03/index.md | 0 .../upgrade_notes_details/19-03/sounds.md | 0 .../upgrade_notes_details/19-13/buster.md | 0 .../upgrade_notes_details/19-13/index.md | 0 .../21-01/asterisk_18.md | 2 +- .../upgrade_notes_details/21-01/index.md | 0 .../22-10/asterisk_19.md | 2 +- .../upgrade_notes_details/22-10/index.md | 0 .../upgrade_notes_details/22-16/index.md | 0 .../22-16/provd_plugins_python3.md | 0 .../23-04/asterisk_20.md | 2 +- .../upgrade_notes_details/23-04/index.md | 0 .../upgrade_notes_details/23-06/bullseye.md | 0 .../upgrade_notes_details/23-06/index.md | 0 .../24-05/asterisk_21.md | 0 .../upgrade_notes_details/24-05/index.md | 0 .../upgrade/upgrade_notes_details/index.md | 0 .../archives-from-wazo-bullseye.md | 0 .../archives-from-wazo-buster.md | 0 .../archives-from-wazo-stretch.md | 2 +- .../upgrade/upgrade_specific_version/index.md | 0 .../upgrade_specific_version/introduction.md | 0 .../upgrade/version_deprecation_policy.md | 0 189 files changed, 84 insertions(+), 81 deletions(-) delete mode 100644 content/uc-doc/system/wazo-webhookd/mobile-push.puml rename {content => website}/uc-doc/administration/boss_secretary_filter.md (100%) rename {content => website}/uc-doc/administration/call_logs/index.md (100%) rename {content => website}/uc-doc/administration/call_permissions.md (100%) rename {content => website}/uc-doc/administration/call_policy.md (93%) rename {content => website}/uc-doc/administration/call_recording/index.md (100%) rename {content => website}/uc-doc/administration/callerid.md (100%) rename {content => website}/uc-doc/administration/cli_tools/index.md (100%) rename {content => website}/uc-doc/administration/contact_directories/general.md (100%) rename {content => website}/uc-doc/administration/contact_directories/index.md (100%) rename {content => website}/uc-doc/administration/contact_directories/phonebook.md (100%) rename {content => website}/uc-doc/administration/direct_media.md (100%) rename {content => website}/uc-doc/administration/directed_pickup.md (100%) rename {content => website}/uc-doc/administration/fax/index.md (100%) rename {content => website}/uc-doc/administration/graphics/index.md (100%) rename {content => website}/uc-doc/administration/group_pickup/index.md (100%) rename {content => website}/uc-doc/administration/import_export.md (100%) rename {content => website}/uc-doc/administration/incall.md (100%) rename {content => website}/uc-doc/administration/index.md (100%) rename {content => website}/uc-doc/administration/interconnections/index.md (100%) rename {content => website}/uc-doc/administration/interconnections/introduction.md (100%) rename {content => website}/uc-doc/administration/interconnections/two_wazo.md (100%) rename {content => website}/uc-doc/administration/interconnections/wazo_with_voip_provider.md (100%) rename {content => website}/uc-doc/administration/ivr/index.md (100%) rename {content => website}/uc-doc/administration/meetings.md (100%) rename {content => website}/uc-doc/administration/music_on_hold.md (100%) rename {content => website}/uc-doc/administration/nat.md (100%) rename {content => website}/uc-doc/administration/paging.md (100%) rename {content => website}/uc-doc/administration/parking.md (100%) rename {content => website}/uc-doc/administration/provisioning/adv_configuration.md (100%) rename {content => website}/uc-doc/administration/provisioning/basic_configuration.md (100%) rename {content => website}/uc-doc/administration/provisioning/directory.md (100%) rename {content => website}/uc-doc/administration/provisioning/http-auth-strategy.md (100%) rename {content => website}/uc-doc/administration/provisioning/index.md (100%) rename {content => website}/uc-doc/administration/provisioning/introduction.md (100%) rename {content => website}/uc-doc/administration/provisioning/jitsi.md (94%) rename {content => website}/uc-doc/administration/sccp/index.md (100%) rename {content => website}/uc-doc/administration/schedules/index.md (100%) rename {content => website}/uc-doc/administration/security.md (100%) rename {content => website}/uc-doc/administration/sip_templates.md (99%) rename {content => website}/uc-doc/administration/sound_files.md (100%) rename {content => website}/uc-doc/administration/users/csv_import.md (100%) rename {content => website}/uc-doc/administration/users/index.md (100%) rename {content => website}/uc-doc/administration/users/users.md (100%) rename {content => website}/uc-doc/administration/voicemails.md (100%) rename {content => website}/uc-doc/api_sdk/index.md (100%) rename {content => website}/uc-doc/api_sdk/message_bus.md (99%) rename {content => website}/uc-doc/api_sdk/mobile/index.md (100%) rename {content => website}/uc-doc/api_sdk/mobile/push_notification.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/acl.md (94%) rename {content => website}/uc-doc/api_sdk/rest_api/changelog.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/confd/func_keys.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/confd/index.md (52%) rename {content => website}/uc-doc/api_sdk/rest_api/confd/user_import.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/confd/user_management.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/conventions.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/examples.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/index.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/quickstart.md (97%) rename {content => website}/uc-doc/api_sdk/rest_api/reference.md (83%) rename {content => website}/uc-doc/api_sdk/rest_api/sysconfd/asterisk_voicemail.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/sysconfd/common_configuration.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/sysconfd/dhcpd_configuration.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/sysconfd/dns.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/sysconfd/ha.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/sysconfd/handlers.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/sysconfd/index.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/sysconfd/services.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/sysconfd/status_check.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/sysconfd/xivo_services.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/troubleshooting.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/webhookd/index.md (100%) rename {content => website}/uc-doc/api_sdk/rest_api/webhookd/templates.md (96%) rename {content => website}/uc-doc/api_sdk/rest_api/webhookd/user_filter.md (100%) rename {content => website}/uc-doc/api_sdk/subroutine.md (100%) rename {content => website}/uc-doc/api_sdk/websocket.md (100%) rename {content => website}/uc-doc/attribution.md (100%) rename {content => website}/uc-doc/changelog.md (100%) rename {content => website}/uc-doc/community/index.md (100%) rename {content => website}/uc-doc/contact_center/agents.md (100%) rename {content => website}/uc-doc/contact_center/index.md (100%) rename {content => website}/uc-doc/contact_center/introduction.md (100%) rename {content => website}/uc-doc/contact_center/queues.md (100%) rename {content => website}/uc-doc/contact_center/reporting.md (100%) rename {content => website}/uc-doc/contact_center/skillbasedrouting.md (100%) rename {content => website}/uc-doc/contributors/contributing_doc.md (95%) rename {content => website}/uc-doc/contributors/contributing_to_wazo.md (100%) rename {content => website}/uc-doc/contributors/debug_asterisk.md (99%) rename {content => website}/uc-doc/contributors/debug_daemon.md (100%) rename {content => website}/uc-doc/contributors/diagrams.md (100%) rename {content => website}/uc-doc/contributors/generate_custom_prompts.md (94%) rename {content => website}/uc-doc/contributors/guidelines.md (100%) rename {content => website}/uc-doc/contributors/index.md (100%) rename {content => website}/uc-doc/contributors/integration-tests.md (100%) rename {content => website}/uc-doc/contributors/network.md (100%) rename {content => website}/uc-doc/contributors/plugins.md (100%) rename {content => website}/uc-doc/contributors/profile_python.md (100%) rename {content => website}/uc-doc/contributors/provisioning/add_phone_to_plugin.md (100%) rename {content => website}/uc-doc/contributors/provisioning/developing_plugins.md (100%) rename {content => website}/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-1.md (100%) rename {content => website}/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-2.md (100%) rename {content => website}/uc-doc/contributors/provisioning/index.md (100%) rename {content => website}/uc-doc/contributors/provisioning/introduction-to-the-plugin-model-of-the-new-provisioning-server.md (100%) rename {content => website}/uc-doc/contributors/provisioning/managing_dhcp_server_configuration.md (100%) rename {content => website}/uc-doc/contributors/provisioning/managing_plugins.md (100%) rename {content => website}/uc-doc/contributors/provisioning/nat_environment.md (100%) rename {content => website}/uc-doc/contributors/provisioning/testing_new_sip_phone.md (100%) rename {content => website}/uc-doc/contributors/sccp.md (100%) rename {content => website}/uc-doc/contributors/style_guide.md (100%) rename {content => website}/uc-doc/contributors/translate.md (84%) rename {content => website}/uc-doc/contributors/typing.md (100%) rename {content => website}/uc-doc/ecosystem/index.md (100%) rename {content => website}/uc-doc/high_availability/index.md (100%) rename {content => website}/uc-doc/high_availability/introduction.md (97%) rename {content => website}/uc-doc/index.md (100%) rename {content => website}/uc-doc/installation/index.md (100%) rename {content => website}/uc-doc/installation/install-system.md (96%) rename {content => website}/uc-doc/installation/postinstall.md (100%) rename {content => website}/uc-doc/introduction.md (100%) rename {content => website}/uc-doc/system/backup_restore.md (100%) rename {content => website}/uc-doc/system/configuration_files.md (100%) rename {content => website}/uc-doc/system/dhcp/index.md (100%) rename {content => website}/uc-doc/system/https_certificate.md (100%) rename {content => website}/uc-doc/system/index.md (100%) rename {content => website}/uc-doc/system/log_files.md (100%) rename {content => website}/uc-doc/system/network/index.md (95%) rename {content => website}/uc-doc/system/nginx.md (100%) rename {content => website}/uc-doc/system/ntp.md (100%) rename {content => website}/uc-doc/system/performance.md (100%) rename {content => website}/uc-doc/system/proxy.md (100%) rename {content => website}/uc-doc/system/purge_logs.md (100%) rename {content => website}/uc-doc/system/service.md (100%) rename {content => website}/uc-doc/system/service_authentication/index.md (100%) rename {content => website}/uc-doc/system/service_discovery.md (100%) rename {content => website}/uc-doc/system/wazo-auth/developer.md (100%) rename {content => website}/uc-doc/system/wazo-auth/index.md (100%) rename {content => website}/uc-doc/system/wazo-auth/introduction.md (94%) rename {content => website}/uc-doc/system/wazo-auth/stock_plugins.md (100%) rename {content => website}/uc-doc/system/wazo-calld/developer.md (100%) rename {content => website}/uc-doc/system/wazo-calld/index.md (100%) rename {content => website}/uc-doc/system/wazo-confd/developer.md (100%) rename {content => website}/uc-doc/system/wazo-confd/index.md (100%) rename {content => website}/uc-doc/system/wazo-confd/introduction.md (100%) rename {content => website}/uc-doc/system/wazo-confgend/developer.md (100%) rename {content => website}/uc-doc/system/wazo-confgend/index.md (100%) rename {content => website}/uc-doc/system/wazo-confgend/introduction.md (100%) rename {content => website}/uc-doc/system/wazo-dird/configuration.md (100%) rename {content => website}/uc-doc/system/wazo-dird/developer.md (98%) rename {content => website}/uc-doc/system/wazo-dird/index.md (100%) rename {content => website}/uc-doc/system/wazo-dird/introduction.md (100%) rename {content => website}/uc-doc/system/wazo-dird/stock_plugins.md (98%) rename {content => website}/uc-doc/system/wazo-phoned.md (100%) rename {content => website}/uc-doc/system/wazo-sysconfd.md (100%) rename {content => website}/uc-doc/system/wazo-webhookd/index.md (80%) rename {content => website}/uc-doc/troubleshooting/index.md (100%) rename {content => website}/uc-doc/upgrade/index.md (100%) rename {content => website}/uc-doc/upgrade/introduction.md (100%) rename {content => website}/uc-doc/upgrade/migrate_i386_to_amd64.md (100%) rename {content => website}/uc-doc/upgrade/old_upgrade_notes.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_from_wazo_18_03.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/18-01/index.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/18-01/stretch.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/18-12/asterisk_16.md (78%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/18-12/index.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/19-03/index.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/19-03/sounds.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/19-13/buster.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/19-13/index.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/21-01/asterisk_18.md (83%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/21-01/index.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/22-10/asterisk_19.md (83%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/22-10/index.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/22-16/index.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/22-16/provd_plugins_python3.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/23-04/asterisk_20.md (83%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/23-04/index.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/23-06/bullseye.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/23-06/index.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/24-05/asterisk_21.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/24-05/index.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_notes_details/index.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-bullseye.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-buster.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-stretch.md (97%) rename {content => website}/uc-doc/upgrade/upgrade_specific_version/index.md (100%) rename {content => website}/uc-doc/upgrade/upgrade_specific_version/introduction.md (100%) rename {content => website}/uc-doc/upgrade/version_deprecation_policy.md (100%) diff --git a/content/uc-doc/system/wazo-webhookd/mobile-push.puml b/content/uc-doc/system/wazo-webhookd/mobile-push.puml deleted file mode 100644 index 52f314e7..00000000 --- a/content/uc-doc/system/wazo-webhookd/mobile-push.puml +++ /dev/null @@ -1,29 +0,0 @@ -@startuml -!include C4_Container.puml - -hide stereotype - -System_Boundary(wazo_platform, "Wazo Platform"){ - Container(webhookd, "wazo-webhookd", "Python", "Webhook service") - Container(db, "Postgresql", "C", "Database") - Container(bus, "RabbitMQ", "Erlang", "Messaging Bus") - Container(auth, "wazo-auth", "Python", "Authentication service") [["../documentation/overview/authentication.html"]] -} - -System_Ext(external_push_server, "Supported push message service (e.g. FCM, APNS)", "HTTP") -actor MobileUser - -Rel_R(MobileUser, wazo_platform, "Logs in through mobile app", "REST") - -Rel_U(webhookd, db, "SQL(store subscriptions)", "SQL") -Rel_D(bus, webhookd, "Relays Wazo platform events", "AMQP") - -Rel_U(auth, bus, "generates user login events", "AMQP") -Rel_D(webhookd, external_push_server, "Sends push notifications", "HTTP") -' Rel_L(auth,webhookd,"Notify of login events (through bus)", "async,AMQP", $tags="virtual") - -auth .LEFT.> webhookd : ===Notify of user login events\n(through bus) - -Rel_U(external_push_server, MobileUser, "Relays push notifications") - -@enduml diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 7418e987..d3840675 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -140,6 +140,15 @@ const config: Config = { }, } satisfies Preset.ThemeConfig, plugins: [ + [ + '@docusaurus/plugin-content-docs', + { + id: 'uc-doc', + path: 'uc-doc', + routeBasePath: 'uc-doc', + // sidebarPath: './sidebarsCommunity.js', + }, + ], [ '@docusaurus/plugin-content-blog', { diff --git a/content/uc-doc/administration/boss_secretary_filter.md b/website/uc-doc/administration/boss_secretary_filter.md similarity index 100% rename from content/uc-doc/administration/boss_secretary_filter.md rename to website/uc-doc/administration/boss_secretary_filter.md diff --git a/content/uc-doc/administration/call_logs/index.md b/website/uc-doc/administration/call_logs/index.md similarity index 100% rename from content/uc-doc/administration/call_logs/index.md rename to website/uc-doc/administration/call_logs/index.md diff --git a/content/uc-doc/administration/call_permissions.md b/website/uc-doc/administration/call_permissions.md similarity index 100% rename from content/uc-doc/administration/call_permissions.md rename to website/uc-doc/administration/call_permissions.md diff --git a/content/uc-doc/administration/call_policy.md b/website/uc-doc/administration/call_policy.md similarity index 93% rename from content/uc-doc/administration/call_policy.md rename to website/uc-doc/administration/call_policy.md index b378ea1f..a2ce306a 100644 --- a/content/uc-doc/administration/call_policy.md +++ b/website/uc-doc/administration/call_policy.md @@ -1,6 +1,5 @@ --- title: Call Policy -tags: administration,call,policy,api slug: call-policy --- @@ -35,15 +34,15 @@ endpoints configuration. SIP endpoint options can be configured in two ways: -1. through SIP templates, which can be applied to all or a subset of SIP endpoints in a tenant; +1. through SIP templates, which can be applied to all or a subset of SIP endpoints in a tenant; each tenant has a `global` SIP template which represent common options which can apply to all SIP - endpoints. Other templates can specify options for a specific subset of SIP endpoints. + endpoints. Other templates can specify options for a specific subset of SIP endpoints. See [SIP templates documentation](/uc-doc/administration/sip_templates) for information on how to query and configure SIP templates. -2. directly through a SIP endpoint's individual configuration; +2. directly through a SIP endpoint's individual configuration; individual endpoint configuration can be changed through the - `/api/confd/1.1/endpoints/sip/{sip_uuid}` REST API endpoint. + `/api/confd/1.1/endpoints/sip/{sip_uuid}` REST API endpoint. See [API reference](/documentation/api/configuration.html#tag/endpoints/operation/update_endpoint_sip) for details. diff --git a/content/uc-doc/administration/call_recording/index.md b/website/uc-doc/administration/call_recording/index.md similarity index 100% rename from content/uc-doc/administration/call_recording/index.md rename to website/uc-doc/administration/call_recording/index.md diff --git a/content/uc-doc/administration/callerid.md b/website/uc-doc/administration/callerid.md similarity index 100% rename from content/uc-doc/administration/callerid.md rename to website/uc-doc/administration/callerid.md diff --git a/content/uc-doc/administration/cli_tools/index.md b/website/uc-doc/administration/cli_tools/index.md similarity index 100% rename from content/uc-doc/administration/cli_tools/index.md rename to website/uc-doc/administration/cli_tools/index.md diff --git a/content/uc-doc/administration/contact_directories/general.md b/website/uc-doc/administration/contact_directories/general.md similarity index 100% rename from content/uc-doc/administration/contact_directories/general.md rename to website/uc-doc/administration/contact_directories/general.md diff --git a/content/uc-doc/administration/contact_directories/index.md b/website/uc-doc/administration/contact_directories/index.md similarity index 100% rename from content/uc-doc/administration/contact_directories/index.md rename to website/uc-doc/administration/contact_directories/index.md diff --git a/content/uc-doc/administration/contact_directories/phonebook.md b/website/uc-doc/administration/contact_directories/phonebook.md similarity index 100% rename from content/uc-doc/administration/contact_directories/phonebook.md rename to website/uc-doc/administration/contact_directories/phonebook.md diff --git a/content/uc-doc/administration/direct_media.md b/website/uc-doc/administration/direct_media.md similarity index 100% rename from content/uc-doc/administration/direct_media.md rename to website/uc-doc/administration/direct_media.md diff --git a/content/uc-doc/administration/directed_pickup.md b/website/uc-doc/administration/directed_pickup.md similarity index 100% rename from content/uc-doc/administration/directed_pickup.md rename to website/uc-doc/administration/directed_pickup.md diff --git a/content/uc-doc/administration/fax/index.md b/website/uc-doc/administration/fax/index.md similarity index 100% rename from content/uc-doc/administration/fax/index.md rename to website/uc-doc/administration/fax/index.md diff --git a/content/uc-doc/administration/graphics/index.md b/website/uc-doc/administration/graphics/index.md similarity index 100% rename from content/uc-doc/administration/graphics/index.md rename to website/uc-doc/administration/graphics/index.md diff --git a/content/uc-doc/administration/group_pickup/index.md b/website/uc-doc/administration/group_pickup/index.md similarity index 100% rename from content/uc-doc/administration/group_pickup/index.md rename to website/uc-doc/administration/group_pickup/index.md diff --git a/content/uc-doc/administration/import_export.md b/website/uc-doc/administration/import_export.md similarity index 100% rename from content/uc-doc/administration/import_export.md rename to website/uc-doc/administration/import_export.md diff --git a/content/uc-doc/administration/incall.md b/website/uc-doc/administration/incall.md similarity index 100% rename from content/uc-doc/administration/incall.md rename to website/uc-doc/administration/incall.md diff --git a/content/uc-doc/administration/index.md b/website/uc-doc/administration/index.md similarity index 100% rename from content/uc-doc/administration/index.md rename to website/uc-doc/administration/index.md diff --git a/content/uc-doc/administration/interconnections/index.md b/website/uc-doc/administration/interconnections/index.md similarity index 100% rename from content/uc-doc/administration/interconnections/index.md rename to website/uc-doc/administration/interconnections/index.md diff --git a/content/uc-doc/administration/interconnections/introduction.md b/website/uc-doc/administration/interconnections/introduction.md similarity index 100% rename from content/uc-doc/administration/interconnections/introduction.md rename to website/uc-doc/administration/interconnections/introduction.md diff --git a/content/uc-doc/administration/interconnections/two_wazo.md b/website/uc-doc/administration/interconnections/two_wazo.md similarity index 100% rename from content/uc-doc/administration/interconnections/two_wazo.md rename to website/uc-doc/administration/interconnections/two_wazo.md diff --git a/content/uc-doc/administration/interconnections/wazo_with_voip_provider.md b/website/uc-doc/administration/interconnections/wazo_with_voip_provider.md similarity index 100% rename from content/uc-doc/administration/interconnections/wazo_with_voip_provider.md rename to website/uc-doc/administration/interconnections/wazo_with_voip_provider.md diff --git a/content/uc-doc/administration/ivr/index.md b/website/uc-doc/administration/ivr/index.md similarity index 100% rename from content/uc-doc/administration/ivr/index.md rename to website/uc-doc/administration/ivr/index.md diff --git a/content/uc-doc/administration/meetings.md b/website/uc-doc/administration/meetings.md similarity index 100% rename from content/uc-doc/administration/meetings.md rename to website/uc-doc/administration/meetings.md diff --git a/content/uc-doc/administration/music_on_hold.md b/website/uc-doc/administration/music_on_hold.md similarity index 100% rename from content/uc-doc/administration/music_on_hold.md rename to website/uc-doc/administration/music_on_hold.md diff --git a/content/uc-doc/administration/nat.md b/website/uc-doc/administration/nat.md similarity index 100% rename from content/uc-doc/administration/nat.md rename to website/uc-doc/administration/nat.md diff --git a/content/uc-doc/administration/paging.md b/website/uc-doc/administration/paging.md similarity index 100% rename from content/uc-doc/administration/paging.md rename to website/uc-doc/administration/paging.md diff --git a/content/uc-doc/administration/parking.md b/website/uc-doc/administration/parking.md similarity index 100% rename from content/uc-doc/administration/parking.md rename to website/uc-doc/administration/parking.md diff --git a/content/uc-doc/administration/provisioning/adv_configuration.md b/website/uc-doc/administration/provisioning/adv_configuration.md similarity index 100% rename from content/uc-doc/administration/provisioning/adv_configuration.md rename to website/uc-doc/administration/provisioning/adv_configuration.md diff --git a/content/uc-doc/administration/provisioning/basic_configuration.md b/website/uc-doc/administration/provisioning/basic_configuration.md similarity index 100% rename from content/uc-doc/administration/provisioning/basic_configuration.md rename to website/uc-doc/administration/provisioning/basic_configuration.md diff --git a/content/uc-doc/administration/provisioning/directory.md b/website/uc-doc/administration/provisioning/directory.md similarity index 100% rename from content/uc-doc/administration/provisioning/directory.md rename to website/uc-doc/administration/provisioning/directory.md diff --git a/content/uc-doc/administration/provisioning/http-auth-strategy.md b/website/uc-doc/administration/provisioning/http-auth-strategy.md similarity index 100% rename from content/uc-doc/administration/provisioning/http-auth-strategy.md rename to website/uc-doc/administration/provisioning/http-auth-strategy.md diff --git a/content/uc-doc/administration/provisioning/index.md b/website/uc-doc/administration/provisioning/index.md similarity index 100% rename from content/uc-doc/administration/provisioning/index.md rename to website/uc-doc/administration/provisioning/index.md diff --git a/content/uc-doc/administration/provisioning/introduction.md b/website/uc-doc/administration/provisioning/introduction.md similarity index 100% rename from content/uc-doc/administration/provisioning/introduction.md rename to website/uc-doc/administration/provisioning/introduction.md diff --git a/content/uc-doc/administration/provisioning/jitsi.md b/website/uc-doc/administration/provisioning/jitsi.md similarity index 94% rename from content/uc-doc/administration/provisioning/jitsi.md rename to website/uc-doc/administration/provisioning/jitsi.md index 8c683e8d..3d249390 100644 --- a/content/uc-doc/administration/provisioning/jitsi.md +++ b/website/uc-doc/administration/provisioning/jitsi.md @@ -6,7 +6,7 @@ title: Jitsi - [Add Jitsi plugin on Wazo](#add-jitsi-plugin-on-wazo) - [Configuring Jitsi](#configuring-jitsi) -Jitsi () is an opensource softphone (previously SIP Communicator). +[Jitsi](https://jitsi.org/) is an opensource softphone (previously SIP Communicator). Wazo now support Jitsi sofphones provisioning. Here are the steps to follow: diff --git a/content/uc-doc/administration/sccp/index.md b/website/uc-doc/administration/sccp/index.md similarity index 100% rename from content/uc-doc/administration/sccp/index.md rename to website/uc-doc/administration/sccp/index.md diff --git a/content/uc-doc/administration/schedules/index.md b/website/uc-doc/administration/schedules/index.md similarity index 100% rename from content/uc-doc/administration/schedules/index.md rename to website/uc-doc/administration/schedules/index.md diff --git a/content/uc-doc/administration/security.md b/website/uc-doc/administration/security.md similarity index 100% rename from content/uc-doc/administration/security.md rename to website/uc-doc/administration/security.md diff --git a/content/uc-doc/administration/sip_templates.md b/website/uc-doc/administration/sip_templates.md similarity index 99% rename from content/uc-doc/administration/sip_templates.md rename to website/uc-doc/administration/sip_templates.md index 946719e3..71dc24de 100644 --- a/content/uc-doc/administration/sip_templates.md +++ b/website/uc-doc/administration/sip_templates.md @@ -1,6 +1,5 @@ --- title: SIP templates -tags: administration,sip --- SIP templates are configuration templates that define SIP-related options that can be used to @@ -9,7 +8,7 @@ of the Wazo platform. Those templates form a multiple-inheritance hierarchy, such that a template can inherit from parent templates, including all options defined in those parent templates while overriding, removing or -adding some options. +adding some options. This results in a powerful way to configure different classes of SIP devices(hardware phones or softphones) and support various specific scenarios which require specific configuration. diff --git a/content/uc-doc/administration/sound_files.md b/website/uc-doc/administration/sound_files.md similarity index 100% rename from content/uc-doc/administration/sound_files.md rename to website/uc-doc/administration/sound_files.md diff --git a/content/uc-doc/administration/users/csv_import.md b/website/uc-doc/administration/users/csv_import.md similarity index 100% rename from content/uc-doc/administration/users/csv_import.md rename to website/uc-doc/administration/users/csv_import.md diff --git a/content/uc-doc/administration/users/index.md b/website/uc-doc/administration/users/index.md similarity index 100% rename from content/uc-doc/administration/users/index.md rename to website/uc-doc/administration/users/index.md diff --git a/content/uc-doc/administration/users/users.md b/website/uc-doc/administration/users/users.md similarity index 100% rename from content/uc-doc/administration/users/users.md rename to website/uc-doc/administration/users/users.md diff --git a/content/uc-doc/administration/voicemails.md b/website/uc-doc/administration/voicemails.md similarity index 100% rename from content/uc-doc/administration/voicemails.md rename to website/uc-doc/administration/voicemails.md diff --git a/content/uc-doc/api_sdk/index.md b/website/uc-doc/api_sdk/index.md similarity index 100% rename from content/uc-doc/api_sdk/index.md rename to website/uc-doc/api_sdk/index.md diff --git a/content/uc-doc/api_sdk/message_bus.md b/website/uc-doc/api_sdk/message_bus.md similarity index 99% rename from content/uc-doc/api_sdk/message_bus.md rename to website/uc-doc/api_sdk/message_bus.md index f107de41..ef96ab86 100644 --- a/content/uc-doc/api_sdk/message_bus.md +++ b/website/uc-doc/api_sdk/message_bus.md @@ -367,7 +367,7 @@ The events are published when a call handled by wazo-calld is received, connecte - routing key: `calls.call.created, calls.call.updated, calls.call.ended` - required ACL: `events.calls.{user_uuid}` - event specific data: a dictionary with the same fields as the REST API model of Call (See - , section `wazo-calld`) + (Documentation)[https://wazo-platform.org/documentation], section `wazo-calld`) Example: @@ -776,7 +776,7 @@ Those events are published during the different steps of a relocate operation. - headers: - `"user_uuid:XXX": true` where `XXX` is the initiator's user UUID - required ACL: `events.relocates.XXX` where `XXX` is the initiator's user UUID -- event specific data: a relocate object, see , section +- event specific data: a relocate object, see [Documentation](https://wazo-platform.org/documentation), section `wazo-calld`. Example: @@ -981,7 +981,7 @@ user, no message is generated. `voicemails.messages.deleted` - required ACL: `events.users.{user_uuid}.voicemails` - event specific data: a dictionary with the same fields as the REST API model of VoicemailMessage - (See , section `wazo-calld`) + (See [documentation](https://wazo-platform.org/documentation), section `wazo-calld`) Example: diff --git a/content/uc-doc/api_sdk/mobile/index.md b/website/uc-doc/api_sdk/mobile/index.md similarity index 100% rename from content/uc-doc/api_sdk/mobile/index.md rename to website/uc-doc/api_sdk/mobile/index.md diff --git a/content/uc-doc/api_sdk/mobile/push_notification.md b/website/uc-doc/api_sdk/mobile/push_notification.md similarity index 100% rename from content/uc-doc/api_sdk/mobile/push_notification.md rename to website/uc-doc/api_sdk/mobile/push_notification.md diff --git a/content/uc-doc/api_sdk/rest_api/acl.md b/website/uc-doc/api_sdk/rest_api/acl.md similarity index 94% rename from content/uc-doc/api_sdk/rest_api/acl.md rename to website/uc-doc/api_sdk/rest_api/acl.md index c68add44..0f070940 100644 --- a/content/uc-doc/api_sdk/rest_api/acl.md +++ b/website/uc-doc/api_sdk/rest_api/acl.md @@ -63,5 +63,5 @@ Where `{user_id}` is the user uuid from the token. ## Available ACLs -The ACL corresponding to each resource is documented in . Some +The ACL corresponding to each resource is documented in [auth.wazo.community](https://auth.wazo.community). Some resources may not have any associated ACL yet, so you must use `{service}.#` instead. diff --git a/content/uc-doc/api_sdk/rest_api/changelog.md b/website/uc-doc/api_sdk/rest_api/changelog.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/changelog.md rename to website/uc-doc/api_sdk/rest_api/changelog.md diff --git a/content/uc-doc/api_sdk/rest_api/confd/func_keys.md b/website/uc-doc/api_sdk/rest_api/confd/func_keys.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/confd/func_keys.md rename to website/uc-doc/api_sdk/rest_api/confd/func_keys.md diff --git a/content/uc-doc/api_sdk/rest_api/confd/index.md b/website/uc-doc/api_sdk/rest_api/confd/index.md similarity index 52% rename from content/uc-doc/api_sdk/rest_api/confd/index.md rename to website/uc-doc/api_sdk/rest_api/confd/index.md index fc769084..2cdc7f5b 100644 --- a/content/uc-doc/api_sdk/rest_api/confd/index.md +++ b/website/uc-doc/api_sdk/rest_api/confd/index.md @@ -3,8 +3,7 @@ title: wazo-confd REST API subtitle: API reference --- -API documentation is available on . This section contains extended documentation for -certain aspects of the API. +API documentation is available [here](https://wazo-platform.org/documentation). This section contains extended documentation for certain aspects of the API. - [func keys](/uc-doc/api_sdk/rest_api/confd/func_keys) - [user import](/uc-doc/api_sdk/rest_api/confd/user_import) diff --git a/content/uc-doc/api_sdk/rest_api/confd/user_import.md b/website/uc-doc/api_sdk/rest_api/confd/user_import.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/confd/user_import.md rename to website/uc-doc/api_sdk/rest_api/confd/user_import.md diff --git a/content/uc-doc/api_sdk/rest_api/confd/user_management.md b/website/uc-doc/api_sdk/rest_api/confd/user_management.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/confd/user_management.md rename to website/uc-doc/api_sdk/rest_api/confd/user_management.md diff --git a/content/uc-doc/api_sdk/rest_api/conventions.md b/website/uc-doc/api_sdk/rest_api/conventions.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/conventions.md rename to website/uc-doc/api_sdk/rest_api/conventions.md diff --git a/content/uc-doc/api_sdk/rest_api/examples.md b/website/uc-doc/api_sdk/rest_api/examples.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/examples.md rename to website/uc-doc/api_sdk/rest_api/examples.md diff --git a/content/uc-doc/api_sdk/rest_api/index.md b/website/uc-doc/api_sdk/rest_api/index.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/index.md rename to website/uc-doc/api_sdk/rest_api/index.md diff --git a/content/uc-doc/api_sdk/rest_api/quickstart.md b/website/uc-doc/api_sdk/rest_api/quickstart.md similarity index 97% rename from content/uc-doc/api_sdk/rest_api/quickstart.md rename to website/uc-doc/api_sdk/rest_api/quickstart.md index 58e3f1b5..67a0f35a 100644 --- a/content/uc-doc/api_sdk/rest_api/quickstart.md +++ b/website/uc-doc/api_sdk/rest_api/quickstart.md @@ -80,7 +80,7 @@ Now that we have access to REST API specifications, we can use them: And that's it, you are ready to use any REST API with your authentication token. **Note**: Be aware that this token will expire, and that you will need to get a new one when that -happens. You can take a look at for an easier manual token generation +happens. You can take a look at [auth.wazo.community](https://auth.wazo.community) for an easier manual token generation process. Note that the `auth.wazo.community` server will never know the tokens that you generate, you browser will ask your Wazo directly. diff --git a/content/uc-doc/api_sdk/rest_api/reference.md b/website/uc-doc/api_sdk/rest_api/reference.md similarity index 83% rename from content/uc-doc/api_sdk/rest_api/reference.md rename to website/uc-doc/api_sdk/rest_api/reference.md index 2a12302f..e504c92c 100644 --- a/content/uc-doc/api_sdk/rest_api/reference.md +++ b/website/uc-doc/api_sdk/rest_api/reference.md @@ -15,5 +15,5 @@ TCP/443. - [confd](/uc-doc/api_sdk/rest_api/confd) - [sysconfd](/uc-doc/api_sdk/rest_api/sysconfd) -For other services, see . See also the +For other services, see [documentation](https://wazo-platform.org/documentation). See also the [REST API Quickstart](/uc-doc/api_sdk/rest_api/quickstart) for an interactive web UI. diff --git a/content/uc-doc/api_sdk/rest_api/sysconfd/asterisk_voicemail.md b/website/uc-doc/api_sdk/rest_api/sysconfd/asterisk_voicemail.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/sysconfd/asterisk_voicemail.md rename to website/uc-doc/api_sdk/rest_api/sysconfd/asterisk_voicemail.md diff --git a/content/uc-doc/api_sdk/rest_api/sysconfd/common_configuration.md b/website/uc-doc/api_sdk/rest_api/sysconfd/common_configuration.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/sysconfd/common_configuration.md rename to website/uc-doc/api_sdk/rest_api/sysconfd/common_configuration.md diff --git a/content/uc-doc/api_sdk/rest_api/sysconfd/dhcpd_configuration.md b/website/uc-doc/api_sdk/rest_api/sysconfd/dhcpd_configuration.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/sysconfd/dhcpd_configuration.md rename to website/uc-doc/api_sdk/rest_api/sysconfd/dhcpd_configuration.md diff --git a/content/uc-doc/api_sdk/rest_api/sysconfd/dns.md b/website/uc-doc/api_sdk/rest_api/sysconfd/dns.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/sysconfd/dns.md rename to website/uc-doc/api_sdk/rest_api/sysconfd/dns.md diff --git a/content/uc-doc/api_sdk/rest_api/sysconfd/ha.md b/website/uc-doc/api_sdk/rest_api/sysconfd/ha.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/sysconfd/ha.md rename to website/uc-doc/api_sdk/rest_api/sysconfd/ha.md diff --git a/content/uc-doc/api_sdk/rest_api/sysconfd/handlers.md b/website/uc-doc/api_sdk/rest_api/sysconfd/handlers.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/sysconfd/handlers.md rename to website/uc-doc/api_sdk/rest_api/sysconfd/handlers.md diff --git a/content/uc-doc/api_sdk/rest_api/sysconfd/index.md b/website/uc-doc/api_sdk/rest_api/sysconfd/index.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/sysconfd/index.md rename to website/uc-doc/api_sdk/rest_api/sysconfd/index.md diff --git a/content/uc-doc/api_sdk/rest_api/sysconfd/services.md b/website/uc-doc/api_sdk/rest_api/sysconfd/services.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/sysconfd/services.md rename to website/uc-doc/api_sdk/rest_api/sysconfd/services.md diff --git a/content/uc-doc/api_sdk/rest_api/sysconfd/status_check.md b/website/uc-doc/api_sdk/rest_api/sysconfd/status_check.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/sysconfd/status_check.md rename to website/uc-doc/api_sdk/rest_api/sysconfd/status_check.md diff --git a/content/uc-doc/api_sdk/rest_api/sysconfd/xivo_services.md b/website/uc-doc/api_sdk/rest_api/sysconfd/xivo_services.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/sysconfd/xivo_services.md rename to website/uc-doc/api_sdk/rest_api/sysconfd/xivo_services.md diff --git a/content/uc-doc/api_sdk/rest_api/troubleshooting.md b/website/uc-doc/api_sdk/rest_api/troubleshooting.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/troubleshooting.md rename to website/uc-doc/api_sdk/rest_api/troubleshooting.md diff --git a/content/uc-doc/api_sdk/rest_api/webhookd/index.md b/website/uc-doc/api_sdk/rest_api/webhookd/index.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/webhookd/index.md rename to website/uc-doc/api_sdk/rest_api/webhookd/index.md diff --git a/content/uc-doc/api_sdk/rest_api/webhookd/templates.md b/website/uc-doc/api_sdk/rest_api/webhookd/templates.md similarity index 96% rename from content/uc-doc/api_sdk/rest_api/webhookd/templates.md rename to website/uc-doc/api_sdk/rest_api/webhookd/templates.md index 40068281..88e063be 100644 --- a/content/uc-doc/api_sdk/rest_api/webhookd/templates.md +++ b/website/uc-doc/api_sdk/rest_api/webhookd/templates.md @@ -24,7 +24,7 @@ When an event is emitted: ![](/images/uc-doc/api_sdk/rest_api/webhookd/template-event.png) -Then a HTTP request is sent to : +Then a HTTP request is sent to `https://example.com`: ![](/images/uc-doc/api_sdk/rest_api/webhookd/template-request.png) diff --git a/content/uc-doc/api_sdk/rest_api/webhookd/user_filter.md b/website/uc-doc/api_sdk/rest_api/webhookd/user_filter.md similarity index 100% rename from content/uc-doc/api_sdk/rest_api/webhookd/user_filter.md rename to website/uc-doc/api_sdk/rest_api/webhookd/user_filter.md diff --git a/content/uc-doc/api_sdk/subroutine.md b/website/uc-doc/api_sdk/subroutine.md similarity index 100% rename from content/uc-doc/api_sdk/subroutine.md rename to website/uc-doc/api_sdk/subroutine.md diff --git a/content/uc-doc/api_sdk/websocket.md b/website/uc-doc/api_sdk/websocket.md similarity index 100% rename from content/uc-doc/api_sdk/websocket.md rename to website/uc-doc/api_sdk/websocket.md diff --git a/content/uc-doc/attribution.md b/website/uc-doc/attribution.md similarity index 100% rename from content/uc-doc/attribution.md rename to website/uc-doc/attribution.md diff --git a/content/uc-doc/changelog.md b/website/uc-doc/changelog.md similarity index 100% rename from content/uc-doc/changelog.md rename to website/uc-doc/changelog.md diff --git a/content/uc-doc/community/index.md b/website/uc-doc/community/index.md similarity index 100% rename from content/uc-doc/community/index.md rename to website/uc-doc/community/index.md diff --git a/content/uc-doc/contact_center/agents.md b/website/uc-doc/contact_center/agents.md similarity index 100% rename from content/uc-doc/contact_center/agents.md rename to website/uc-doc/contact_center/agents.md diff --git a/content/uc-doc/contact_center/index.md b/website/uc-doc/contact_center/index.md similarity index 100% rename from content/uc-doc/contact_center/index.md rename to website/uc-doc/contact_center/index.md diff --git a/content/uc-doc/contact_center/introduction.md b/website/uc-doc/contact_center/introduction.md similarity index 100% rename from content/uc-doc/contact_center/introduction.md rename to website/uc-doc/contact_center/introduction.md diff --git a/content/uc-doc/contact_center/queues.md b/website/uc-doc/contact_center/queues.md similarity index 100% rename from content/uc-doc/contact_center/queues.md rename to website/uc-doc/contact_center/queues.md diff --git a/content/uc-doc/contact_center/reporting.md b/website/uc-doc/contact_center/reporting.md similarity index 100% rename from content/uc-doc/contact_center/reporting.md rename to website/uc-doc/contact_center/reporting.md diff --git a/content/uc-doc/contact_center/skillbasedrouting.md b/website/uc-doc/contact_center/skillbasedrouting.md similarity index 100% rename from content/uc-doc/contact_center/skillbasedrouting.md rename to website/uc-doc/contact_center/skillbasedrouting.md diff --git a/content/uc-doc/contributors/contributing_doc.md b/website/uc-doc/contributors/contributing_doc.md similarity index 95% rename from content/uc-doc/contributors/contributing_doc.md rename to website/uc-doc/contributors/contributing_doc.md index 43f535fa..aad7cb28 100644 --- a/content/uc-doc/contributors/contributing_doc.md +++ b/website/uc-doc/contributors/contributing_doc.md @@ -5,8 +5,7 @@ title: Contributing to the Documentation ## Documentation guideline {#documentation-guideline} Here\'s the guideline/conventions to follow for the Wazo documentation. Wazo documentation is -generated with GatbsyJS. The source code is available on GitHub at - +generated with GatbsyJS. The source code is available on [GitHub](https://github.com/wazo-platform/wazo-platform.org) ### Language {#language} diff --git a/content/uc-doc/contributors/contributing_to_wazo.md b/website/uc-doc/contributors/contributing_to_wazo.md similarity index 100% rename from content/uc-doc/contributors/contributing_to_wazo.md rename to website/uc-doc/contributors/contributing_to_wazo.md diff --git a/content/uc-doc/contributors/debug_asterisk.md b/website/uc-doc/contributors/debug_asterisk.md similarity index 99% rename from content/uc-doc/contributors/debug_asterisk.md rename to website/uc-doc/contributors/debug_asterisk.md index bab3feaa..629b1730 100644 --- a/content/uc-doc/contributors/debug_asterisk.md +++ b/website/uc-doc/contributors/debug_asterisk.md @@ -523,4 +523,4 @@ Running asterisk under valgrind takes a lots of extra memory, so make sure you h ## External links {#external-links} -- +- [Debugging](https://docs.asterisk.org/Development/Debugging) diff --git a/content/uc-doc/contributors/debug_daemon.md b/website/uc-doc/contributors/debug_daemon.md similarity index 100% rename from content/uc-doc/contributors/debug_daemon.md rename to website/uc-doc/contributors/debug_daemon.md diff --git a/content/uc-doc/contributors/diagrams.md b/website/uc-doc/contributors/diagrams.md similarity index 100% rename from content/uc-doc/contributors/diagrams.md rename to website/uc-doc/contributors/diagrams.md diff --git a/content/uc-doc/contributors/generate_custom_prompts.md b/website/uc-doc/contributors/generate_custom_prompts.md similarity index 94% rename from content/uc-doc/contributors/generate_custom_prompts.md rename to website/uc-doc/contributors/generate_custom_prompts.md index 181591c7..9158a8f6 100644 --- a/content/uc-doc/contributors/generate_custom_prompts.md +++ b/website/uc-doc/contributors/generate_custom_prompts.md @@ -14,7 +14,7 @@ only covers the Wazo prompts, but it may be adapted for Asterisk prompts. 1. Create an account on Transifex and join the team of translation of Wazo. 2. Translate the prompts in the wazo-prompt resource. -3. Go to and download the file on your Wazo. You should have +3. Go to [Transifex](https://www.transifex.com/wazo/wazo) and download the file on your Wazo. You should have a file named like `for_use_wazo_wazo-prompt_pt_BR.ini`. 4. On your Wazo, download the tool to automate the use of Google TTS: diff --git a/content/uc-doc/contributors/guidelines.md b/website/uc-doc/contributors/guidelines.md similarity index 100% rename from content/uc-doc/contributors/guidelines.md rename to website/uc-doc/contributors/guidelines.md diff --git a/content/uc-doc/contributors/index.md b/website/uc-doc/contributors/index.md similarity index 100% rename from content/uc-doc/contributors/index.md rename to website/uc-doc/contributors/index.md diff --git a/content/uc-doc/contributors/integration-tests.md b/website/uc-doc/contributors/integration-tests.md similarity index 100% rename from content/uc-doc/contributors/integration-tests.md rename to website/uc-doc/contributors/integration-tests.md diff --git a/content/uc-doc/contributors/network.md b/website/uc-doc/contributors/network.md similarity index 100% rename from content/uc-doc/contributors/network.md rename to website/uc-doc/contributors/network.md diff --git a/content/uc-doc/contributors/plugins.md b/website/uc-doc/contributors/plugins.md similarity index 100% rename from content/uc-doc/contributors/plugins.md rename to website/uc-doc/contributors/plugins.md diff --git a/content/uc-doc/contributors/profile_python.md b/website/uc-doc/contributors/profile_python.md similarity index 100% rename from content/uc-doc/contributors/profile_python.md rename to website/uc-doc/contributors/profile_python.md diff --git a/content/uc-doc/contributors/provisioning/add_phone_to_plugin.md b/website/uc-doc/contributors/provisioning/add_phone_to_plugin.md similarity index 100% rename from content/uc-doc/contributors/provisioning/add_phone_to_plugin.md rename to website/uc-doc/contributors/provisioning/add_phone_to_plugin.md diff --git a/content/uc-doc/contributors/provisioning/developing_plugins.md b/website/uc-doc/contributors/provisioning/developing_plugins.md similarity index 100% rename from content/uc-doc/contributors/provisioning/developing_plugins.md rename to website/uc-doc/contributors/provisioning/developing_plugins.md diff --git a/content/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-1.md b/website/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-1.md similarity index 100% rename from content/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-1.md rename to website/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-1.md diff --git a/content/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-2.md b/website/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-2.md similarity index 100% rename from content/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-2.md rename to website/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-2.md diff --git a/content/uc-doc/contributors/provisioning/index.md b/website/uc-doc/contributors/provisioning/index.md similarity index 100% rename from content/uc-doc/contributors/provisioning/index.md rename to website/uc-doc/contributors/provisioning/index.md diff --git a/content/uc-doc/contributors/provisioning/introduction-to-the-plugin-model-of-the-new-provisioning-server.md b/website/uc-doc/contributors/provisioning/introduction-to-the-plugin-model-of-the-new-provisioning-server.md similarity index 100% rename from content/uc-doc/contributors/provisioning/introduction-to-the-plugin-model-of-the-new-provisioning-server.md rename to website/uc-doc/contributors/provisioning/introduction-to-the-plugin-model-of-the-new-provisioning-server.md diff --git a/content/uc-doc/contributors/provisioning/managing_dhcp_server_configuration.md b/website/uc-doc/contributors/provisioning/managing_dhcp_server_configuration.md similarity index 100% rename from content/uc-doc/contributors/provisioning/managing_dhcp_server_configuration.md rename to website/uc-doc/contributors/provisioning/managing_dhcp_server_configuration.md diff --git a/content/uc-doc/contributors/provisioning/managing_plugins.md b/website/uc-doc/contributors/provisioning/managing_plugins.md similarity index 100% rename from content/uc-doc/contributors/provisioning/managing_plugins.md rename to website/uc-doc/contributors/provisioning/managing_plugins.md diff --git a/content/uc-doc/contributors/provisioning/nat_environment.md b/website/uc-doc/contributors/provisioning/nat_environment.md similarity index 100% rename from content/uc-doc/contributors/provisioning/nat_environment.md rename to website/uc-doc/contributors/provisioning/nat_environment.md diff --git a/content/uc-doc/contributors/provisioning/testing_new_sip_phone.md b/website/uc-doc/contributors/provisioning/testing_new_sip_phone.md similarity index 100% rename from content/uc-doc/contributors/provisioning/testing_new_sip_phone.md rename to website/uc-doc/contributors/provisioning/testing_new_sip_phone.md diff --git a/content/uc-doc/contributors/sccp.md b/website/uc-doc/contributors/sccp.md similarity index 100% rename from content/uc-doc/contributors/sccp.md rename to website/uc-doc/contributors/sccp.md diff --git a/content/uc-doc/contributors/style_guide.md b/website/uc-doc/contributors/style_guide.md similarity index 100% rename from content/uc-doc/contributors/style_guide.md rename to website/uc-doc/contributors/style_guide.md diff --git a/content/uc-doc/contributors/translate.md b/website/uc-doc/contributors/translate.md similarity index 84% rename from content/uc-doc/contributors/translate.md rename to website/uc-doc/contributors/translate.md index 25d21228..8d88cfd7 100644 --- a/content/uc-doc/contributors/translate.md +++ b/website/uc-doc/contributors/translate.md @@ -9,8 +9,8 @@ community. Languages and prompts are recorded by several studios. The information for those languages are: -- French : Super Sonic productions () -- English : Asterisk voice () +- French : Super Sonic productions (supersonicprod@wanadoo.fr) +- English : Asterisk voice (allison@theasteriskvoice.com) - German : ATS studio - Italian : ATS studio diff --git a/content/uc-doc/contributors/typing.md b/website/uc-doc/contributors/typing.md similarity index 100% rename from content/uc-doc/contributors/typing.md rename to website/uc-doc/contributors/typing.md diff --git a/content/uc-doc/ecosystem/index.md b/website/uc-doc/ecosystem/index.md similarity index 100% rename from content/uc-doc/ecosystem/index.md rename to website/uc-doc/ecosystem/index.md diff --git a/content/uc-doc/high_availability/index.md b/website/uc-doc/high_availability/index.md similarity index 100% rename from content/uc-doc/high_availability/index.md rename to website/uc-doc/high_availability/index.md diff --git a/content/uc-doc/high_availability/introduction.md b/website/uc-doc/high_availability/introduction.md similarity index 97% rename from content/uc-doc/high_availability/introduction.md rename to website/uc-doc/high_availability/introduction.md index 0a4d8a83..c3f42443 100644 --- a/content/uc-doc/high_availability/introduction.md +++ b/website/uc-doc/high_availability/introduction.md @@ -123,7 +123,7 @@ to the slave every hour (:00). Replication can be started manually by running the replication scripts on the master: ```shell -xivo-master-slave-db-replication +xivo-master-slave-db-replication \ wazo-sync ``` @@ -148,11 +148,11 @@ Less importantly, these are also excluded: 4 scripts are used to manage services and data replication. -- xivo-master-slave-db-replication is used on the master to replicate the master's data +- xivo-master-slave-db-replication \ is used on the master to replicate the master's data on the slave server. It runs on the master. - xivo-manage-slave-services {start,stop} is used on the slave to start, stop monit and asterisk. The services won't be restarted after an upgrade or restart. -- xivo-check-master-status is used to check the status of the master and enable or +- xivo-check-master-status \ is used to check the status of the master and enable or disable services accordingly. - wazo-sync is used to sync directories from master to slave. diff --git a/content/uc-doc/index.md b/website/uc-doc/index.md similarity index 100% rename from content/uc-doc/index.md rename to website/uc-doc/index.md diff --git a/content/uc-doc/installation/index.md b/website/uc-doc/installation/index.md similarity index 100% rename from content/uc-doc/installation/index.md rename to website/uc-doc/installation/index.md diff --git a/content/uc-doc/installation/install-system.md b/website/uc-doc/installation/install-system.md similarity index 96% rename from content/uc-doc/installation/install-system.md rename to website/uc-doc/installation/install-system.md index 211877ad..8a503939 100644 --- a/content/uc-doc/installation/install-system.md +++ b/website/uc-doc/installation/install-system.md @@ -59,8 +59,7 @@ To install the Unified Communication use case in an all-in-one setup, do the fol ``` 6. Edit the file `inventories/uc-engine` to add your preferences and passwords. The various - variables that can be customized are described at - . + variables that can be customized are described [here](https://github.com/wazo-platform/wazo-ansible/blob/master/README.md#variables). By default, Wazo Platform will install the development version. To install the latest stable version, activate the following settings in `inventories/uc-engine`: diff --git a/content/uc-doc/installation/postinstall.md b/website/uc-doc/installation/postinstall.md similarity index 100% rename from content/uc-doc/installation/postinstall.md rename to website/uc-doc/installation/postinstall.md diff --git a/content/uc-doc/introduction.md b/website/uc-doc/introduction.md similarity index 100% rename from content/uc-doc/introduction.md rename to website/uc-doc/introduction.md diff --git a/content/uc-doc/system/backup_restore.md b/website/uc-doc/system/backup_restore.md similarity index 100% rename from content/uc-doc/system/backup_restore.md rename to website/uc-doc/system/backup_restore.md diff --git a/content/uc-doc/system/configuration_files.md b/website/uc-doc/system/configuration_files.md similarity index 100% rename from content/uc-doc/system/configuration_files.md rename to website/uc-doc/system/configuration_files.md diff --git a/content/uc-doc/system/dhcp/index.md b/website/uc-doc/system/dhcp/index.md similarity index 100% rename from content/uc-doc/system/dhcp/index.md rename to website/uc-doc/system/dhcp/index.md diff --git a/content/uc-doc/system/https_certificate.md b/website/uc-doc/system/https_certificate.md similarity index 100% rename from content/uc-doc/system/https_certificate.md rename to website/uc-doc/system/https_certificate.md diff --git a/content/uc-doc/system/index.md b/website/uc-doc/system/index.md similarity index 100% rename from content/uc-doc/system/index.md rename to website/uc-doc/system/index.md diff --git a/content/uc-doc/system/log_files.md b/website/uc-doc/system/log_files.md similarity index 100% rename from content/uc-doc/system/log_files.md rename to website/uc-doc/system/log_files.md diff --git a/content/uc-doc/system/network/index.md b/website/uc-doc/system/network/index.md similarity index 95% rename from content/uc-doc/system/network/index.md rename to website/uc-doc/system/network/index.md index bbd8c176..5945b16b 100644 --- a/content/uc-doc/system/network/index.md +++ b/website/uc-doc/system/network/index.md @@ -25,7 +25,7 @@ are applied at startup (i.e. each time the network interface goes up). fi ``` -3. Fields , and should be replaced by your specific +3. Fields \, \ and \ should be replaced by your specific configuration. For example, if you want to add a route for 192.168.50.128/25 via 192.168.17.254 which should be added when eth0 goes up: diff --git a/content/uc-doc/system/nginx.md b/website/uc-doc/system/nginx.md similarity index 100% rename from content/uc-doc/system/nginx.md rename to website/uc-doc/system/nginx.md diff --git a/content/uc-doc/system/ntp.md b/website/uc-doc/system/ntp.md similarity index 100% rename from content/uc-doc/system/ntp.md rename to website/uc-doc/system/ntp.md diff --git a/content/uc-doc/system/performance.md b/website/uc-doc/system/performance.md similarity index 100% rename from content/uc-doc/system/performance.md rename to website/uc-doc/system/performance.md diff --git a/content/uc-doc/system/proxy.md b/website/uc-doc/system/proxy.md similarity index 100% rename from content/uc-doc/system/proxy.md rename to website/uc-doc/system/proxy.md diff --git a/content/uc-doc/system/purge_logs.md b/website/uc-doc/system/purge_logs.md similarity index 100% rename from content/uc-doc/system/purge_logs.md rename to website/uc-doc/system/purge_logs.md diff --git a/content/uc-doc/system/service.md b/website/uc-doc/system/service.md similarity index 100% rename from content/uc-doc/system/service.md rename to website/uc-doc/system/service.md diff --git a/content/uc-doc/system/service_authentication/index.md b/website/uc-doc/system/service_authentication/index.md similarity index 100% rename from content/uc-doc/system/service_authentication/index.md rename to website/uc-doc/system/service_authentication/index.md diff --git a/content/uc-doc/system/service_discovery.md b/website/uc-doc/system/service_discovery.md similarity index 100% rename from content/uc-doc/system/service_discovery.md rename to website/uc-doc/system/service_discovery.md diff --git a/content/uc-doc/system/wazo-auth/developer.md b/website/uc-doc/system/wazo-auth/developer.md similarity index 100% rename from content/uc-doc/system/wazo-auth/developer.md rename to website/uc-doc/system/wazo-auth/developer.md diff --git a/content/uc-doc/system/wazo-auth/index.md b/website/uc-doc/system/wazo-auth/index.md similarity index 100% rename from content/uc-doc/system/wazo-auth/index.md rename to website/uc-doc/system/wazo-auth/index.md diff --git a/content/uc-doc/system/wazo-auth/introduction.md b/website/uc-doc/system/wazo-auth/introduction.md similarity index 94% rename from content/uc-doc/system/wazo-auth/introduction.md rename to website/uc-doc/system/wazo-auth/introduction.md index ebde9b7c..046de634 100644 --- a/content/uc-doc/system/wazo-auth/introduction.md +++ b/website/uc-doc/system/wazo-auth/introduction.md @@ -6,7 +6,7 @@ wazo-auth is a scalable, extendable and configurable authentication service. It interface to emit tokens to users who can then use those tokens to identify and authenticate themselves with other services compatible with wazo-auth. -The HTTP API reference is at . +The HTTP API reference is at [documentation](https://wazo-platform.org/documentation). - [developer](/uc-doc/system/wazo-auth/developer) - [stock_plugins](/uc-doc/system/wazo-auth/stock_plugins) @@ -40,7 +40,7 @@ If Alice wants to revoke her token before its expiration: curl -k -X DELETE -H 'Content-Type: application/json' "https://localhost/api/auth/0.1/token/1823c1ee-6c6a-0cdc-d869-964a7f08a744" ``` -See for more details about the HTTP API. +See [documentation](https://wazo-platform.org/documentation) for more details about the HTTP API. See [Service Authentication](/uc-doc/system/service_authentication) for details about the authentication process. @@ -95,7 +95,7 @@ or modified using the REST API. ## HTTP API Reference -The complete HTTP API documentation is at . +The complete HTTP API documentation is [here](https://wazo-platform.org/documentation). See also the [wazo-auth changelog](/uc-doc/api_sdk/rest_api/changelog). diff --git a/content/uc-doc/system/wazo-auth/stock_plugins.md b/website/uc-doc/system/wazo-auth/stock_plugins.md similarity index 100% rename from content/uc-doc/system/wazo-auth/stock_plugins.md rename to website/uc-doc/system/wazo-auth/stock_plugins.md diff --git a/content/uc-doc/system/wazo-calld/developer.md b/website/uc-doc/system/wazo-calld/developer.md similarity index 100% rename from content/uc-doc/system/wazo-calld/developer.md rename to website/uc-doc/system/wazo-calld/developer.md diff --git a/content/uc-doc/system/wazo-calld/index.md b/website/uc-doc/system/wazo-calld/index.md similarity index 100% rename from content/uc-doc/system/wazo-calld/index.md rename to website/uc-doc/system/wazo-calld/index.md diff --git a/content/uc-doc/system/wazo-confd/developer.md b/website/uc-doc/system/wazo-confd/developer.md similarity index 100% rename from content/uc-doc/system/wazo-confd/developer.md rename to website/uc-doc/system/wazo-confd/developer.md diff --git a/content/uc-doc/system/wazo-confd/index.md b/website/uc-doc/system/wazo-confd/index.md similarity index 100% rename from content/uc-doc/system/wazo-confd/index.md rename to website/uc-doc/system/wazo-confd/index.md diff --git a/content/uc-doc/system/wazo-confd/introduction.md b/website/uc-doc/system/wazo-confd/introduction.md similarity index 100% rename from content/uc-doc/system/wazo-confd/introduction.md rename to website/uc-doc/system/wazo-confd/introduction.md diff --git a/content/uc-doc/system/wazo-confgend/developer.md b/website/uc-doc/system/wazo-confgend/developer.md similarity index 100% rename from content/uc-doc/system/wazo-confgend/developer.md rename to website/uc-doc/system/wazo-confgend/developer.md diff --git a/content/uc-doc/system/wazo-confgend/index.md b/website/uc-doc/system/wazo-confgend/index.md similarity index 100% rename from content/uc-doc/system/wazo-confgend/index.md rename to website/uc-doc/system/wazo-confgend/index.md diff --git a/content/uc-doc/system/wazo-confgend/introduction.md b/website/uc-doc/system/wazo-confgend/introduction.md similarity index 100% rename from content/uc-doc/system/wazo-confgend/introduction.md rename to website/uc-doc/system/wazo-confgend/introduction.md diff --git a/content/uc-doc/system/wazo-dird/configuration.md b/website/uc-doc/system/wazo-dird/configuration.md similarity index 100% rename from content/uc-doc/system/wazo-dird/configuration.md rename to website/uc-doc/system/wazo-dird/configuration.md diff --git a/content/uc-doc/system/wazo-dird/developer.md b/website/uc-doc/system/wazo-dird/developer.md similarity index 98% rename from content/uc-doc/system/wazo-dird/developer.md rename to website/uc-doc/system/wazo-dird/developer.md index ce0738b6..65992cf6 100644 --- a/content/uc-doc/system/wazo-dird/developer.md +++ b/website/uc-doc/system/wazo-dird/developer.md @@ -247,8 +247,8 @@ a new view for the format that the phone consumes. routes on Flask. Those routes would typically call a service. `args` is a dictionary containing: - key `config`: the section of the configuration file for all views in dict form - key `services`: a dictionary of services, indexed by name, which may be called from a route - - key `http_app`: the [Flask application]() instance - - key `rest_api`: a [Flask-RestFul Api]() instance + - key `http_app`: the `Flask application` instance + - key `rest_api`: a `Flask-RestFul Api` instance - `unload()`: free resources used by the plugin. ### Example diff --git a/content/uc-doc/system/wazo-dird/index.md b/website/uc-doc/system/wazo-dird/index.md similarity index 100% rename from content/uc-doc/system/wazo-dird/index.md rename to website/uc-doc/system/wazo-dird/index.md diff --git a/content/uc-doc/system/wazo-dird/introduction.md b/website/uc-doc/system/wazo-dird/introduction.md similarity index 100% rename from content/uc-doc/system/wazo-dird/introduction.md rename to website/uc-doc/system/wazo-dird/introduction.md diff --git a/content/uc-doc/system/wazo-dird/stock_plugins.md b/website/uc-doc/system/wazo-dird/stock_plugins.md similarity index 98% rename from content/uc-doc/system/wazo-dird/stock_plugins.md rename to website/uc-doc/system/wazo-dird/stock_plugins.md index 78b4afdb..7baa9ba8 100644 --- a/content/uc-doc/system/wazo-dird/stock_plugins.md +++ b/website/uc-doc/system/wazo-dird/stock_plugins.md @@ -8,8 +8,7 @@ title: Stock Plugins Documentation View name: default_json -Purpose: present directory entries in JSON format. The format is detailed in -. +Purpose: present directory entries in JSON format. The format is detailed in [documentation](https://wazo-platform.org/documentation). ### headers diff --git a/content/uc-doc/system/wazo-phoned.md b/website/uc-doc/system/wazo-phoned.md similarity index 100% rename from content/uc-doc/system/wazo-phoned.md rename to website/uc-doc/system/wazo-phoned.md diff --git a/content/uc-doc/system/wazo-sysconfd.md b/website/uc-doc/system/wazo-sysconfd.md similarity index 100% rename from content/uc-doc/system/wazo-sysconfd.md rename to website/uc-doc/system/wazo-sysconfd.md diff --git a/content/uc-doc/system/wazo-webhookd/index.md b/website/uc-doc/system/wazo-webhookd/index.md similarity index 80% rename from content/uc-doc/system/wazo-webhookd/index.md rename to website/uc-doc/system/wazo-webhookd/index.md index 38d5ecda..61fe1202 100644 --- a/content/uc-doc/system/wazo-webhookd/index.md +++ b/website/uc-doc/system/wazo-webhookd/index.md @@ -2,16 +2,10 @@ title: 'wazo-webhookd' --- -- [mobile subscriptions](#mobile-subscriptions) -- [custom plugin-based subscriptions](#custom-plugin-based-subscriptions) - - [How to add a new webhookd type (a.k.a service)](#how-to-add-a-new-webhookd-type-a.k.a-service) - - [How to trigger code on a bus event](#how-to-trigger-code-on-a-bus-event) - - [How to programmatically create a subscription](#how-to-programmatically-create-a-subscription) - ## Overview wazo-webhookd is a component responsible for managing _subscriptions_ to internal platform events, -such that custom behavior can be triggered in reaction to those events. +such that custom behavior can be triggered in reaction to those events. This can be used to allow components external to the Wazo Platform to be notified of those events, in effect allowing for asynchronous integrations with other systems. @@ -32,13 +26,13 @@ are: As well as supporting configuration of custom behaviors through HTTP subscriptions and custom Python plugins, wazo-webhookd can also automatically create and manage special subscriptions for mobile -users. +users. These _mobile subscriptions_ can provide push notification services for Wazo Platform events relevant to mobile users, such as incoming calls, voicemails, missed calls, chat messages, etc. When a mobile user logs in, authentication events generated by that login are handled by wazo-webhookd, which in turn creates a mobile subscription for that user. That subscription -specifies the internal events which are relevant for push notifications to mobile users. +specifies the internal events which are relevant for push notifications to mobile users. When those events are emitted by the platform, the subscription triggers the "hook" code that generates the relevant push notifications, by interacting with the configured third-party push notification service providers APIs (e.g. FCM, APNS). @@ -48,7 +42,42 @@ Note: those subscriptions can not be created manually through the REST API. For more details on configuring and using push notifications, see [the push notification page](/uc-doc/api_sdk/mobile/push_notification). -![Mobile push notifications diagram](/diagrams/wazo-webhookd-mobile-push.svg) +```mermaid +flowchart TB + %% Define nodes + subgraph wazo_platform["Wazo Platform"] + webhookd["wazo-webhookd
(Webhook service)"] + db["PostgreSQL
(Database)"] + bus["RabbitMQ
(Messaging Bus)"] + auth["wazo-auth
(Authentication service)"] + end + + subgraph PushServer[" "] + external_push_server["Supported push message service
(HTTP)"]:::externalService + end + + subgraph User[" "] + MobileUser["👤 Mobile User"]:::person + end + + %% Define relationships + MobileUser --> |"Log in from API
(mobile session)"| wazo_platform + webhookd --> |"SQL (Store subscriptions)"| db + bus --> |"Relays Wazo platform events (AMQP)"| webhookd + auth --> |"Generates user login events (AMQP)"| bus + webhookd --> |"Sends push notifications (HTTP)"| external_push_server + auth -.- |"Notify of user login events (Bus Event)"| webhookd + external_push_server --> |"Relays push notifications"| MobileUser + + %% Define styles + classDef person fill:#08427B,stroke:#073B6F,color:#fff + classDef transparent fill:transparent,stroke:transparent + classDef externalService fill:#333,color:#fff + classDef stroked stroke-dasharray:5 5 + class User transparent + class PushServer transparent + class wazo_platform stroked +``` ## Custom plugin-based subscriptions diff --git a/content/uc-doc/troubleshooting/index.md b/website/uc-doc/troubleshooting/index.md similarity index 100% rename from content/uc-doc/troubleshooting/index.md rename to website/uc-doc/troubleshooting/index.md diff --git a/content/uc-doc/upgrade/index.md b/website/uc-doc/upgrade/index.md similarity index 100% rename from content/uc-doc/upgrade/index.md rename to website/uc-doc/upgrade/index.md diff --git a/content/uc-doc/upgrade/introduction.md b/website/uc-doc/upgrade/introduction.md similarity index 100% rename from content/uc-doc/upgrade/introduction.md rename to website/uc-doc/upgrade/introduction.md diff --git a/content/uc-doc/upgrade/migrate_i386_to_amd64.md b/website/uc-doc/upgrade/migrate_i386_to_amd64.md similarity index 100% rename from content/uc-doc/upgrade/migrate_i386_to_amd64.md rename to website/uc-doc/upgrade/migrate_i386_to_amd64.md diff --git a/content/uc-doc/upgrade/old_upgrade_notes.md b/website/uc-doc/upgrade/old_upgrade_notes.md similarity index 100% rename from content/uc-doc/upgrade/old_upgrade_notes.md rename to website/uc-doc/upgrade/old_upgrade_notes.md diff --git a/content/uc-doc/upgrade/upgrade_from_wazo_18_03.md b/website/uc-doc/upgrade/upgrade_from_wazo_18_03.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_from_wazo_18_03.md rename to website/uc-doc/upgrade/upgrade_from_wazo_18_03.md diff --git a/content/uc-doc/upgrade/upgrade_notes.md b/website/uc-doc/upgrade/upgrade_notes.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes.md rename to website/uc-doc/upgrade/upgrade_notes.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/18-01/index.md b/website/uc-doc/upgrade/upgrade_notes_details/18-01/index.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/18-01/index.md rename to website/uc-doc/upgrade/upgrade_notes_details/18-01/index.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/18-01/stretch.md b/website/uc-doc/upgrade/upgrade_notes_details/18-01/stretch.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/18-01/stretch.md rename to website/uc-doc/upgrade/upgrade_notes_details/18-01/stretch.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/18-12/asterisk_16.md b/website/uc-doc/upgrade/upgrade_notes_details/18-12/asterisk_16.md similarity index 78% rename from content/uc-doc/upgrade/upgrade_notes_details/18-12/asterisk_16.md rename to website/uc-doc/upgrade/upgrade_notes_details/18-12/asterisk_16.md index 0739e216..d6c58898 100644 --- a/content/uc-doc/upgrade/upgrade_notes_details/18-12/asterisk_16.md +++ b/website/uc-doc/upgrade/upgrade_notes_details/18-12/asterisk_16.md @@ -20,5 +20,5 @@ your `cel.conf` or `cel.d/*` you will have to remove that line from your configu You can see the complete list of changes from the Asterisk website: -- -- +- [https://docs.asterisk.org/Asterisk_16_Documentation/Upgrading](https://docs.asterisk.org/Asterisk_16_Documentation/Upgrading) +- [https://github.com/asterisk/asterisk/blob/16/CHANGES](https://github.com/asterisk/asterisk/blob/16/CHANGES) diff --git a/content/uc-doc/upgrade/upgrade_notes_details/18-12/index.md b/website/uc-doc/upgrade/upgrade_notes_details/18-12/index.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/18-12/index.md rename to website/uc-doc/upgrade/upgrade_notes_details/18-12/index.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/19-03/index.md b/website/uc-doc/upgrade/upgrade_notes_details/19-03/index.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/19-03/index.md rename to website/uc-doc/upgrade/upgrade_notes_details/19-03/index.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/19-03/sounds.md b/website/uc-doc/upgrade/upgrade_notes_details/19-03/sounds.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/19-03/sounds.md rename to website/uc-doc/upgrade/upgrade_notes_details/19-03/sounds.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/19-13/buster.md b/website/uc-doc/upgrade/upgrade_notes_details/19-13/buster.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/19-13/buster.md rename to website/uc-doc/upgrade/upgrade_notes_details/19-13/buster.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/19-13/index.md b/website/uc-doc/upgrade/upgrade_notes_details/19-13/index.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/19-13/index.md rename to website/uc-doc/upgrade/upgrade_notes_details/19-13/index.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/21-01/asterisk_18.md b/website/uc-doc/upgrade/upgrade_notes_details/21-01/asterisk_18.md similarity index 83% rename from content/uc-doc/upgrade/upgrade_notes_details/21-01/asterisk_18.md rename to website/uc-doc/upgrade/upgrade_notes_details/21-01/asterisk_18.md index c64b7c53..e9cb5464 100644 --- a/content/uc-doc/upgrade/upgrade_notes_details/21-01/asterisk_18.md +++ b/website/uc-doc/upgrade/upgrade_notes_details/21-01/asterisk_18.md @@ -17,4 +17,4 @@ major instability issues in Asterisk. You can see the complete list of changes from the Asterisk website: -- +- [https://docs.asterisk.org/Asterisk_18_Documentation/Upgrading](https://docs.asterisk.org/Asterisk_18_Documentation/Upgrading) diff --git a/content/uc-doc/upgrade/upgrade_notes_details/21-01/index.md b/website/uc-doc/upgrade/upgrade_notes_details/21-01/index.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/21-01/index.md rename to website/uc-doc/upgrade/upgrade_notes_details/21-01/index.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/22-10/asterisk_19.md b/website/uc-doc/upgrade/upgrade_notes_details/22-10/asterisk_19.md similarity index 83% rename from content/uc-doc/upgrade/upgrade_notes_details/22-10/asterisk_19.md rename to website/uc-doc/upgrade/upgrade_notes_details/22-10/asterisk_19.md index 0da3f6d8..c64a1907 100644 --- a/content/uc-doc/upgrade/upgrade_notes_details/22-10/asterisk_19.md +++ b/website/uc-doc/upgrade/upgrade_notes_details/22-10/asterisk_19.md @@ -17,4 +17,4 @@ major instability issues in Asterisk. You can see the complete list of changes from the Asterisk website: -- +- [https://docs.asterisk.org/Asterisk_19_Documentation/Upgrading](https://docs.asterisk.org/Asterisk_19_Documentation/Upgrading) diff --git a/content/uc-doc/upgrade/upgrade_notes_details/22-10/index.md b/website/uc-doc/upgrade/upgrade_notes_details/22-10/index.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/22-10/index.md rename to website/uc-doc/upgrade/upgrade_notes_details/22-10/index.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/22-16/index.md b/website/uc-doc/upgrade/upgrade_notes_details/22-16/index.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/22-16/index.md rename to website/uc-doc/upgrade/upgrade_notes_details/22-16/index.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/22-16/provd_plugins_python3.md b/website/uc-doc/upgrade/upgrade_notes_details/22-16/provd_plugins_python3.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/22-16/provd_plugins_python3.md rename to website/uc-doc/upgrade/upgrade_notes_details/22-16/provd_plugins_python3.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/23-04/asterisk_20.md b/website/uc-doc/upgrade/upgrade_notes_details/23-04/asterisk_20.md similarity index 83% rename from content/uc-doc/upgrade/upgrade_notes_details/23-04/asterisk_20.md rename to website/uc-doc/upgrade/upgrade_notes_details/23-04/asterisk_20.md index 7c7de62d..6b815365 100644 --- a/content/uc-doc/upgrade/upgrade_notes_details/23-04/asterisk_20.md +++ b/website/uc-doc/upgrade/upgrade_notes_details/23-04/asterisk_20.md @@ -17,4 +17,4 @@ major instability issues in Asterisk. You can see the complete list of changes from the Asterisk website:  -- +- [https://docs.asterisk.org/Asterisk_20_Documentation/Upgrading](https://docs.asterisk.org/Asterisk_20_Documentation/Upgrading) diff --git a/content/uc-doc/upgrade/upgrade_notes_details/23-04/index.md b/website/uc-doc/upgrade/upgrade_notes_details/23-04/index.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/23-04/index.md rename to website/uc-doc/upgrade/upgrade_notes_details/23-04/index.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/23-06/bullseye.md b/website/uc-doc/upgrade/upgrade_notes_details/23-06/bullseye.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/23-06/bullseye.md rename to website/uc-doc/upgrade/upgrade_notes_details/23-06/bullseye.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/23-06/index.md b/website/uc-doc/upgrade/upgrade_notes_details/23-06/index.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/23-06/index.md rename to website/uc-doc/upgrade/upgrade_notes_details/23-06/index.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/24-05/asterisk_21.md b/website/uc-doc/upgrade/upgrade_notes_details/24-05/asterisk_21.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/24-05/asterisk_21.md rename to website/uc-doc/upgrade/upgrade_notes_details/24-05/asterisk_21.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/24-05/index.md b/website/uc-doc/upgrade/upgrade_notes_details/24-05/index.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/24-05/index.md rename to website/uc-doc/upgrade/upgrade_notes_details/24-05/index.md diff --git a/content/uc-doc/upgrade/upgrade_notes_details/index.md b/website/uc-doc/upgrade/upgrade_notes_details/index.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_notes_details/index.md rename to website/uc-doc/upgrade/upgrade_notes_details/index.md diff --git a/content/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-bullseye.md b/website/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-bullseye.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-bullseye.md rename to website/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-bullseye.md diff --git a/content/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-buster.md b/website/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-buster.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-buster.md rename to website/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-buster.md diff --git a/content/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-stretch.md b/website/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-stretch.md similarity index 97% rename from content/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-stretch.md rename to website/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-stretch.md index ba1e1c74..a1560adc 100644 --- a/content/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-stretch.md +++ b/website/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-stretch.md @@ -4,7 +4,7 @@ title: Upgrade from Wazo < 19.04 Those procedures are valid if your Wazo installation is newer than 18.01 and older than 19.04. -# Upgrade to Wazo <= 18.03 +# Upgrade to Wazo \<= 18.03 Example to upgrade to Wazo 18.03: diff --git a/content/uc-doc/upgrade/upgrade_specific_version/index.md b/website/uc-doc/upgrade/upgrade_specific_version/index.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_specific_version/index.md rename to website/uc-doc/upgrade/upgrade_specific_version/index.md diff --git a/content/uc-doc/upgrade/upgrade_specific_version/introduction.md b/website/uc-doc/upgrade/upgrade_specific_version/introduction.md similarity index 100% rename from content/uc-doc/upgrade/upgrade_specific_version/introduction.md rename to website/uc-doc/upgrade/upgrade_specific_version/introduction.md diff --git a/content/uc-doc/upgrade/version_deprecation_policy.md b/website/uc-doc/upgrade/version_deprecation_policy.md similarity index 100% rename from content/uc-doc/upgrade/version_deprecation_policy.md rename to website/uc-doc/upgrade/version_deprecation_policy.md From 757251e3cbd9e317ea90ebcd675117b49858f997 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Fri, 25 Oct 2024 10:42:15 -0400 Subject: [PATCH 02/22] docs(uc-doc): move introduction contents to index --- website/docusaurus.config.ts | 8 +- website/package.json | 1 + website/redirects.ts | 42 +++ .../contact_directories/general.md | 343 ------------------ .../contact_directories/index.md | 341 ++++++++++++++++- .../administration/interconnections/index.md | 188 +++++++++- .../interconnections/introduction.md | 189 ---------- .../administration/provisioning/index.md | 53 ++- .../provisioning/introduction.md | 51 --- website/uc-doc/administration/users/index.md | 53 ++- website/uc-doc/administration/users/users.md | 55 --- website/uc-doc/api_sdk/mobile/index.md | 5 - ...ication.md => mobile_push_notification.md} | 36 +- website/uc-doc/contact_center/index.md | 22 ++ website/uc-doc/contact_center/introduction.md | 23 -- website/uc-doc/ecosystem/index.md | 3 +- website/uc-doc/high_availability/index.md | 204 ++++++++++- .../uc-doc/high_availability/introduction.md | 206 ----------- website/uc-doc/installation/index.md | 140 ++++++- website/uc-doc/installation/install-system.md | 142 -------- website/uc-doc/upgrade/index.md | 144 ++++++++ website/uc-doc/upgrade/introduction.md | 147 -------- website/yarn.lock | 21 ++ 23 files changed, 1220 insertions(+), 1197 deletions(-) create mode 100644 website/redirects.ts delete mode 100644 website/uc-doc/administration/contact_directories/general.md delete mode 100644 website/uc-doc/administration/interconnections/introduction.md delete mode 100644 website/uc-doc/administration/provisioning/introduction.md delete mode 100644 website/uc-doc/administration/users/users.md delete mode 100644 website/uc-doc/api_sdk/mobile/index.md rename website/uc-doc/api_sdk/{mobile/push_notification.md => mobile_push_notification.md} (93%) delete mode 100644 website/uc-doc/contact_center/introduction.md delete mode 100644 website/uc-doc/high_availability/introduction.md delete mode 100644 website/uc-doc/installation/install-system.md delete mode 100644 website/uc-doc/upgrade/introduction.md diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index d3840675..92d7c18f 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -1,6 +1,7 @@ import type * as Preset from '@docusaurus/preset-classic'; import type { Config } from '@docusaurus/types'; import { themes as prismThemes } from 'prism-react-renderer'; +import REDIRECTS from './redirects'; const config: Config = { title: 'Wazo Platform', @@ -146,7 +147,6 @@ const config: Config = { id: 'uc-doc', path: 'uc-doc', routeBasePath: 'uc-doc', - // sidebarPath: './sidebarsCommunity.js', }, ], [ @@ -159,6 +159,12 @@ const config: Config = { authorsMapPath: '../blog/authors.yml', }, ], + [ + '@docusaurus/plugin-client-redirects', + { + redirects: REDIRECTS + }, + ], ], }; diff --git a/website/package.json b/website/package.json index c50539f9..550e1cbc 100644 --- a/website/package.json +++ b/website/package.json @@ -22,6 +22,7 @@ }, "dependencies": { "@docusaurus/core": "^3.5.2", + "@docusaurus/plugin-client-redirects": "^3.5.2", "@docusaurus/preset-classic": "^3.5.2", "@docusaurus/theme-mermaid": "^3.5.2", "@iconify/react": "^5.0.1", diff --git a/website/redirects.ts b/website/redirects.ts new file mode 100644 index 00000000..0a17c707 --- /dev/null +++ b/website/redirects.ts @@ -0,0 +1,42 @@ +import type { Options } from '@docusaurus/plugin-client-redirects' + +const REDIRECTS: Options['redirects'] = [ + { + from: '/uc-doc/administration/contact_directories/general', + to: '/uc-doc/administration/contact_directories', + }, + { + from: '/uc-doc/administration/interconnections/introduction', + to: '/uc-doc/administration/interconnections', + }, + { + from: '/uc-doc/administration/provisioning/introduction', + to: '/uc-doc/administration/provisioning', + }, + { + from: '/uc-doc/administration/users', + to: '/uc-doc/administration', + }, + { + from: ['/uc-doc/api_sdk/mobile/push_notification', '/uc-doc/api_sdk/mobile'], + to: '/uc-doc/api_sdk/mobile_push_notification', + }, + { + from: '/uc-doc/contact_center/introduction', + to: '/uc-doc/contact_center', + }, + { + from: '/uc-doc/high_availability/introduction', + to: '/uc-doc/high_availability', + }, + { + from: '/uc-doc/installation/install-system', + to: '/uc-doc/installation', + }, + { + from: '/uc-doc/upgrade/introduction', + to: '/uc-doc/upgrade', + }, +]; + +export default REDIRECTS diff --git a/website/uc-doc/administration/contact_directories/general.md b/website/uc-doc/administration/contact_directories/general.md deleted file mode 100644 index a437de85..00000000 --- a/website/uc-doc/administration/contact_directories/general.md +++ /dev/null @@ -1,343 +0,0 @@ ---- -title: General ---- - -Wazo platform provides extensive and extensible support for managing sources of contact information. -This support involves both internal implementations of contact directories that wazo-platform users -can automatically benefit from, as well as integrations with common external contact directories -that can serve as sources of information on how to reach people and services both internal and -external to the wazo system. - -Given proper configuration within the wazo integration, those integrated directory sources can -provide functionalities such as - -- automatic [reverse lookups](#reverse-lookups) on incoming call numbers -- global search across all configured directories available to a user -- allowing users to use wazo to call registered contact using number available from contact source -- allowing users to keep a list of favorite contacts across all directory sources, which are made - available for quick access by an appropriate wazo client - -## Glossary - -- **directory source**: an internal (part of the wazo stack) or external(third-party software - deployed separately from the wazo platform) provider of contact information, which can be made - available to wazo users through the wazo-dird component of the wazo platform; alias **directory - backend**, shorterned form **source** or **backend** -- **contact**: a record of an entity(individual person, organization, service, object) that users - which to account for in their directories, and which are usually addressable and reachable through - different methods of communication, including telephony and email. Alias **contact entry**. -- **directory profile**: a configuration object specifying which directory sources are made - available to a tenant's users, and which functionalities are supported by that source -- **contact attribute**: a named piece of information associated to a contact entry in a directory - source, such as _name_, _telephoneNumber_, _mobileNumber_, _emailAddress_, etc. Alias **source - attribute**. -- **caller id**: caller identification information, includes a "caller name" and a "caller number", - often represented in the format `"Caller Name" `, can be carried in an incoming - call by the calling party and can be overriden/completed by the wazo system using directory - information(see [**reverse lookup**](#reverse-lookups) section). Alias **caller identification - information**. See also [Caller ID](/uc-doc/administration/callerid). - -## Configuring a new directory source - -### General configuration steps - -Different directory source backends require specific configurations and might require additional -preliminary steps, such as deploying third-party(non-wazo) software, which will not be documented -here. - -Given any backend-specific preliminary steps performed, the general steps necessary to setup a -directory source and make it available to wazo users can be summarized: - -1. Make sure any necessary plugin for the directory backend is enabled in the wazo-dird - configuration; -2. Use the source backend API of the backend plugin to create a source entity containing all - relevant configuration for that backend; -3. Update the directory profile of the tenant to include the newly created source, with the relevant - configuration specifying the supported functionalities of that source for that profile - -Following these steps, a wazo user of that tenant should be able to use the newly configured source -for its supported functionalities(depending on the configurations at step 2 and 3). - -### Plugins configuration - -All directory backend plugins already included with wazo platform are enabled by default, but -plugins for custom directory backends will require explicit configuration. - -See [wazo-dird configuration](/uc-doc/system/wazo-dird/configuration) for details on wazo-dird -configuration. - -### Creating a source configuration - -To configure a new source, a source configuration resource is created using the appropriate -backend-specific endpoint of the REST API. All backends expose a similar API for manipulating source -configurations, through an endpoint of the form `/backends/{backend type}/sources`. An HTTP `POST` -request on that endpoint with the proper json configuration would thus create the source. - -See the -[wazo-dird API reference for configuration endpoints](/documentation/api/contact.html#tag/configuration) -for examples and details of each backend endpoint. - -### Common configuration options - -All directory source backends require some common configuration options. The desirable values for -those options might depend on the specifics of a backend to be configured. As such some tweakings -specific to each wazo platform deployment may be required. - -- **name**: a name given to that directory source, for purpose of administration. Should be unique - within a tenant; -- **first_match_columns**: the contact attributes in the directory source that should be used to - match a search term to a single contact, as for reverse lookups. This usually will include all - source attributes that may contain a phone number the contact might use to call in a wazo user(see - [**reverse lookup**](#reverse-lookups)); -- **searched_columns**: a list of contact attributes which should be considered when searching all - contacts matching a given search term. This usually should include any attributes relevant to the - wazo users and by which the user may attempt to retrieve a contact entry, such as attributes - referring to a contact's name(including name components) as well as attributes referring to a - contact's reachable addresses(email, phone numbers); -- **format_columns**: a mapping between contact attributes that should be made available to a wazo - user, and formatting strings that can refer to the contact attributes available in the directory - source. This option allows the administrator to transform the contact information available in the - directory source into a more convenient format to present to the wazo system users. This option is - also used to affect the result of reverse lookups(see [reverse lookup](#reverse-lookups)). - -As a represensative example, the default configuration for the internal wazo directory source looks -like such: - -```json -{ - "auth": { - "host": "localhost", - "port": 9497, - "prefix": None, - "https": False, - "key_file": "/var/lib/wazo-auth-keys/wazo-dird-wazo-backend-key.yml", - "version": "0.1", - }, - "confd": { - "host": "localhost", - "port": 9486, - "prefix": None, - "https": False, - "version": "1.1", - }, - "format_columns": { - "phone": "{exten}", - "name": "{firstname} {lastname}", - "reverse": "{firstname} {lastname}", - }, - "searched_columns": ["firstname", "lastname", "exten"], - "first_matched_columns": ["exten", "mobile_phone_number"], -} -``` - -Ignoring the wazo backend specific options(`"auth"`, `"confd"`), we can see the default values for -the generic options: - -```json -... -"format_columns": { - "phone": "{exten}", - "name": "{firstname} {lastname}", - "reverse": "{firstname} {lastname}", -}, -... -``` - -This makes available the `exten` attribute of a wazo source contact as the `phone` field, combines -the `firstname` and `lastname` attributes of the contact into a `name` composite attribute, and -specifies the `reverse` special attribute in order to display the same composite of `firstname` and -`lastname` for the result of a reverse lookup match. - -```json -... -"searched_columns": ["firstname", "lastname", "exten"], -... -``` - -This ensures lookups on the wazo internal source will look at the `firstname`, `lastname` and -`exten` attributes in order to match the user's search term. - -```json -... -"first_matched_columns": ["exten", "mobile_phone_number"], -... -``` - -This ensures a reverse lookup will consider the `exten` and `mobile_phone_number` wazo contact -attributes in order to match an incoming call to an entry in this directory source. - -### Adding a source to a profile - -Once a new source configuration is created, the new source must be added to a "profile" in order for -a wazo end-user to have access to it. - -The `/directories/{profile}/sources` expose the sources made available to a user through a given -`profile`(see the -[API reference](/documentation/api/contact.html#tag/directories/paths/~1directories~1%7Bprofile%7D~1sources/get)). - -In practice, a single profile of name `default` will be shared amongst all users of a tenant, and -sources made available to users of a tenant will be exposed through that `default` -profile(`/directories/default/sources`). - -To add the source to the `default` profile, one must modify the profile configuration accordingly. -First acquire the uuid of the `default` profile of the tenant with `GET /0.1/profiles`(see -[API reference](/documentation/api/contact.html#tag/configuration/operation/list_profile)). - -Then query the current configuration of the profile with `GET /0.1/profiles/{profile uuid}`(see -[API reference](/documentation/api/contact.html#tag/configuration/operation/get_profile)). The -configuration of a profile looks like the following: - -```json -{ - "uuid": "026dc75a-6699-471c-8b55-0bdc28990a17", - "tenant_uuid": "54eb71f8-1f4b-4ae4-8730-638062fbe521", - "name": "default", - "display": { - "uuid": "1ed80c58-7f00-4e79-bc47-c0a564494d77" - }, - "services": { - "favorites": { - "sources": [ - ... - ], - "options": { - } - }, - "lookup": { - "sources": [ - ... - ], - "options": { - } - }, - "reverse": { - "sources": [ - ... - ], - "options": { - } - } - } -} -``` - -Notice the three sections under `"services"` refering to the three optional functionalities each -source may support, `"favorites"`, `"lookup"`, `"reverse"`. For a source that supports all three -functionalities, the new configuration would see the `uuid` of that source added to the `sources` -attribute of those three sections, e.g.: - -``` -{ - "uuid": "026dc75a-6699-471c-8b55-0bdc28990a17", - "tenant_uuid": "54eb71f8-1f4b-4ae4-8730-638062fbe521", - "name": "default", - "display": { - "uuid": "1ed80c58-7f00-4e79-bc47-c0a564494d77" - }, - "services": { - "favorites": { - "sources": [ - ... - { - "uuid": "000747d0-5b57-4380-a6b1-f64f9609adb1" - } - ], - "options": { - } - }, - "lookup": { - "sources": [ - ... - { - "uuid": "000747d0-5b57-4380-a6b1-f64f9609adb1" - } - ], - "options": { - } - }, - "reverse": { - "sources": [ - ... - { - "uuid": "000747d0-5b57-4380-a6b1-f64f9609adb1" - } - ], - "options": { - } - } - } -} -``` - -With that new configuration accounting for the new source, we can update the profile using -`PUT /0.1/profiles/{profile uuid}`(see -[API reference](/documentation/api/contact.html#tag/configuration/operation/update_profile)). - -The newly configured source should now be available to end-users. - -## Reverse lookups - -The wazo directory subsystem enables better caller number identification through _reverse lookups_ -in the configured directory sources. This means that an incoming call which is missing relevant -caller identification information will try to match the caller number to an entry in one of the -directory sources available to the user being called. - -For example, if the calling party is a family member of the user, which the user has registered into -their personal directory, and the calling party operator is not providing a relevant caller name in -the caller id information, then a reverse lookup will automatically be triggered, which should -result in the user's personal contact entry being matched by correspondance with the calling party's -number, and the name configured by the user in their personal entry for that contact will be used as -the display name for the caller. - -Note that this reverse lookup mechanism does not occur on all calls, but only when the wazo system -sees the incoming caller id as missing a relevant caller name. How this determination is made is -subject to change, but is guided by seeking a balance between providing relevant information to wazo -users, and avoiding wasteful load on system resources from unnecessary and potentially -computationally expensive operations. - -Reverse lookups are handled automatically internally by the wazo platform, through the wazo-dird API -endpoint `/directories/reverse//`(where `` will generally be `default` -and `` will be the uuid of the user receiving the call). - -As mentionned above, two of the general source configuration options are relevant to enable reverse -lookups on a directory source: - -- **first_matched_columns** must include all the source contact attributes which may identify a - phone number which the contact might use to call a wazo user(for example, separate attributes - specifying the numbers for an office phone line, a home fixed line and a mobile phone); -- - **format_columns** must include a `reverse` member attribute which specifies a format string which - will be used to provide a value for the display name of a matched contact entry(for example, - allowing to combine `firstname` and `lastname` attributes from the source contact entry into a - composite name). - -If the `reverse` attribute remains unspecified in the `format_columns` of a source, the reverse -lookup may succeed in matching a contact, but the match will not be used to provide relevant caller -identification for the incoming call, since the information on how to express that identification -information is missing. if the `first_matched_columns` is missing an attribute which may specify a -phone number by which the contact might be calling the wazo user, a reverse lookup may fail to match -the incoming call to the proper contact entry in that source. - -[caller id normalisation](/uc-doc/installation/postinstall#callerid-num-normalization) is also part -of the formula to successfully benefit from reverse lookups. - -Through a configuration file made available at `/etc/xivo/asterisk/xivo_in_callerid.conf`, one can -specify rules by which incoming call numbers will be matched and transformed into a format that fits -how contact phone numbers are expressed in the directories. - -Without proper configuration at this level, an incoming call from a known contact of a user might -fail to match the corresponding entry from the user's directories simply because the phone number of -the incoming call is not expressed in the same format as the one registered in the contact directory -entry. - -For example, for a wazo deployment located in France and serving french users, an incoming call -might expose the caller number using the international format, e.g. "+33911223344". However a french -user might intuitively want to register this contact using the conventional national format "09 11 -22 33 44". To handle this discrepancy, an `in_callerid` normalisation rule might transform all -incoming call numbers matching the international french number pattern(`(+33)\d{9}`) into the -conventional national format by stripping the international prefix(`+33`) and adding a `0` prefix. - -Note that this currently allows a single normalised form of a class of phone numbers to be used to -register contact numbers in all directories of a wazo stack. - -See also [Caller ID](/uc-doc/administration/callerid) for more information relative to caller id -handling in the wazo platform. diff --git a/website/uc-doc/administration/contact_directories/index.md b/website/uc-doc/administration/contact_directories/index.md index cdcb7797..acc1370d 100644 --- a/website/uc-doc/administration/contact_directories/index.md +++ b/website/uc-doc/administration/contact_directories/index.md @@ -2,5 +2,342 @@ title: Contact Directories --- -- [General](/uc-doc/administration/contact_directories/general) -- [Configuring a phonebook directory source](/uc-doc/administration/contact_directories/phonebook) +Wazo platform provides extensive and extensible support for managing sources of contact information. +This support involves both internal implementations of contact directories that wazo-platform users +can automatically benefit from, as well as integrations with common external contact directories +that can serve as sources of information on how to reach people and services both internal and +external to the wazo system. + +Given proper configuration within the wazo integration, those integrated directory sources can +provide functionalities such as + +- automatic [reverse lookups](#reverse-lookups) on incoming call numbers +- global search across all configured directories available to a user +- allowing users to use wazo to call registered contact using number available from contact source +- allowing users to keep a list of favorite contacts across all directory sources, which are made + available for quick access by an appropriate wazo client + +## Glossary + +- **directory source**: an internal (part of the wazo stack) or external(third-party software + deployed separately from the wazo platform) provider of contact information, which can be made + available to wazo users through the wazo-dird component of the wazo platform; alias **directory + backend**, shorterned form **source** or **backend** +- **contact**: a record of an entity(individual person, organization, service, object) that users + which to account for in their directories, and which are usually addressable and reachable through + different methods of communication, including telephony and email. Alias **contact entry**. +- **directory profile**: a configuration object specifying which directory sources are made + available to a tenant's users, and which functionalities are supported by that source +- **contact attribute**: a named piece of information associated to a contact entry in a directory + source, such as _name_, _telephoneNumber_, _mobileNumber_, _emailAddress_, etc. Alias **source + attribute**. +- **caller id**: caller identification information, includes a "caller name" and a "caller number", + often represented in the format `"Caller Name" `, can be carried in an incoming + call by the calling party and can be overriden/completed by the wazo system using directory + information(see [**reverse lookup**](#reverse-lookups) section). Alias **caller identification + information**. See also [Caller ID](/uc-doc/administration/callerid). + +## Configuring a new directory source + +### General configuration steps + +Different directory source backends require specific configurations and might require additional +preliminary steps, such as deploying third-party(non-wazo) software, which will not be documented +here. + +Given any backend-specific preliminary steps performed, the general steps necessary to setup a +directory source and make it available to wazo users can be summarized: + +1. Make sure any necessary plugin for the directory backend is enabled in the wazo-dird + configuration; +2. Use the source backend API of the backend plugin to create a source entity containing all + relevant configuration for that backend; +3. Update the directory profile of the tenant to include the newly created source, with the relevant + configuration specifying the supported functionalities of that source for that profile + +Following these steps, a wazo user of that tenant should be able to use the newly configured source +for its supported functionalities(depending on the configurations at step 2 and 3). + +### Plugins configuration + +All directory backend plugins already included with wazo platform are enabled by default, but +plugins for custom directory backends will require explicit configuration. + +See [wazo-dird configuration](/uc-doc/system/wazo-dird/configuration) for details on wazo-dird +configuration. + +### Creating a source configuration + +To configure a new source, a source configuration resource is created using the appropriate +backend-specific endpoint of the REST API. All backends expose a similar API for manipulating source +configurations, through an endpoint of the form `/backends/{backend type}/sources`. An HTTP `POST` +request on that endpoint with the proper json configuration would thus create the source. + +See the +[wazo-dird API reference for configuration endpoints](/documentation/api/contact.html#tag/configuration) +for examples and details of each backend endpoint. + +### Common configuration options + +All directory source backends require some common configuration options. The desirable values for +those options might depend on the specifics of a backend to be configured. As such some tweakings +specific to each wazo platform deployment may be required. + +- **name**: a name given to that directory source, for purpose of administration. Should be unique + within a tenant; +- **first_match_columns**: the contact attributes in the directory source that should be used to + match a search term to a single contact, as for reverse lookups. This usually will include all + source attributes that may contain a phone number the contact might use to call in a wazo user(see + [**reverse lookup**](#reverse-lookups)); +- **searched_columns**: a list of contact attributes which should be considered when searching all + contacts matching a given search term. This usually should include any attributes relevant to the + wazo users and by which the user may attempt to retrieve a contact entry, such as attributes + referring to a contact's name(including name components) as well as attributes referring to a + contact's reachable addresses(email, phone numbers); +- **format_columns**: a mapping between contact attributes that should be made available to a wazo + user, and formatting strings that can refer to the contact attributes available in the directory + source. This option allows the administrator to transform the contact information available in the + directory source into a more convenient format to present to the wazo system users. This option is + also used to affect the result of reverse lookups(see [reverse lookup](#reverse-lookups)). + +As a represensative example, the default configuration for the internal wazo directory source looks +like such: + +```json +{ + "auth": { + "host": "localhost", + "port": 9497, + "prefix": None, + "https": False, + "key_file": "/var/lib/wazo-auth-keys/wazo-dird-wazo-backend-key.yml", + "version": "0.1", + }, + "confd": { + "host": "localhost", + "port": 9486, + "prefix": None, + "https": False, + "version": "1.1", + }, + "format_columns": { + "phone": "{exten}", + "name": "{firstname} {lastname}", + "reverse": "{firstname} {lastname}", + }, + "searched_columns": ["firstname", "lastname", "exten"], + "first_matched_columns": ["exten", "mobile_phone_number"], +} +``` + +Ignoring the wazo backend specific options(`"auth"`, `"confd"`), we can see the default values for +the generic options: + +```json +... +"format_columns": { + "phone": "{exten}", + "name": "{firstname} {lastname}", + "reverse": "{firstname} {lastname}", +}, +... +``` + +This makes available the `exten` attribute of a wazo source contact as the `phone` field, combines +the `firstname` and `lastname` attributes of the contact into a `name` composite attribute, and +specifies the `reverse` special attribute in order to display the same composite of `firstname` and +`lastname` for the result of a reverse lookup match. + +```json +... +"searched_columns": ["firstname", "lastname", "exten"], +... +``` + +This ensures lookups on the wazo internal source will look at the `firstname`, `lastname` and +`exten` attributes in order to match the user's search term. + +```json +... +"first_matched_columns": ["exten", "mobile_phone_number"], +... +``` + +This ensures a reverse lookup will consider the `exten` and `mobile_phone_number` wazo contact +attributes in order to match an incoming call to an entry in this directory source. + +### Adding a source to a profile + +Once a new source configuration is created, the new source must be added to a "profile" in order for +a wazo end-user to have access to it. + +The `/directories/{profile}/sources` expose the sources made available to a user through a given +`profile`(see the +[API reference](/documentation/api/contact.html#tag/directories/paths/~1directories~1%7Bprofile%7D~1sources/get)). + +In practice, a single profile of name `default` will be shared amongst all users of a tenant, and +sources made available to users of a tenant will be exposed through that `default` +profile(`/directories/default/sources`). + +To add the source to the `default` profile, one must modify the profile configuration accordingly. +First acquire the uuid of the `default` profile of the tenant with `GET /0.1/profiles`(see +[API reference](/documentation/api/contact.html#tag/configuration/operation/list_profile)). + +Then query the current configuration of the profile with `GET /0.1/profiles/{profile uuid}`(see +[API reference](/documentation/api/contact.html#tag/configuration/operation/get_profile)). The +configuration of a profile looks like the following: + +```json +{ + "uuid": "026dc75a-6699-471c-8b55-0bdc28990a17", + "tenant_uuid": "54eb71f8-1f4b-4ae4-8730-638062fbe521", + "name": "default", + "display": { + "uuid": "1ed80c58-7f00-4e79-bc47-c0a564494d77" + }, + "services": { + "favorites": { + "sources": [ + ... + ], + "options": { + } + }, + "lookup": { + "sources": [ + ... + ], + "options": { + } + }, + "reverse": { + "sources": [ + ... + ], + "options": { + } + } + } +} +``` + +Notice the three sections under `"services"` refering to the three optional functionalities each +source may support, `"favorites"`, `"lookup"`, `"reverse"`. For a source that supports all three +functionalities, the new configuration would see the `uuid` of that source added to the `sources` +attribute of those three sections, e.g.: + +``` +{ + "uuid": "026dc75a-6699-471c-8b55-0bdc28990a17", + "tenant_uuid": "54eb71f8-1f4b-4ae4-8730-638062fbe521", + "name": "default", + "display": { + "uuid": "1ed80c58-7f00-4e79-bc47-c0a564494d77" + }, + "services": { + "favorites": { + "sources": [ + ... + { + "uuid": "000747d0-5b57-4380-a6b1-f64f9609adb1" + } + ], + "options": { + } + }, + "lookup": { + "sources": [ + ... + { + "uuid": "000747d0-5b57-4380-a6b1-f64f9609adb1" + } + ], + "options": { + } + }, + "reverse": { + "sources": [ + ... + { + "uuid": "000747d0-5b57-4380-a6b1-f64f9609adb1" + } + ], + "options": { + } + } + } +} +``` + +With that new configuration accounting for the new source, we can update the profile using +`PUT /0.1/profiles/{profile uuid}`(see +[API reference](/documentation/api/contact.html#tag/configuration/operation/update_profile)). + +The newly configured source should now be available to end-users. + +## Reverse lookups + +The wazo directory subsystem enables better caller number identification through _reverse lookups_ +in the configured directory sources. This means that an incoming call which is missing relevant +caller identification information will try to match the caller number to an entry in one of the +directory sources available to the user being called. + +For example, if the calling party is a family member of the user, which the user has registered into +their personal directory, and the calling party operator is not providing a relevant caller name in +the caller id information, then a reverse lookup will automatically be triggered, which should +result in the user's personal contact entry being matched by correspondance with the calling party's +number, and the name configured by the user in their personal entry for that contact will be used as +the display name for the caller. + +Note that this reverse lookup mechanism does not occur on all calls, but only when the wazo system +sees the incoming caller id as missing a relevant caller name. How this determination is made is +subject to change, but is guided by seeking a balance between providing relevant information to wazo +users, and avoiding wasteful load on system resources from unnecessary and potentially +computationally expensive operations. + +Reverse lookups are handled automatically internally by the wazo platform, through the wazo-dird API +endpoint `/directories/reverse//`(where `` will generally be `default` +and `` will be the uuid of the user receiving the call). + +As mentionned above, two of the general source configuration options are relevant to enable reverse +lookups on a directory source: + +- **first_matched_columns** must include all the source contact attributes which may identify a + phone number which the contact might use to call a wazo user(for example, separate attributes + specifying the numbers for an office phone line, a home fixed line and a mobile phone); -- + **format_columns** must include a `reverse` member attribute which specifies a format string which + will be used to provide a value for the display name of a matched contact entry(for example, + allowing to combine `firstname` and `lastname` attributes from the source contact entry into a + composite name). + +If the `reverse` attribute remains unspecified in the `format_columns` of a source, the reverse +lookup may succeed in matching a contact, but the match will not be used to provide relevant caller +identification for the incoming call, since the information on how to express that identification +information is missing. if the `first_matched_columns` is missing an attribute which may specify a +phone number by which the contact might be calling the wazo user, a reverse lookup may fail to match +the incoming call to the proper contact entry in that source. + +[caller id normalisation](/uc-doc/installation/postinstall#callerid-num-normalization) is also part +of the formula to successfully benefit from reverse lookups. + +Through a configuration file made available at `/etc/xivo/asterisk/xivo_in_callerid.conf`, one can +specify rules by which incoming call numbers will be matched and transformed into a format that fits +how contact phone numbers are expressed in the directories. + +Without proper configuration at this level, an incoming call from a known contact of a user might +fail to match the corresponding entry from the user's directories simply because the phone number of +the incoming call is not expressed in the same format as the one registered in the contact directory +entry. + +For example, for a wazo deployment located in France and serving french users, an incoming call +might expose the caller number using the international format, e.g. "+33911223344". However a french +user might intuitively want to register this contact using the conventional national format "09 11 +22 33 44". To handle this discrepancy, an `in_callerid` normalisation rule might transform all +incoming call numbers matching the international french number pattern(`(+33)\d{9}`) into the +conventional national format by stripping the international prefix(`+33`) and adding a `0` prefix. + +Note that this currently allows a single normalised form of a class of phone numbers to be used to +register contact numbers in all directories of a wazo stack. + +See also [Caller ID](/uc-doc/administration/callerid) for more information relative to caller id +handling in the wazo platform. diff --git a/website/uc-doc/administration/interconnections/index.md b/website/uc-doc/administration/interconnections/index.md index e8ed84a1..9a214e53 100644 --- a/website/uc-doc/administration/interconnections/index.md +++ b/website/uc-doc/administration/interconnections/index.md @@ -2,6 +2,188 @@ title: Interconnections --- -- [Introduction](/uc-doc/administration/interconnections/introduction) -- [two_wazo](/uc-doc/administration/interconnections/two_wazo) -- [wazo_with_voip_provider](/uc-doc/administration/interconnections/wazo_with_voip_provider) +## Create an interconnection + +There are three types of interconnections : + +- SIP +- IAX +- Customized + +### SIP interconnections + +SIP interconnections are used to connect to a SIP provider or to another PBX that is part of your +telecom infrastructure. + +Global SIP configurations are available with at the following endpoints: + +- `/api/confd/1.1/asterisk/pjsip/global` +- `/api/confd/1.1/asterisk/pjsip/system` + +Endpoint and trunk configurations are available with at the following endpoints: + +- `/api/confd/1.1/endpoints/sip`: For the SIP configuration of the trunk +- `/api/confd/1.1/endpoints/sip/templates`: The `global` template can be used for global settings + shared between all SIP endpoints +- `/api/confd/1.1/trunks`: SIP specific trunk configuration + +The [API documentation](/documentation/api/configuration.html) can be used for more details on the +configuration. + +#### Environment with NAT + +There are some configuration steps that are required when connecting to a SIP provider from a NAT +environment. + +##### Configuring your transport + +The transport needs to be configured with the local network and it's external address and port. This +can be done using the `/api/confd/1.1/sip/transports` API. + +```json +{ + "name": "transport-udp", + "options": [ + ..., + ["local_net", "192.168.0.0/16"], + ["local_net", "10.1.1.0/24"], + ["external_media_port", ""] + ] +}, +``` + +- `external_signaling_address`: This is your public IP address +- `external_media_address`: This is your public IP address +- `local_net`: Your internal network range + +Note that modifying a transport requires an Asterisk restart to be applied + +##### Configuring your Endpoints + +Some options should be set on your endpoints for them to work in a NAT environment. The `global` SIP +template can be used to apply settings to all SIP endpoints. + +- `PUT /api/confd/1.1/endpoints/sip/templates/` + + ```json + { + "uuid": "", + "label": "global", + ..., + "endpoint_section_options": [ + ..., + ["rtp_symmetric", "yes"], + ["rewrite_contact", "yes"] + ], + ... + } + ``` + +#### SIP Headers + +##### Outgoing calls + +There are some use cases where you need to set specific SIP headers on all outgoing calls done using +a trunk. + +Adding a SIP header can be done using dialplan with the `PJSIP_HEADER(add,MY-HEADER)=value` or it +can be done in the endpoint configuration using a `set_var`. + +Using the endpoint configuration endpoint `/endpoints/sip` + +```json +{ + "uuid": "", + ..., + "endpoint_section_options": [ + ..., + ["set_var", "PJSIP_HEADER(add,
)=
"] + ], + ... +} +``` + +##### Incoming calls + +Sometimes it is necessary to match incoming SIP INVITE against a specific header to route the call +to the appropriate SIP endpoint. + +This is useful in a multi tenant situation where multiple tenants share the same provider. + +If your provider sends the `X-Dest-User: abc123` header when you receive a call you should add a +match on the trunk SIP endpoint to get those calls routed to this endpoint. + +```json +{ + "uuid": "", + ..., + "endpoint_section_options": [ + ..., + ["identify_by", "header,auth_username,username"], + ], + "identify_section_options": [ + ..., + ["match_header", "X-Dest-User: abc123"] + ], + ... +} +``` + +### Customized interconnections + +Customized interconnections are mainly used for interconnections using Local channels: + +- `name`: it is the name which will appear in the outcall interconnections list, +- `interface`: this is the channel name +- `interface_suffix`: a suffix added after the dialed number (in fact the Dial command will dial: + + ```ascii + / + ``` + +- `Context` : currently not relevant + +## Debug + +Interesting Asterisk commands: : + +```asterisk-cli +sip show peers +sip show registry +sip set debug on +``` + +## Caller ID + +When setting up an interconnection with the public network or another PBX, it is possible to set a +caller ID in different places. Each way to configure a caller ID has it's own use case. + +The format for a caller ID is the following `"My Name" <9999>` If you don't set the number part of +the caller ID, the dialplan's number will be used instead. This might not be a good option in most +cases. + +## Outgoing call caller ID + +When you create an outgoing call, it's possible to set the `internal_caller_id`. When this option is +activated, the caller's caller ID will be forwarded to the trunk. This option is use full when the +other side of the trunk can reach the user with it's caller ID number. + +When the caller's caller ID is not usable to the called party, the outgoing call's caller id can be +fixed to a given value that is more use full to the outside world. Giving the public number here +might be a good idea. + +`PUT /outcalls/{outcall_id}/extensions/{extension_id} {"caller_id": ""XIVO" <555>"}` + +A user can also have a forced caller ID for outgoing calls. This can be use full for someone who has +his own public number. This option can be set by user. The `outgoing_caller_id` option must be set +to the caller ID. The user can also set his `outgoing_caller_id` to `anonymous`. + +`PUT /users/{user_uuid} {"outgoing_caller_id": ""Bob" <555>"}` + +The order of precedence when setting the caller ID in multiple place is the following. + +1. `internal_caller_id` +2. User's `outgoing_caller_id` +3. Outgoing call +4. Default caller ID diff --git a/website/uc-doc/administration/interconnections/introduction.md b/website/uc-doc/administration/interconnections/introduction.md deleted file mode 100644 index 13c5a9f7..00000000 --- a/website/uc-doc/administration/interconnections/introduction.md +++ /dev/null @@ -1,189 +0,0 @@ ---- -title: Introduction ---- - -## Create an interconnection - -There are three types of interconnections : - -- SIP -- IAX -- Customized - -### SIP interconnections - -SIP interconnections are used to connect to a SIP provider or to another PBX that is part of your -telecom infrastructure. - -Global SIP configurations are available with at the following endpoints: - -- `/api/confd/1.1/asterisk/pjsip/global` -- `/api/confd/1.1/asterisk/pjsip/system` - -Endpoint and trunk configurations are available with at the following endpoints: - -- `/api/confd/1.1/endpoints/sip`: For the SIP configuration of the trunk -- `/api/confd/1.1/endpoints/sip/templates`: The `global` template can be used for global settings - shared between all SIP endpoints -- `/api/confd/1.1/trunks`: SIP specific trunk configuration - -The [API documentation](/documentation/api/configuration.html) can be used for more details on the -configuration. - -#### Environment with NAT - -There are some configuration steps that are required when connecting to a SIP provider from a NAT -environment. - -##### Configuring your transport - -The transport needs to be configured with the local network and it's external address and port. This -can be done using the `/api/confd/1.1/sip/transports` API. - -```json -{ - "name": "transport-udp", - "options": [ - ..., - ["local_net", "192.168.0.0/16"], - ["local_net", "10.1.1.0/24"], - ["external_media_port", ""] - ] -}, -``` - -- `external_signaling_address`: This is your public IP address -- `external_media_address`: This is your public IP address -- `local_net`: Your internal network range - -Note that modifying a transport requires an Asterisk restart to be applied - -##### Configuring your Endpoints - -Some options should be set on your endpoints for them to work in a NAT environment. The `global` SIP -template can be used to apply settings to all SIP endpoints. - -- `PUT /api/confd/1.1/endpoints/sip/templates/` - - ```json - { - "uuid": "", - "label": "global", - ..., - "endpoint_section_options": [ - ..., - ["rtp_symmetric", "yes"], - ["rewrite_contact", "yes"] - ], - ... - } - ``` - -#### SIP Headers - -##### Outgoing calls - -There are some use cases where you need to set specific SIP headers on all outgoing calls done using -a trunk. - -Adding a SIP header can be done using dialplan with the `PJSIP_HEADER(add,MY-HEADER)=value` or it -can be done in the endpoint configuration using a `set_var`. - -Using the endpoint configuration endpoint `/endpoints/sip` - -```json -{ - "uuid": "", - ..., - "endpoint_section_options": [ - ..., - ["set_var", "PJSIP_HEADER(add,
)=
"] - ], - ... -} -``` - -##### Incoming calls - -Sometimes it is necessary to match incoming SIP INVITE against a specific header to route the call -to the appropriate SIP endpoint. - -This is useful in a multi tenant situation where multiple tenants share the same provider. - -If your provider sends the `X-Dest-User: abc123` header when you receive a call you should add a -match on the trunk SIP endpoint to get those calls routed to this endpoint. - -```json -{ - "uuid": "", - ..., - "endpoint_section_options": [ - ..., - ["identify_by", "header,auth_username,username"], - ], - "identify_section_options": [ - ..., - ["match_header", "X-Dest-User: abc123"] - ], - ... -} -``` - -### Customized interconnections - -Customized interconnections are mainly used for interconnections using Local channels: - -- `name`: it is the name which will appear in the outcall interconnections list, -- `interface`: this is the channel name -- `interface_suffix`: a suffix added after the dialed number (in fact the Dial command will dial: - - ```ascii - / - ``` - -- `Context` : currently not relevant - -## Debug - -Interesting Asterisk commands: : - -```asterisk-cli -sip show peers -sip show registry -sip set debug on -``` - -## Caller ID - -When setting up an interconnection with the public network or another PBX, it is possible to set a -caller ID in different places. Each way to configure a caller ID has it's own use case. - -The format for a caller ID is the following `"My Name" <9999>` If you don't set the number part of -the caller ID, the dialplan's number will be used instead. This might not be a good option in most -cases. - -## Outgoing call caller ID - -When you create an outgoing call, it's possible to set the `internal_caller_id`. When this option is -activated, the caller's caller ID will be forwarded to the trunk. This option is use full when the -other side of the trunk can reach the user with it's caller ID number. - -When the caller's caller ID is not usable to the called party, the outgoing call's caller id can be -fixed to a given value that is more use full to the outside world. Giving the public number here -might be a good idea. - -`PUT /outcalls/{outcall_id}/extensions/{extension_id} {"caller_id": ""XIVO" <555>"}` - -A user can also have a forced caller ID for outgoing calls. This can be use full for someone who has -his own public number. This option can be set by user. The `outgoing_caller_id` option must be set -to the caller ID. The user can also set his `outgoing_caller_id` to `anonymous`. - -`PUT /users/{user_uuid} {"outgoing_caller_id": ""Bob" <555>"}` - -The order of precedence when setting the caller ID in multiple place is the following. - -1. `internal_caller_id` -2. User's `outgoing_caller_id` -3. Outgoing call -4. Default caller ID diff --git a/website/uc-doc/administration/provisioning/index.md b/website/uc-doc/administration/provisioning/index.md index e390a803..00da2b20 100644 --- a/website/uc-doc/administration/provisioning/index.md +++ b/website/uc-doc/administration/provisioning/index.md @@ -2,9 +2,50 @@ title: Provisioning --- -- [Introduction](/uc-doc/administration/provisioning/introduction) -- [Basic Configuration](/uc-doc/administration/provisioning/basic_configuration) -- [Advanced Configuration](/uc-doc/administration/provisioning/adv_configuration) -- [Directory](/uc-doc/administration/provisioning/directory) -- [HTTP Authentication Strategy](/uc-doc/administration/provisioning/http-auth-strategy) -- [Jitsi](/uc-doc/administration/provisioning/jitsi) +Wazo supports the auto-provisioning of a large number of telephony +[devices](/uc-doc/ecosystem/supported_devices), including SIP phones, SIP ATAs, and even softphones. + +The auto-provisioning feature found in Wazo make it possible to provision, i.e. configure, a lots of +telephony devices in an efficient and effortless way. + +## How it works + +Here's a simplified view of how auto-provisioning is supported on a typical SIP desktop phone: + +1. The phone is powered on +2. During its boot process, the phone sends a DHCP request to obtain its network configuration +3. A DHCP server replies with the phone network configuration + an HTTP URL +4. The phone use the provided URL to retrieve a common configuration file, a MAC-specific + configuration file, a firmware image and some language files. + +Building on this, configuring one of the supported phone on Wazo is as simple as: + +1. [dhcpd-config](/uc-doc/administration/provisioning/basic_configuration) +2. [Installing the required provd plugin](/uc-doc/administration/provisioning/adv_configuration) +3. Powering on the phone +4. Dialing the user's provisioning code from the phone + +And _voila_, once the phone has rebooted, your user is ready to make and receive calls. No manual +editing of configuration files nor fiddling in the phone's web interface. + +## Tenant assignation + +On initial insertion into provd, devices are assigned to the tenant of the token used internally by +provd, which is the master tenant. When a device is provisioned, it is transferred to the tenant of +the line to which it is being associated. When the device is reset to autoprov, the device stays in +its tenant. It is not possible to change the tenant of the device once it is set. If you wish to do +it anyway, you must delete the device and restart it manually. + +## Limitations + +- Device synchronisation does not work in the situation where multiple devices are connected from + behind a NAPT network equipment. The devices must be resynchronised manually. +- There may be an issue if you are using an analog gateway with lines that are not in the same + tenant. Indeed, in the case that the gateway is only one device and each port is a separate line, + the device will only be seen by the tenant of the first line that was added. + +## External links + +- [Introduction to provd plugin model](/uc-doc/contributors/provisioning/introduction-to-the-plugin-model-of-the-new-provisioning-server) +- [HTTP/TFTP requests processing in provd - part 1](/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-1) +- [HTTP/TFTP requests processing in provd - part 2](/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-2) diff --git a/website/uc-doc/administration/provisioning/introduction.md b/website/uc-doc/administration/provisioning/introduction.md deleted file mode 100644 index a181b0f5..00000000 --- a/website/uc-doc/administration/provisioning/introduction.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: Introduction ---- - -Wazo supports the auto-provisioning of a large number of telephony -[devices](/uc-doc/ecosystem/supported_devices), including SIP phones, SIP ATAs, and even softphones. - -The auto-provisioning feature found in Wazo make it possible to provision, i.e. configure, a lots of -telephony devices in an efficient and effortless way. - -## How it works - -Here's a simplified view of how auto-provisioning is supported on a typical SIP desktop phone: - -1. The phone is powered on -2. During its boot process, the phone sends a DHCP request to obtain its network configuration -3. A DHCP server replies with the phone network configuration + an HTTP URL -4. The phone use the provided URL to retrieve a common configuration file, a MAC-specific - configuration file, a firmware image and some language files. - -Building on this, configuring one of the supported phone on Wazo is as simple as: - -1. [dhcpd-config](/uc-doc/administration/provisioning/basic_configuration) -2. [Installing the required provd plugin](/uc-doc/administration/provisioning/adv_configuration) -3. Powering on the phone -4. Dialing the user's provisioning code from the phone - -And _voila_, once the phone has rebooted, your user is ready to make and receive calls. No manual -editing of configuration files nor fiddling in the phone's web interface. - -## Tenant assignation - -On initial insertion into provd, devices are assigned to the tenant of the token used internally by -provd, which is the master tenant. When a device is provisioned, it is transferred to the tenant of -the line to which it is being associated. When the device is reset to autoprov, the device stays in -its tenant. It is not possible to change the tenant of the device once it is set. If you wish to do -it anyway, you must delete the device and restart it manually. - -## Limitations - -- Device synchronisation does not work in the situation where multiple devices are connected from - behind a NAPT network equipment. The devices must be resynchronised manually. -- There may be an issue if you are using an analog gateway with lines that are not in the same - tenant. Indeed, in the case that the gateway is only one device and each port is a separate line, - the device will only be seen by the tenant of the first line that was added. - -## External links - -- [Introduction to provd plugin model](/uc-doc/contributors/provisioning/introduction-to-the-plugin-model-of-the-new-provisioning-server) -- [HTTP/TFTP requests processing in provd - part 1](/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-1) -- [HTTP/TFTP requests processing in provd - part 2](/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-2) diff --git a/website/uc-doc/administration/users/index.md b/website/uc-doc/administration/users/index.md index 6f2b96b8..567526d8 100644 --- a/website/uc-doc/administration/users/index.md +++ b/website/uc-doc/administration/users/index.md @@ -2,5 +2,54 @@ title: Users --- -- [Users Configuration](/uc-doc/administration/users/users) -- [CSV Import and Export](/uc-doc/administration/users/csv_import) +- [csv_import](/uc-doc/administration/users/csv_import) +- [User Management](/uc-doc/api_sdk/rest_api/confd/user_management) + +## Function keys + +Function keys can be configured to customize the user's phone keys. The `blf` field allows the key +to be supervised. A supervised key will light up when enabled. In most cases, a user cannot add +multiple times exactly the same function key (example : two user function keys pointing to the same +user). Adding the same function key multiple times can lead to undefined behavior and generally will +delete one of the two function keys. + +**Warning**: SCCP device only supports type "Customized". + +If the forward function key is used with no destination the user will be prompted when the user +presses the function key and the BLF will monitor _ALL_ forward for this user. + +## Extensions + +### `*3` (online call recording) + +To enable online call recording, you must set `automixmon`: + +`PUT /asterisk/features/featuremap {"options": {"automixmon": "*3", ...}}` + +When this option is activated, the user can press `*3` during a conversation to start/stop online +call recording. The recorded file will be available in the `/var/spool/asterisk/monitor` directory. + +### `*26` (call recording) + +You can enable/disable the recording of all calls for a user in 2 different way: + +1. By set `call_record_*_enabled: true` for user: + + ```ascii + PUT /users/{user_uuid} + { + "call_record_outgoing_internal_enabled": true, + "call_record_outgoing_external_enabled": true, + "call_record_incoming_internal_enabled": true, + "call_record_incoming_external_enabled": true + } + ``` + +2. By using the extension `*26` from your phone (the feature `callrecord` option must be enabled): + + `PUT /extensions/features/{extension_id}` + + **Note**: Using `*26` will toggle the four `call_record_*_enabled` options simultaneously + +When this option is activated, all calls made to or made by the user will be recorded in the +`/var/lib/wazo/sounds/tenants//monitor` directory. diff --git a/website/uc-doc/administration/users/users.md b/website/uc-doc/administration/users/users.md deleted file mode 100644 index e362eec7..00000000 --- a/website/uc-doc/administration/users/users.md +++ /dev/null @@ -1,55 +0,0 @@ ---- -title: Configuration ---- - -- [csv_import](/uc-doc/administration/users/csv_import) -- [User Management](/uc-doc/api_sdk/rest_api/confd/user_management) - -## Function keys - -Function keys can be configured to customize the user's phone keys. The `blf` field allows the key -to be supervised. A supervised key will light up when enabled. In most cases, a user cannot add -multiple times exactly the same function key (example : two user function keys pointing to the same -user). Adding the same function key multiple times can lead to undefined behavior and generally will -delete one of the two function keys. - -**Warning**: SCCP device only supports type "Customized". - -If the forward function key is used with no destination the user will be prompted when the user -presses the function key and the BLF will monitor _ALL_ forward for this user. - -## Extensions - -### `*3` (online call recording) - -To enable online call recording, you must set `automixmon`: - -`PUT /asterisk/features/featuremap {"options": {"automixmon": "*3", ...}}` - -When this option is activated, the user can press `*3` during a conversation to start/stop online -call recording. The recorded file will be available in the `/var/spool/asterisk/monitor` directory. - -### `*26` (call recording) - -You can enable/disable the recording of all calls for a user in 2 different way: - -1. By set `call_record_*_enabled: true` for user: - - ```ascii - PUT /users/{user_uuid} - { - "call_record_outgoing_internal_enabled": true, - "call_record_outgoing_external_enabled": true, - "call_record_incoming_internal_enabled": true, - "call_record_incoming_external_enabled": true - } - ``` - -2. By using the extension `*26` from your phone (the feature `callrecord` option must be enabled): - - `PUT /extensions/features/{extension_id}` - - **Note**: Using `*26` will toggle the four `call_record_*_enabled` options simultaneously - -When this option is activated, all calls made to or made by the user will be recorded in the -`/var/lib/wazo/sounds/tenants//monitor` directory. diff --git a/website/uc-doc/api_sdk/mobile/index.md b/website/uc-doc/api_sdk/mobile/index.md deleted file mode 100644 index ec2c9dfe..00000000 --- a/website/uc-doc/api_sdk/mobile/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: 'Mobile' ---- - -- [push notifications](/uc-doc/api_sdk/mobile/push_notification) diff --git a/website/uc-doc/api_sdk/mobile/push_notification.md b/website/uc-doc/api_sdk/mobile_push_notification.md similarity index 93% rename from website/uc-doc/api_sdk/mobile/push_notification.md rename to website/uc-doc/api_sdk/mobile_push_notification.md index b9e96c27..0c7fcdc8 100644 --- a/website/uc-doc/api_sdk/mobile/push_notification.md +++ b/website/uc-doc/api_sdk/mobile_push_notification.md @@ -1,5 +1,5 @@ --- -title: 'Push Notifications' +title: 'Mobile Push Notifications' --- - [Configuring push notifications](#configuring-push-notifications) @@ -29,24 +29,24 @@ API v1, deprecating support for legacy APIs. The configuration procedure is as follow: -1. **create a Firebase project and enable Firebase Cloud Messaging API support** +1. **create a Firebase project and enable Firebase Cloud Messaging API support** To support relaying notifications to Android mobile users through FCM service, one must first have an active Firebase project account with Firebase Cloud Messaging support enabled for that - FCM project. + FCM project. See [Official Firebase documentation](https://firebase.google.com/docs/web/setup/#create-project) for more information. -2. **create a service account in the Firebase project** +2. **create a service account in the Firebase project** With a Firebase project account and FCM API enabled, a service account must be created in the - project; That service account will be used by Wazo to authenticate to Firebase APIs. + project; That service account will be used by Wazo to authenticate to Firebase APIs. See [Google Cloud service account documentation](https://cloud.google.com/iam/docs/service-accounts-create?hl=en) for more information; 3. **download the service account JSON credentials file** A JSON file containing the service account - credentials can be downloaded from the Firebase console; + credentials can be downloaded from the Firebase console; See [Firebase documentation](https://firebase.google.com/docs/admin/setup#initialize_the_sdk_in_non-google_environments). 4. **create or update the external mobile config in wazo-auth, providing the content of the - downloaded service account credentials** + downloaded service account credentials** Using the wazo-auth REST API, the endpoint `/0.1/external/mobile/config` is used to manage the configuration for mobile push notifications support; - `POST` on that endpoint will create a fresh configuration if none exist, and `PUT` will allow @@ -54,7 +54,7 @@ The configuration procedure is as follow: - the `fcm_service_account_info` field must be filled with the content of the downloaded JSON file from step 3 (as a JSON string); - the `fcm_sender_id` is also required and should be the FCM project number assigned to the - project, as shown in the Firebase console; + project, as shown in the Firebase console; see the [API reference](/documentation/api/authentication.html#tag/external/paths/~1external~1%7Bauth_type%7D~1config/post) for more details on that endpoint. @@ -62,31 +62,31 @@ The configuration procedure is as follow: ### Configuring APNS support To support push notifications to iOS devices, the requirements and procedure are similar to FCM -support. An Apple developer account is required. +support. An Apple developer account is required. This account is used to register an Apple app (the mobile client), which support push -notifications. +notifications. A certificate is generated for that app, and is provided to the Wazo Platform stack for authentication to APNS when delivering the push notifications. -1. **Enroll in the Apple developer program** +1. **Enroll in the Apple developer program** To provide push notifications to a mobile client on an iOS device, an Apple developer account is required See [Apple documentation](https://developer.apple.com/support/app-account/#organization); -2. **Register an app** +2. **Register an app** An app corresponding to the iOS mobile client should be registered -3. **Enable push notification support for the app** +3. **Enable push notification support for the app** Push notifications through APNS must be enabled for the registered app; See [Apple documentation](https://developer.apple.com/documentation/usernotifications/registering-your-app-with-apns); -4. **Generate certificates for the app** +4. **Generate certificates for the app** A VoIP services certificate tied to the registered Apple app must be generated to secure the - connection between the Wazo Platform stack and the APNS servers; + connection between the Wazo Platform stack and the APNS servers; See [Apple documentation on this subject](https://developer.apple.com/documentation/usernotifications/establishing-a-certificate-based-connection-to-apns); See also [more Apple documentation on creating a certificate for your Apple app](https://developer.apple.com/help/account/create-certificates/create-voip-services-certificates) -5. **Create or update the external mobile config in wazo-auth, providing the certificate content** +5. **Create or update the external mobile config in wazo-auth, providing the certificate content** An external credential configuration of type `mobile` must be created in the Wazo Platform stack, - through which the previously generated certificate can be provided. + through which the previously generated certificate can be provided. In the **wazo-auth** REST API, the endpoint `/0.1/external/mobile/config` is used to manage the configuration for mobile push notifications support; - `POST` on that endpoint will create a fresh configuration if none exist, and `PUT` will allow @@ -94,7 +94,7 @@ authentication to APNS when delivering the push notifications. - the `ios_apn_certificate` field must be filled with the content of the public part of the certificate created in step 4; - the `ios_apn_private` field must be filled with the certificate signing request created in step - 4; + 4; see the [API reference](/documentation/api/authentication.html#tag/external/paths/~1external~1%7Bauth_type%7D~1config/post) for more details on that endpoint. diff --git a/website/uc-doc/contact_center/index.md b/website/uc-doc/contact_center/index.md index fb014f00..8adabfc3 100644 --- a/website/uc-doc/contact_center/index.md +++ b/website/uc-doc/contact_center/index.md @@ -2,6 +2,28 @@ title: Contact Center --- +In Wazo, the contact center is implemented to fulfill the following objectives. + +## Call routing + +Includes basic call distribution using call queues and skills-based routing + +## Agent and Supervisor workstation + +Provides the ability to execute contact center actions such as: agent login, agent logout and to +receive real time statistics regarding contact center status + +## Statistics reporting + +Provides contact center management reporting on contact center activities + +## Advanced functionalities + +- Call recording +- Screen Pop-up + +--- + - [Agents](/uc-doc/contact_center/agents) - [Queues](/uc-doc/contact_center/queues) - [Skill Based Routing](/uc-doc/contact_center/skillbasedrouting) diff --git a/website/uc-doc/contact_center/introduction.md b/website/uc-doc/contact_center/introduction.md deleted file mode 100644 index 84f31ea1..00000000 --- a/website/uc-doc/contact_center/introduction.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: Introduction ---- - -In Wazo, the contact center is implemented to fulfill the following objectives. - -## Call routing - -Includes basic call distribution using call queues and skills-based routing - -## Agent and Supervisor workstation - -Provides the ability to execute contact center actions such as: agent login, agent logout and to -receive real time statistics regarding contact center status - -## Statistics reporting - -Provides contact center management reporting on contact center activities - -## Advanced functionalities - -- Call recording -- Screen Pop-up diff --git a/website/uc-doc/ecosystem/index.md b/website/uc-doc/ecosystem/index.md index 3d5256d8..2d7f331e 100644 --- a/website/uc-doc/ecosystem/index.md +++ b/website/uc-doc/ecosystem/index.md @@ -2,4 +2,5 @@ title: Ecosystem --- -- [Supported Devices](/uc-doc/ecosystem/supported_devices) + +- [Supported Devices](https://wazo-platform.org/uc-doc/ecosystem/supported_devices) diff --git a/website/uc-doc/high_availability/index.md b/website/uc-doc/high_availability/index.md index add802c3..b33418c6 100644 --- a/website/uc-doc/high_availability/index.md +++ b/website/uc-doc/high_availability/index.md @@ -2,4 +2,206 @@ title: 'High Availability (HA)' --- -- [Introduction](/uc-doc/high_availability/introduction) +The `HA (High Availability)` solution in Wazo makes it possible to maintain basic telephony function +whether your main Wazo server is running or not. When running a Wazo HA cluster, users are +guaranteed to never experience a downtime of more than 5 minutes of their basic telephony service. + +The HA solution in Wazo is based on a 2-nodes "master and slave" architecture. In the normal +situation, both the master and slave nodes are running in parallel, the slave acting as a "hot +standby", and all the telephony services are provided by the master node. If the master fails or +must be shutdown for maintenance, then the telephony devices automatically communicate with the +slave node instead of the master one. Once the master is up again, the telephony devices failback to +the master node. Both the failover and the failback operation are done automatically, i.e. without +any user intervention, although an administrator might want to run some manual operations after +failback as to, for example, make sure any voicemail messages that were left on the slave are copied +back to the master. + +## Prerequisites + +The HA in Wazo only works with telephony devices (i.e. phones) that support the notion of a primary +and backup telephony server. + +- Phones must be able to reach the master and the slave (take special care if master and slave are + not in the same subnet) +- If firewalling, the master must be allowed to join the slave on ports 22 and 5432 +- If firewalling, the slave must be allowed to join the master with an ICMP ping +- Trunk registration timeout (`expiry`) should be less than 300 seconds (5 minutes) +- The slave must have no provisioning plugins installed. + +The HA solution is guaranteed to work correctly with +[the following devices](/uc-doc/administration/security#devices). + +## Quick Summary + +- You need two configured Wazo (wizard passed) +- Configure one Wazo as a master -> setup the slave address (VoIP interface) +- Restart services (wazo-service restart) on master +- Configure the other Wazo as a slave -> setup the master address (VoIP interface) +- Configure file synchronization by running the script `wazo-sync -i` on the master +- Start configuration synchronization by running the script + `xivo-master-slave-db-replication ` on the master +- Resynchronize all your devices + +That's it, you now have a HA configuration, and every hour all the configuration done on the master +will be reported to the slave. + +## Configuration Details + +First thing to do is to [install 2 Wazo](/uc-doc/installation). + +**Note**: When you upgrade a node of your cluster, you must also upgrade the other so that they both +are running the same version of Wazo. Otherwise, the replication might not work properly. + +You must configure the `HA (High Availability)` with `PUT /ha` + +You can configure the master and slave in whatever order you want. + +You must also run `wazo-sync -i` on the master to setup file synchronization. Running `wazo-sync -i` +will create a passwordless SSH key on the master, stored under the `/root/.ssh` directory, and will +add it to the `/root/.ssh/authorized_keys` file on the slave. The following directories will then be +rsync'ed every hour: + +- /etc/asterisk/extensions_extra.d +- /etc/xivo/asterisk +- /var/lib/asterisk/agi-bin +- /var/lib/asterisk/moh +- /var/lib/wazo/sounds/tenants + +**Warning**: When the HA is configured, some changes will be automatically made to the configuration +of Wazo. + +SIP expiry value on master and slave will be automatically updated: + +- `GET /asterisk/sip/general` + - `minexpiry`: 3 minutes + - `maxexpiry`: 5 minutes + - `defaultexpiry`: 4 minutes + +The provisioning server configuration will be automatically updated in order to allow phones to +switch from Wazo power failure. + +- `GET /provd/cfg_mgr/configs?q={"X_type": "registrar"}` + + `registrar_backup: , proxy_backup: ` + +**Warning**: Do not change these values when the HA is configured, as this may cause problems. These +values will be reset to blank when the HA is disabled. + +**Note**: For the telephony devices to take the new proxy/registrar settings into account, you must +resynchronize the devices or restart them manually. + +### Master node + +In choosing the `node_type: master` you must enter the `remote_address` **of the VoIP interface** of +the slave node. + +After the master node is configured, you need to apply some changes: + +1. On the master node: + +```shell +wazo-service restart +xivo-master-slave-db-replication +``` + +2. On the slave node: + +```shell +wazo-service restart +``` + +### Slave node + +In choosing the `node_type: slave` you must enter the `remote_address` **of the VoIP interface** of +the master node. + +### Replication Configuration + +Once master slave configuration is completed, Wazo configuration is replicated from the master node +to the slave every hour (:00). + +Replication can be started manually by running the replication scripts on the master: + +```shell +xivo-master-slave-db-replication \ +wazo-sync +``` + +The replication does not copy the full Wazo configuration of the master. Notably, these are +excluded: + +- All the network configuration +- All the support configuration +- Call logs +- Call center statistics +- Certificates +- HA settings +- Provisioning configuration +- Voicemail messages + +Less importantly, these are also excluded: + +- Queue logs +- CELs + +## Internals + +4 scripts are used to manage services and data replication. + +- `xivo-master-slave-db-replication ` is used on the master to replicate the master's data + on the slave server. It runs on the master. +- `xivo-manage-slave-services {start,stop}` is used on the slave to start, stop monit and asterisk. + The services won't be restarted after an upgrade or restart. +- `xivo-check-master-status ` is used to check the status of the master and enable or + disable services accordingly. +- `wazo-sync` is used to sync directories from master to slave. + +Additionally, 3 files are created and automatically managed to reflect the state of the HA +configuration: + +- `/etc/xivo/ha.conf`: contains the json configuration corresponding to the current state of the + node when HA is enabled +- `/var/lib/wazo/is-primary`: a sentinel file whose existence reflects the status of the node as a + primary("master") wazo stack +- `/var/lib/wazo/is-secondary`: a sentinel file whose existence reflects the status of the node as a + secondary("slave") wazo stack + +Those files are created, updated and removed automatically by the wazo services and should not be +changed by the administrators, at the risk of putting the system in an inconsistent state with +unexpected and undesirable results. + +## Limitations + +When the master node is down, some features are not available and some behave a bit differently. +This includes: + +- Call history / call records are not recorded. +- Voicemail messages saved on the master node are not available. +- Custom voicemail greetings recorded on the master node are not available. +- Phone provisioning is disabled, i.e. a phone will always keep the same configuration, even after + restarting it. +- Phone remote directory is not accessible, because provisioned IP address points to the master. + +Note that, on failover and on failback: + +- DND, call forwards, call filtering, ..., statuses may be lost if changed recently. +- If you are connected as an agent, then you might need to reconnect as an agent when the master + goes down. + +Additionally, only on failback: + +- Voicemail messages are not copied from the slave to the master, i.e. if someone left a message on + your voicemail when the master was down, you won't be able to consult it once the master is up + again. +- More generally, custom sounds are not copied back. This includes recordings. + +Here's the list of limitations that are more relevant on an administrator standpoint: + +- The master status is up or down, there's no middle status. This mean that if Asterisk is crashed + the Wazo is still up and the failover will NOT happen. + +## Troubleshooting {#troubleshooting} + +When replicating the database between master and slave, if you encounter problems related to the +system locale, see `postgresql_localization_errors` + diff --git a/website/uc-doc/high_availability/introduction.md b/website/uc-doc/high_availability/introduction.md deleted file mode 100644 index c3f42443..00000000 --- a/website/uc-doc/high_availability/introduction.md +++ /dev/null @@ -1,206 +0,0 @@ ---- -title: 'Introduction' ---- - -The `HA (High Availability)` solution in Wazo makes it possible to maintain basic telephony function -whether your main Wazo server is running or not. When running a Wazo HA cluster, users are -guaranteed to never experience a downtime of more than 5 minutes of their basic telephony service. - -The HA solution in Wazo is based on a 2-nodes "master and slave" architecture. In the normal -situation, both the master and slave nodes are running in parallel, the slave acting as a "hot -standby", and all the telephony services are provided by the master node. If the master fails or -must be shutdown for maintenance, then the telephony devices automatically communicate with the -slave node instead of the master one. Once the master is up again, the telephony devices failback to -the master node. Both the failover and the failback operation are done automatically, i.e. without -any user intervention, although an administrator might want to run some manual operations after -failback as to, for example, make sure any voicemail messages that were left on the slave are copied -back to the master. - -## Prerequisites - -The HA in Wazo only works with telephony devices (i.e. phones) that support the notion of a primary -and backup telephony server. - -- Phones must be able to reach the master and the slave (take special care if master and slave are - not in the same subnet) -- If firewalling, the master must be allowed to join the slave on ports 22 and 5432 -- If firewalling, the slave must be allowed to join the master with an ICMP ping -- Trunk registration timeout (`expiry`) should be less than 300 seconds (5 minutes) -- The slave must have no provisioning plugins installed. - -The HA solution is guaranteed to work correctly with -[the following devices](/uc-doc/administration/security#devices). - -## Quick Summary - -- You need two configured Wazo (wizard passed) -- Configure one Wazo as a master -> setup the slave address (VoIP interface) -- Restart services (wazo-service restart) on master -- Configure the other Wazo as a slave -> setup the master address (VoIP interface) -- Configure file synchronization by running the script `wazo-sync -i` on the master -- Start configuration synchronization by running the script - `xivo-master-slave-db-replication ` on the master -- Resynchronize all your devices - -That's it, you now have a HA configuration, and every hour all the configuration done on the master -will be reported to the slave. - -## Configuration Details - -First thing to do is to [install 2 Wazo](/uc-doc/installation). - -**Note**: When you upgrade a node of your cluster, you must also upgrade the other so that they both -are running the same version of Wazo. Otherwise, the replication might not work properly. - -You must configure the `HA (High Availability)` with `PUT /ha` - -You can configure the master and slave in whatever order you want. - -You must also run `wazo-sync -i` on the master to setup file synchronization. Running `wazo-sync -i` -will create a passwordless SSH key on the master, stored under the `/root/.ssh` directory, and will -add it to the `/root/.ssh/authorized_keys` file on the slave. The following directories will then be -rsync'ed every hour: - -- /etc/asterisk/extensions_extra.d -- /etc/xivo/asterisk -- /var/lib/asterisk/agi-bin -- /var/lib/asterisk/moh -- /var/lib/wazo/sounds/tenants - -**Warning**: When the HA is configured, some changes will be automatically made to the configuration -of Wazo. - -SIP expiry value on master and slave will be automatically updated: - -- `GET /asterisk/sip/general` - - `minexpiry`: 3 minutes - - `maxexpiry`: 5 minutes - - `defaultexpiry`: 4 minutes - -The provisioning server configuration will be automatically updated in order to allow phones to -switch from Wazo power failure. - -- `GET /provd/cfg_mgr/configs?q={"X_type": "registrar"}` - - `registrar_backup: , proxy_backup: ` - -**Warning**: Do not change these values when the HA is configured, as this may cause problems. These -values will be reset to blank when the HA is disabled. - -**Note**: For the telephony devices to take the new proxy/registrar settings into account, you must -resynchronize the devices or restart them manually. - -### Master node - -In choosing the `node_type: master` you must enter the `remote_address` **of the VoIP interface** of -the slave node. - -After the master node is configured, you need to apply some changes: - -1. On the master node: - -```shell -wazo-service restart -xivo-master-slave-db-replication -``` - -2. On the slave node: - -```shell -wazo-service restart -``` - -### Slave node - -In choosing the `node_type: slave` you must enter the `remote_address` **of the VoIP interface** of -the master node. - -### Replication Configuration - -Once master slave configuration is completed, Wazo configuration is replicated from the master node -to the slave every hour (:00). - -Replication can be started manually by running the replication scripts on the master: - -```shell -xivo-master-slave-db-replication \ -wazo-sync -``` - -The replication does not copy the full Wazo configuration of the master. Notably, these are -excluded: - -- All the network configuration -- All the support configuration -- Call logs -- Call center statistics -- Certificates -- HA settings -- Provisioning configuration -- Voicemail messages - -Less importantly, these are also excluded: - -- Queue logs -- CELs - -## Internals - -4 scripts are used to manage services and data replication. - -- xivo-master-slave-db-replication \ is used on the master to replicate the master's data - on the slave server. It runs on the master. -- xivo-manage-slave-services {start,stop} is used on the slave to start, stop monit and asterisk. - The services won't be restarted after an upgrade or restart. -- xivo-check-master-status \ is used to check the status of the master and enable or - disable services accordingly. -- wazo-sync is used to sync directories from master to slave. - -Additionally, 3 files are created and automatically managed to reflect the state of the HA -configuration: - -- `/etc/xivo/ha.conf`: contains the json configuration corresponding to the current state of the - node when HA is enabled -- `/var/lib/wazo/is-primary`: a sentinel file whose existence reflects the status of the node as a - primary("master") wazo stack -- `/var/lib/wazo/is-secondary`: a sentinel file whose existence reflects the status of the node as a - secondary("slave") wazo stack - -Those files are created, updated and removed automatically by the wazo services and should not be -changed by the administrators, at the risk of putting the system in an inconsistent state with -unexpected and undesirable results. - -## Limitations - -When the master node is down, some features are not available and some behave a bit differently. -This includes: - -- Call history / call records are not recorded. -- Voicemail messages saved on the master node are not available. -- Custom voicemail greetings recorded on the master node are not available. -- Phone provisioning is disabled, i.e. a phone will always keep the same configuration, even after - restarting it. -- Phone remote directory is not accessible, because provisioned IP address points to the master. - -Note that, on failover and on failback: - -- DND, call forwards, call filtering, ..., statuses may be lost if changed recently. -- If you are connected as an agent, then you might need to reconnect as an agent when the master - goes down. - -Additionally, only on failback: - -- Voicemail messages are not copied from the slave to the master, i.e. if someone left a message on - your voicemail when the master was down, you won't be able to consult it once the master is up - again. -- More generally, custom sounds are not copied back. This includes recordings. - -Here's the list of limitations that are more relevant on an administrator standpoint: - -- The master status is up or down, there's no middle status. This mean that if Asterisk is crashed - the Wazo is still up and the failover will NOT happen. - -## Troubleshooting {#troubleshooting} - -When replicating the database between master and slave, if you encounter problems related to the -system locale, see `postgresql_localization_errors` diff --git a/website/uc-doc/installation/index.md b/website/uc-doc/installation/index.md index 39833c5d..5869ec84 100644 --- a/website/uc-doc/installation/index.md +++ b/website/uc-doc/installation/index.md @@ -2,5 +2,141 @@ title: Installation --- -- [Install System](/uc-doc/installation/install-system) -- [Post install](/uc-doc/installation/postinstall) +## Requirements + +### Trying it out + +Here are the system minimum requirements if you just want to try out a Wazo Platform instance: + +- CPU: 1 CPU is enough for a test server +- Memory: 2 GiB of memory is a tight minimum for a test server +- Storage: 8 GiB is comfortable for a test server, except if you plan to use large firmware files + for physical phones. + +### Production + +Here are the expected resources for a small production installation of around 50 users: + +- 2 CPU minimum +- 4 GiB RAM minimum +- 50 GiB storage minimum + +## Procedure + +To install the Unified Communication use case in an all-in-one setup, do the following steps: + +1. Install a Debian 11 Bullseye system with a default locale with an UTF-8 charset. +2. Run the following commands as root on the Debian system to provision sudo, git and Ansible: + + ```shell + apt update + apt install -yq sudo git ansible curl + ``` + + **Note:** Ansible is a suite of software tools that enables infrastructure as code. It is + open-source and the suite includes software provisioning, configuration management, and + application deployment functionality. https://en.wikipedia.org/wiki/Ansible_(software) + +3. Extract the Wazo Platform installer + + ```shell + git clone https://github.com/wazo-platform/wazo-ansible.git + cd wazo-ansible + ``` + +4. (optional) By default, Wazo Platform will install the development version. To install the latest + stable version + + ```shell + ansible_tag=wazo-$(curl https://mirror.wazo.community/version/stable) + git checkout $ansible_tag + ``` + +5. Install the Wazo Platform installer dependency + + ```shell + ansible-galaxy install -r requirements-postgresql.yml + ``` + +6. Edit the file `inventories/uc-engine` to add your preferences and passwords. The various + variables that can be customized are described [here](https://github.com/wazo-platform/wazo-ansible/blob/master/README.md#variables). + + By default, Wazo Platform will install the development version. To install the latest stable + version, activate the following settings in `inventories/uc-engine`: + + ```ini + [uc_engine:vars] + wazo_distribution = pelican-bullseye + wazo_distribution_upgrade = pelican-bullseye + ``` + + If you want to install the web user interface, activate the following in your + `inventories/uc-engine`: + + ```ini + [uc_ui:children] + uc_engine_host + ``` + + The following variables allow you to create the `root` account at installation time, to be able + to use the web user interface and an API user to be able to use the REST APIs: + + ```ini + [uc_engine:vars] + engine_api_configure_wizard = true + engine_api_root_password = + api_client_name = + api_client_password = + ``` + + Note: this API user will only have permissions for configuration REST API (wazo-confd). + +7. Launch the installation by running the following command: + + ```shell + ansible-playbook -i inventories/uc-engine uc-engine.yml + ``` + +8. Once the installation completed, execute the following command to verify that all the Wazo + services (wazo-plugind, wazo-webhookd, ...) are up and running: + ```shell + wazo-service status + ``` + +## Use the REST API + +You may now use the REST API from outside your system (here `wazo.example.com`). + +1. Get an authentication token for 1 hour: + + Execute from the Debian system: + + ```shell + wazo-auth-cli token create --auth-user --auth-password + ``` + + Or with `curl` from anywhere: + + ```shell + curl -k -X POST -u : -H 'Content-Type: application/json' -d '{"expiration": 3600}' https://wazo.example.com/api/auth/0.1/token + ``` + +2. Use any REST API you want. + + Note: You must replace `` with the authentication token + + To obtain the version of Wazo: + + ```shell + curl -k -X GET -H 'X-Auth-Token: ' -H 'Content-Type: application/json' https://wazo.example.com/api/confd/1.1/infos + ``` + + To list the telephony users configured on the system: + + ```shell + curl -k -X GET -H 'X-Auth-Token: ' -H 'Content-Type: application/json' https://wazo.example.com/api/confd/1.1/users + ``` + +## Optional post-install steps + +You may now follow the [optional post-install steps](/uc-doc/installation/postinstall). diff --git a/website/uc-doc/installation/install-system.md b/website/uc-doc/installation/install-system.md deleted file mode 100644 index 8a503939..00000000 --- a/website/uc-doc/installation/install-system.md +++ /dev/null @@ -1,142 +0,0 @@ ---- -title: Installing the System ---- - -## Requirements - -### Trying it out - -Here are the system minimum requirements if you just want to try out a Wazo Platform instance: - -- CPU: 1 CPU is enough for a test server -- Memory: 2 GiB of memory is a tight minimum for a test server -- Storage: 8 GiB is comfortable for a test server, except if you plan to use large firmware files - for physical phones. - -### Production - -Here are the expected resources for a small production installation of around 50 users: - -- 2 CPU minimum -- 4 GiB RAM minimum -- 50 GiB storage minimum - -## Procedure - -To install the Unified Communication use case in an all-in-one setup, do the following steps: - -1. Install a Debian 11 Bullseye system with a default locale with an UTF-8 charset. -2. Run the following commands as root on the Debian system to provision sudo, git and Ansible: - - ```shell - apt update - apt install -yq sudo git ansible curl - ``` - - **Note:** Ansible is a suite of software tools that enables infrastructure as code. It is - open-source and the suite includes software provisioning, configuration management, and - application deployment functionality. https://en.wikipedia.org/wiki/Ansible_(software) - -3. Extract the Wazo Platform installer - - ```shell - git clone https://github.com/wazo-platform/wazo-ansible.git - cd wazo-ansible - ``` - -4. (optional) By default, Wazo Platform will install the development version. To install the latest - stable version - - ```shell - ansible_tag=wazo-$(curl https://mirror.wazo.community/version/stable) - git checkout $ansible_tag - ``` - -5. Install the Wazo Platform installer dependency - - ```shell - ansible-galaxy install -r requirements-postgresql.yml - ``` - -6. Edit the file `inventories/uc-engine` to add your preferences and passwords. The various - variables that can be customized are described [here](https://github.com/wazo-platform/wazo-ansible/blob/master/README.md#variables). - - By default, Wazo Platform will install the development version. To install the latest stable - version, activate the following settings in `inventories/uc-engine`: - - ```ini - [uc_engine:vars] - wazo_distribution = pelican-bullseye - wazo_distribution_upgrade = pelican-bullseye - ``` - - If you want to install the web user interface, activate the following in your - `inventories/uc-engine`: - - ```ini - [uc_ui:children] - uc_engine_host - ``` - - The following variables allow you to create the `root` account at installation time, to be able - to use the web user interface and an API user to be able to use the REST APIs: - - ```ini - [uc_engine:vars] - engine_api_configure_wizard = true - engine_api_root_password = - api_client_name = - api_client_password = - ``` - - Note: this API user will only have permissions for configuration REST API (wazo-confd). - -7. Launch the installation by running the following command: - - ```shell - ansible-playbook -i inventories/uc-engine uc-engine.yml - ``` - -8. Once the installation completed, execute the following command to verify that all the Wazo - services (wazo-plugind, wazo-webhookd, ...) are up and running: - ```shell - wazo-service status - ``` - -## Use the REST API - -You may now use the REST API from outside your system (here `wazo.example.com`). - -1. Get an authentication token for 1 hour: - - Execute from the Debian system: - - ```shell - wazo-auth-cli token create --auth-user --auth-password - ``` - - Or with `curl` from anywhere: - - ```shell - curl -k -X POST -u : -H 'Content-Type: application/json' -d '{"expiration": 3600}' https://wazo.example.com/api/auth/0.1/token - ``` - -2. Use any REST API you want. - - Note: You must replace `` with the authentication token - - To obtain the version of Wazo: - - ```shell - curl -k -X GET -H 'X-Auth-Token: ' -H 'Content-Type: application/json' https://wazo.example.com/api/confd/1.1/infos - ``` - - To list the telephony users configured on the system: - - ```shell - curl -k -X GET -H 'X-Auth-Token: ' -H 'Content-Type: application/json' https://wazo.example.com/api/confd/1.1/users - ``` - -## Optional post-install steps - -You may now follow the [optional post-install steps](/uc-doc/installation/postinstall). diff --git a/website/uc-doc/upgrade/index.md b/website/uc-doc/upgrade/index.md index 54a9c0dc..6febb3cc 100644 --- a/website/uc-doc/upgrade/index.md +++ b/website/uc-doc/upgrade/index.md @@ -1,3 +1,147 @@ --- title: Upgrading --- + +Upgrading a Wazo is done by executing commands through a terminal on the server. You can connect to +the server either through SSH or with a physical console. + +To upgrade your Wazo to the latest version, you **must** use the `wazo-upgrade` script. You can +start an upgrade with the command: + +```shell +wazo-upgrade +``` + +**Warning**: **You can't use wazo-upgrade if you have not run the wizard yet. Upgrading from a +[deprecated version](/uc-doc/upgrade/version_deprecation_policy) is not supported.** + +This script will update Wazo and restart all services. + +There are 2 options you can pass to wazo-upgrade: + +- `-d` to only download packages without installing them. **This will still upgrade the package + containing wazo-upgrade**. +- `-f` to force upgrade, without asking for user confirmation + +`wazo-upgrade` uses the following environment variables: + +- `WAZO_CONFD_PORT` to set the port used to query the + [HTTP API of wazo-confd](/uc-doc/api_sdk/rest_api/confd) (default is `9486`) + +## Upgrade procedure + +- Read all existing [upgrade notes](/uc-doc/upgrade/upgrade_notes) starting from your version to the + latest version. +- For custom setups, follow the required procedures described below (e.g. HA cluster). +- To download the packages beforehand, run `wazo-upgrade -d`. This is not mandatory, but it does not + require stopping any service, so it may be useful to reduce the downtime of the server while + upgrading. +- When ready, run `wazo-upgrade` which will start the upgrade process. **Telephony services will be + stopped during the process** +- When finished, check that all services are running (the list is displayed at the end of the + upgrade). +- Check that services are correctly working like SIP registration, ISDN link status, + internal/incoming/outgoing calls, Wazo Client connections etc. + +## Version-specific upgrade procedures {#version-specific-upgrade} + +### Upgrading from Wazo 18.03 only + +When upgrading from Wazo 18.03, you should follow the specific procedure for +[Upgrading from Wazo 18.03](/uc-doc/upgrade/upgrade_from_wazo_18_03). + +## Upgrading a cluster {#upgrading-a-cluster} + +Here are the steps for upgrading a cluster, i.e. two Wazo with +[high availability](/uc-doc/high_availability/introduction): + +1. On the master : deactivate the database replication by commenting the cron in + `/etc/cron.d/xivo-ha-master` +2. On the slave, deactivate the xivo-check-master-status script cronjob by commenting the line in + `/etc/cron.d/xivo-ha-slave` +3. On the slave, start the upgrade: + + ```shell + wazo-slave:~$ wazo-upgrade + ``` + +4. When the slave has finished, start the upgrade on the master: + + ```shell + wazo-master:~$ wazo-upgrade + ``` + +5. When done, launch the database replication manually: + + ```shell + wazo-master:~$ xivo-master-slave-db-replication + ``` + +6. Reactivate the cronjobs (see steps 1 and 2) + +## Upgrading to a specific version of Wazo + +See our recommendation on +[how to upgrade to a specific version of Wazo](/uc-doc/upgrade/upgrade_specific_version/introduction) + +## Upgrading from i386 (32 bits) to amd64 (64 bits) + +- [Migrate from i386 to amd64](/uc-doc/upgrade/migrate_i386_to_amd64) + +## Unsupported versions + +- [Version Deprecation Policy](/uc-doc/upgrade/version_deprecation_policy) + +## Troubleshooting {#troubleshooting} + +### Invalid signature (before 22.01 only) + +You may encounter the following error: + +``` +The following signatures were invalid: EXPKEYSIG 3F1BF7FC527FBC6A Wazo Release Key +``` + +This error happens on all Wazo Platform servers installed before 21.01. See also: the +[issue ticket](https://wazo-dev.atlassian.net/browse/WAZO-2622). + +To fix the issue, run the following commands: + +``` +curl https://mirror.wazo.community/wazo_current.key | apt-key add - +curl https://mirror.wazo.community/wazo_current.key | apt-key --keyring /etc/apt/trusted.gpg.d/wazo-keyring.gpg add - +wazo-upgrade +``` + +### Postgresql + +When upgrading Wazo, if you encounter problems related to the system locale, see +`postgresql_localization_errors`. + +### wazo-upgrade + +If wazo-upgrade fails or aborts in mid-process, the system might end up in a faulty condition. If in +doubt, run the following command to check the current state of Wazo's firewall rules: + +```shell +iptables -nvL +``` + +If, among others, it displays something like the following line (notice the DROP and 5060): + +```shell +0 0 DROP udp -- * * 0.0.0.0/0 0.0.0.0/0 udp dpt:5060 +``` + +Then your Wazo will not be able to register any SIP phones. In this case, you must delete the DROP +rules with the following command: + +```shell +iptables -D INPUT -p udp --dport 5060 -j DROP +``` + +Repeat this command until no more unwanted rules are left. + +## Upgrade notes {#upgrade-notes} + +- [Upgrade Notes](/uc-doc/upgrade/upgrade_notes) diff --git a/website/uc-doc/upgrade/introduction.md b/website/uc-doc/upgrade/introduction.md deleted file mode 100644 index 3d390c97..00000000 --- a/website/uc-doc/upgrade/introduction.md +++ /dev/null @@ -1,147 +0,0 @@ ---- -title: Upgrading Procedure ---- - -Upgrading a Wazo is done by executing commands through a terminal on the server. You can connect to -the server either through SSH or with a physical console. - -To upgrade your Wazo to the latest version, you **must** use the `wazo-upgrade` script. You can -start an upgrade with the command: - -```shell -wazo-upgrade -``` - -**Warning**: **You can't use wazo-upgrade if you have not run the wizard yet. Upgrading from a -[deprecated version](/uc-doc/upgrade/version_deprecation_policy) is not supported.** - -This script will update Wazo and restart all services. - -There are 2 options you can pass to wazo-upgrade: - -- `-d` to only download packages without installing them. **This will still upgrade the package - containing wazo-upgrade**. -- `-f` to force upgrade, without asking for user confirmation - -`wazo-upgrade` uses the following environment variables: - -- `WAZO_CONFD_PORT` to set the port used to query the - [HTTP API of wazo-confd](/uc-doc/api_sdk/rest_api/confd) (default is `9486`) - -## Upgrade procedure - -- Read all existing [upgrade notes](/uc-doc/upgrade/upgrade_notes) starting from your version to the - latest version. -- For custom setups, follow the required procedures described below (e.g. HA cluster). -- To download the packages beforehand, run `wazo-upgrade -d`. This is not mandatory, but it does not - require stopping any service, so it may be useful to reduce the downtime of the server while - upgrading. -- When ready, run `wazo-upgrade` which will start the upgrade process. **Telephony services will be - stopped during the process** -- When finished, check that all services are running (the list is displayed at the end of the - upgrade). -- Check that services are correctly working like SIP registration, ISDN link status, - internal/incoming/outgoing calls, Wazo Client connections etc. - -## Version-specific upgrade procedures {#version-specific-upgrade} - -### Upgrading from Wazo 18.03 only - -When upgrading from Wazo 18.03, you should follow the specific procedure for -[Upgrading from Wazo 18.03](/uc-doc/upgrade/upgrade_from_wazo_18_03). - -## Upgrading a cluster {#upgrading-a-cluster} - -Here are the steps for upgrading a cluster, i.e. two Wazo with -[high availability](/uc-doc/high_availability/introduction): - -1. On the master : deactivate the database replication by commenting the cron in - `/etc/cron.d/xivo-ha-master` -2. On the slave, deactivate the xivo-check-master-status script cronjob by commenting the line in - `/etc/cron.d/xivo-ha-slave` -3. On the slave, start the upgrade: - - ```shell - wazo-slave:~$ wazo-upgrade - ``` - -4. When the slave has finished, start the upgrade on the master: - - ```shell - wazo-master:~$ wazo-upgrade - ``` - -5. When done, launch the database replication manually: - - ```shell - wazo-master:~$ xivo-master-slave-db-replication - ``` - -6. Reactivate the cronjobs (see steps 1 and 2) - -## Upgrading to a specific version of Wazo - -See our recommendation on -[how to upgrade to a specific version of Wazo](/uc-doc/upgrade/upgrade_specific_version/introduction) - -## Upgrading from i386 (32 bits) to amd64 (64 bits) - -- [Migrate from i386 to amd64](/uc-doc/upgrade/migrate_i386_to_amd64) - -## Unsupported versions - -- [Version Deprecation Policy](/uc-doc/upgrade/version_deprecation_policy) - -## Troubleshooting {#troubleshooting} - -### Invalid signature (before 22.01 only) - -You may encounter the following error: - -``` -The following signatures were invalid: EXPKEYSIG 3F1BF7FC527FBC6A Wazo Release Key -``` - -This error happens on all Wazo Platform servers installed before 21.01. See also: the -[issue ticket](https://wazo-dev.atlassian.net/browse/WAZO-2622). - -To fix the issue, run the following commands: - -``` -curl https://mirror.wazo.community/wazo_current.key | apt-key add - -curl https://mirror.wazo.community/wazo_current.key | apt-key --keyring /etc/apt/trusted.gpg.d/wazo-keyring.gpg add - -wazo-upgrade -``` - -### Postgresql - -When upgrading Wazo, if you encounter problems related to the system locale, see -`postgresql_localization_errors`. - -### wazo-upgrade - -If wazo-upgrade fails or aborts in mid-process, the system might end up in a faulty condition. If in -doubt, run the following command to check the current state of Wazo's firewall rules: - -```shell -iptables -nvL -``` - -If, among others, it displays something like the following line (notice the DROP and 5060): - -```shell -0 0 DROP udp -- * * 0.0.0.0/0 0.0.0.0/0 udp dpt:5060 -``` - -Then your Wazo will not be able to register any SIP phones. In this case, you must delete the DROP -rules with the following command: - -```shell -iptables -D INPUT -p udp --dport 5060 -j DROP -``` - -Repeat this command until no more unwanted rules are left. - -## Upgrade notes {#upgrade-notes} - -- [Upgrade Notes](/uc-doc/upgrade/upgrade_notes) diff --git a/website/yarn.lock b/website/yarn.lock index 26fb3e2a..ce3a03d7 100644 --- a/website/yarn.lock +++ b/website/yarn.lock @@ -1995,6 +1995,26 @@ __metadata: languageName: node linkType: hard +"@docusaurus/plugin-client-redirects@npm:^3.5.2": + version: 3.5.2 + resolution: "@docusaurus/plugin-client-redirects@npm:3.5.2" + dependencies: + "@docusaurus/core": "npm:3.5.2" + "@docusaurus/logger": "npm:3.5.2" + "@docusaurus/utils": "npm:3.5.2" + "@docusaurus/utils-common": "npm:3.5.2" + "@docusaurus/utils-validation": "npm:3.5.2" + eta: "npm:^2.2.0" + fs-extra: "npm:^11.1.1" + lodash: "npm:^4.17.21" + tslib: "npm:^2.6.0" + peerDependencies: + react: ^18.0.0 + react-dom: ^18.0.0 + checksum: 10c0/daf2b7468ea021ed3111f5aa7393cbf468c5c2111538b7ff57f56ef974200026fa23c413e1495c2d73926c32ed269c5d7c7e486b0594a8db28e0c7eba347c93d + languageName: node + linkType: hard + "@docusaurus/plugin-content-blog@npm:3.5.2": version: 3.5.2 resolution: "@docusaurus/plugin-content-blog@npm:3.5.2" @@ -12613,6 +12633,7 @@ __metadata: "@biomejs/biome": "npm:1.8.3" "@docusaurus/core": "npm:^3.5.2" "@docusaurus/module-type-aliases": "npm:^3.5.2" + "@docusaurus/plugin-client-redirects": "npm:^3.5.2" "@docusaurus/preset-classic": "npm:^3.5.2" "@docusaurus/theme-mermaid": "npm:^3.5.2" "@docusaurus/tsconfig": "npm:^3.5.2" From 92686c844efeadaf6b8211e4cbd589d817293ef4 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Fri, 25 Oct 2024 10:45:29 -0400 Subject: [PATCH 03/22] docs(uc-doc): remove in content table of content --- website/uc-doc/administration/ivr/index.md | 13 ------------- .../administration/provisioning/jitsi.md | 4 ---- website/uc-doc/administration/sound_files.md | 3 --- website/uc-doc/administration/users/index.md | 3 --- .../api_sdk/mobile_push_notification.md | 6 ------ .../api_sdk/rest_api/troubleshooting.md | 4 ---- website/uc-doc/api_sdk/websocket.md | 10 ---------- website/uc-doc/system/https_certificate.md | 5 ----- website/uc-doc/system/log_files.md | 19 ------------------- website/uc-doc/system/proxy.md | 6 ------ website/uc-doc/system/service.md | 2 -- .../uc-doc/system/wazo-dird/configuration.md | 4 ---- website/uc-doc/system/wazo-dird/developer.md | 10 ---------- website/uc-doc/system/wazo-sysconfd.md | 3 --- 14 files changed, 92 deletions(-) diff --git a/website/uc-doc/administration/ivr/index.md b/website/uc-doc/administration/ivr/index.md index 3e10e894..36e14ab2 100644 --- a/website/uc-doc/administration/ivr/index.md +++ b/website/uc-doc/administration/ivr/index.md @@ -2,19 +2,6 @@ title: Interactive Voice Response --- -- [Introduction](#introduction) -- [Use Case: Minimal IVR](#use-case-minimal-ivr) - - [Flowchart](#flowchart) - - [Configuration File and Dialplan](#configuration-file-and-dialplan) - - [IVR external dial](#ivr-external-dial) - - [IVR internal dial](#ivr-internal-dial) -- [Use Case: IVR with a schedule](#use-case-ivr-with-a-schedule) - - [Flowchart](#flowchart-1) - - [Create Schedule](#create-schedule) -- [Use Case: IVR with submenu](#use-case-ivr-with-submenu) - - [Flowchart](#flowchart-2) - - [Configuration File and Dialplan](#configuration-file-and-dialplan-1) - ## Introduction > _Interactive voice response (IVR) is a technology that allows a computer to interact with humans diff --git a/website/uc-doc/administration/provisioning/jitsi.md b/website/uc-doc/administration/provisioning/jitsi.md index 3d249390..0877f56d 100644 --- a/website/uc-doc/administration/provisioning/jitsi.md +++ b/website/uc-doc/administration/provisioning/jitsi.md @@ -2,10 +2,6 @@ title: Jitsi --- -- [Requirements](#requirements) -- [Add Jitsi plugin on Wazo](#add-jitsi-plugin-on-wazo) -- [Configuring Jitsi](#configuring-jitsi) - [Jitsi](https://jitsi.org/) is an opensource softphone (previously SIP Communicator). Wazo now support Jitsi sofphones provisioning. Here are the steps to follow: diff --git a/website/uc-doc/administration/sound_files.md b/website/uc-doc/administration/sound_files.md index 673abb96..a6c24638 100644 --- a/website/uc-doc/administration/sound_files.md +++ b/website/uc-doc/administration/sound_files.md @@ -2,9 +2,6 @@ title: Sound Files --- -- [Add Sounds Files](#add-sounds-files) -- [Convert Your Wav File](#wav-files) - ## Add Sounds Files On a fresh install, only `en_US` and `fr_FR` sounds are installed. Canadian French and German are diff --git a/website/uc-doc/administration/users/index.md b/website/uc-doc/administration/users/index.md index 567526d8..3ad4f33b 100644 --- a/website/uc-doc/administration/users/index.md +++ b/website/uc-doc/administration/users/index.md @@ -2,9 +2,6 @@ title: Users --- -- [csv_import](/uc-doc/administration/users/csv_import) -- [User Management](/uc-doc/api_sdk/rest_api/confd/user_management) - ## Function keys Function keys can be configured to customize the user's phone keys. The `blf` field allows the key diff --git a/website/uc-doc/api_sdk/mobile_push_notification.md b/website/uc-doc/api_sdk/mobile_push_notification.md index 0c7fcdc8..32b65819 100644 --- a/website/uc-doc/api_sdk/mobile_push_notification.md +++ b/website/uc-doc/api_sdk/mobile_push_notification.md @@ -2,12 +2,6 @@ title: 'Mobile Push Notifications' --- -- [Configuring push notifications](#configuring-push-notifications) - - [Configuring FCM support](#configuring-fcm-support) - - [Configuring APNS support](#configuring-apns-support) -- [Push notification types](#push-notification-types) -- [Triggering push notifications through the API](#triggering-push-notifications-through-the-api) - The Wazo Platform can generate push notifications for mobile users, through the wazo-webhookd component. diff --git a/website/uc-doc/api_sdk/rest_api/troubleshooting.md b/website/uc-doc/api_sdk/rest_api/troubleshooting.md index 5841d926..4622fb21 100644 --- a/website/uc-doc/api_sdk/rest_api/troubleshooting.md +++ b/website/uc-doc/api_sdk/rest_api/troubleshooting.md @@ -2,10 +2,6 @@ title: REST API Troubleshooting --- -- [Swagger UI: Can't read from server...](#swagger-ui-cant-read-from-server...) - - [Problem](#problem) - - [Answer](#answer) - Here is a list of common problems you can encounter with Wazo REST APIs. ## Swagger UI: Can't read from server... diff --git a/website/uc-doc/api_sdk/websocket.md b/website/uc-doc/api_sdk/websocket.md index b3761af3..a15bb123 100644 --- a/website/uc-doc/api_sdk/websocket.md +++ b/website/uc-doc/api_sdk/websocket.md @@ -2,16 +2,6 @@ title: WebSocket Event Service --- -- [Getting Started](#getting-started) - - [Example](#example) -- [Reference](#reference) - - [Authentication](#authentication) - - [Events Access Control](#ws-events-acl) - - [Status Code](#ws-status-code) - - [Protocol](#ws-protocol) - - [Client Messages](#client-messages) - - [Server Messages](#server-messages) - Wazo offers a service to receive messages published on the [bus (e.g. RabbitMQ)](/uc-doc/api_sdk/message_bus) over an encrypted [WebSocket](https://en.wikipedia.org/wiki/WebSocket) connection. This ease in building dynamic web diff --git a/website/uc-doc/system/https_certificate.md b/website/uc-doc/system/https_certificate.md index 57be8de7..a2b1ee32 100644 --- a/website/uc-doc/system/https_certificate.md +++ b/website/uc-doc/system/https_certificate.md @@ -2,11 +2,6 @@ title: Certificates for HTTPS --- -- [Wazo and HTTPS](#wazo-and-https) -- [Let's Encrypt](#lets-encrypt) -- [Use your own certificate](#use-your-own-certificate) -- [Revert previous custom HTTPS certificate configuration](#revert-previous-custom-https-certificate-configuration) - X.509 certificates are used to authorize and secure communications with the server. They are mainly used for HTTPS, but can also be used for SIPS, CTIS, WSS, etc. diff --git a/website/uc-doc/system/log_files.md b/website/uc-doc/system/log_files.md index 0a1f4b3f..92ad7238 100644 --- a/website/uc-doc/system/log_files.md +++ b/website/uc-doc/system/log_files.md @@ -2,25 +2,6 @@ title: Log Files --- -- [asterisk](#asterisk) -- [wazo-auth](#wazo-auth) -- [wazo-agid](#wazo-agid) -- [wazo-calld](#wazo-calld) -- [wazo-dird](#wazo-dird) -- [wazo-upgrade](#wazo-upgrade) -- [wazo-agentd](#wazo-agentd) -- [wazo-amid](#wazo-amid) -- [wazo-call-logd](#wazo-call-logd) -- [wazo-confd](#wazo-confd) -- [wazo-confgend](#wazo-confgend) -- [wazo-phoned](#wazo-phoned) -- [wazo-dxtora](#wazo-dxtora) -- [wazo-provd](#wazo-provd) -- [wazo-purge-db](#wazo-purge-db) -- [wazo-stat](#wazo-stat) -- [wazo-sysconfd](#wazo-sysconfd) -- [wazo-websocketd](#wazo-websocketd) - Every Wazo service has its own log file, placed in `/var/log`. ## asterisk diff --git a/website/uc-doc/system/proxy.md b/website/uc-doc/system/proxy.md index 463d6126..d02fae37 100644 --- a/website/uc-doc/system/proxy.md +++ b/website/uc-doc/system/proxy.md @@ -2,12 +2,6 @@ title: Proxy Configuration --- -- [apt](#apt) -- [provd](#provd) -- [dhcp-update](#dhcp-update) -- [xivo-fetchfw](#xivo-fetchfw) -- [wazo-auth, wazo-dird](#wazo-auth-wazo-dird) - If you use Wazo behind an HTTP proxy, you must do a couple of manipulations for it to work correctly. diff --git a/website/uc-doc/system/service.md b/website/uc-doc/system/service.md index 8a698b23..aa058228 100644 --- a/website/uc-doc/system/service.md +++ b/website/uc-doc/system/service.md @@ -2,8 +2,6 @@ title: 'wazo-service' --- -- [Usage](#usage) - Wazo has many running services. To restart the whole stack, the `wazo-service` command can be used to make sure the service is restarted in the right order. diff --git a/website/uc-doc/system/wazo-dird/configuration.md b/website/uc-doc/system/wazo-dird/configuration.md index 19520ab6..5048e97a 100644 --- a/website/uc-doc/system/wazo-dird/configuration.md +++ b/website/uc-doc/system/wazo-dird/configuration.md @@ -2,10 +2,6 @@ title: 'wazo-dird configuration' --- -- [Main Configuration File](#main-configuration-file) - - [Root section](#root-section) - - [enabled_plugins section](#enabled-plugins-section) - There are three sources of configuration for wazo-dird: - the [command line options](/uc-doc/system/wazo-dird/introduction#wazo-dird-usage) diff --git a/website/uc-doc/system/wazo-dird/developer.md b/website/uc-doc/system/wazo-dird/developer.md index 65992cf6..a6e0f8bc 100644 --- a/website/uc-doc/system/wazo-dird/developer.md +++ b/website/uc-doc/system/wazo-dird/developer.md @@ -2,16 +2,6 @@ title: "wazo-dird developer's guide" --- -- [Back-End](#dird-back-end) - - [Implementation details](#implementation-details) - - [Example](#example) -- [Service](#dird-service) - - [Implementation details](#implementation-details-1) - - [Example](#example-1) -- [View](#dird-view) - - [Implementation details](#implementation-details-2) - - [Example](#example-2) - ![wazo-dird startup flow](/images/uc-doc/system/wazo-dird/startup.png) The wazo-dird architecture uses plugins as extension points for most of its job. It uses diff --git a/website/uc-doc/system/wazo-sysconfd.md b/website/uc-doc/system/wazo-sysconfd.md index 0e5cf577..c79bedc9 100644 --- a/website/uc-doc/system/wazo-sysconfd.md +++ b/website/uc-doc/system/wazo-sysconfd.md @@ -2,9 +2,6 @@ title: 'wazo-sysconfd' --- -- [Configuration File](#sysconfd-configuration) - - [request_handlers section](#request-handlers-section) - wazo-sysconfd is the system configuration server for Wazo. It does quite a few different things; here's a non exhaustive list: From 56ecedde5e5eb690ca99c356866607981cf94802 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Fri, 25 Oct 2024 10:56:44 -0400 Subject: [PATCH 04/22] docs(uc-doc): migrate remaining introduction --- website/redirects.ts | 20 ++++ website/uc-doc/system/wazo-auth/developer.md | 3 +- website/uc-doc/system/wazo-auth/index.md | 103 ++++++++++++++++- .../uc-doc/system/wazo-auth/introduction.md | 104 ------------------ website/uc-doc/system/wazo-calld/developer.md | 1 + website/uc-doc/system/wazo-calld/index.md | 14 +++ website/uc-doc/system/wazo-confd/developer.md | 1 + website/uc-doc/system/wazo-confd/index.md | 6 +- .../uc-doc/system/wazo-confd/introduction.md | 10 -- .../uc-doc/system/wazo-confgend/developer.md | 3 +- website/uc-doc/system/wazo-confgend/index.md | 1 - .../system/wazo-confgend/introduction.md | 8 -- website/uc-doc/system/wazo-dird/developer.md | 3 +- website/uc-doc/system/wazo-dird/index.md | 43 +++++++- .../uc-doc/system/wazo-dird/introduction.md | 49 --------- .../upgrade/upgrade_specific_version/index.md | 12 +- .../upgrade_specific_version/introduction.md | 18 --- 17 files changed, 200 insertions(+), 199 deletions(-) delete mode 100644 website/uc-doc/system/wazo-auth/introduction.md delete mode 100644 website/uc-doc/system/wazo-confd/introduction.md delete mode 100644 website/uc-doc/system/wazo-confgend/introduction.md delete mode 100644 website/uc-doc/system/wazo-dird/introduction.md delete mode 100644 website/uc-doc/upgrade/upgrade_specific_version/introduction.md diff --git a/website/redirects.ts b/website/redirects.ts index 0a17c707..7b06aa46 100644 --- a/website/redirects.ts +++ b/website/redirects.ts @@ -37,6 +37,26 @@ const REDIRECTS: Options['redirects'] = [ from: '/uc-doc/upgrade/introduction', to: '/uc-doc/upgrade', }, + { + from: '/uc-doc/upgrade/upgrade_specific_version/introduction', + to: '/uc-doc/upgrade/upgrade_specific_version', + }, + { + from: '/uc-doc/system/wazo-auth/introduction', + to: '/uc-doc/system/wazo-auth', + }, + { + from: '/uc-doc/system/wazo-confd/introduction', + to: '/uc-doc/system/wazo-confd', + }, + { + from: '/uc-doc/system/wazo-confgend/introduction', + to: '/uc-doc/system/wazo-confgend', + }, + { + from: '/uc-doc/system/wazo-dird/introduction', + to: '/uc-doc/system/wazo-dird', + }, ]; export default REDIRECTS diff --git a/website/uc-doc/system/wazo-auth/developer.md b/website/uc-doc/system/wazo-auth/developer.md index 8c17a5f3..c3e7a803 100644 --- a/website/uc-doc/system/wazo-auth/developer.md +++ b/website/uc-doc/system/wazo-auth/developer.md @@ -1,5 +1,6 @@ --- -title: wazo-auth Developer's Guide +title: Developer's Guide (wazo-auth) +sidebar_label: Developer's Guide --- ## Architecture diff --git a/website/uc-doc/system/wazo-auth/index.md b/website/uc-doc/system/wazo-auth/index.md index 0704edea..7003ed9d 100644 --- a/website/uc-doc/system/wazo-auth/index.md +++ b/website/uc-doc/system/wazo-auth/index.md @@ -2,6 +2,103 @@ title: 'wazo-auth' --- -- [Introduction](/uc-doc/system/wazo-auth/introduction) -- [Developer](/uc-doc/system/wazo-auth/developer) -- [Stock Plugins](/uc-doc/system/wazo-auth/stock_plugins) +wazo-auth is a scalable, extendable and configurable authentication service. It uses an HTTP +interface to emit tokens to users who can then use those tokens to identify and authenticate +themselves with other services compatible with wazo-auth. + +The HTTP API reference is at [documentation](https://wazo-platform.org/documentation). + +- [developer](/uc-doc/system/wazo-auth/developer) +- [stock_plugins](/uc-doc/system/wazo-auth/stock_plugins) + +## Usage + +wazo-auth is used through HTTP requests, using HTTPS. As a user, the most common operation is to get +a new token. This is done with the POST method. + +Alice retrieves a token using her username/password: + +```shell +# Alice creates a new token, using the wazo_user backend, expiring in 10 minutes +curl -k -X POST -H 'Content-Type: application/json' -u 'alice:s3cre7' "https://localhost/api/auth/0.1/token" -d '{"backend": "wazo_user", "expiration": 600}';echo +{"data": {"issued_at": "2015-06-05T10:16:58.557553", "utc_issued_at": "2015-06-05T15:16:58.557553", "token": "1823c1ee-6c6a-0cdc-d869-964a7f08a744", "auth_id": "63f3dc3c-865d-419e-bec2-e18c4b118224", "xivo_user_uuid": "63f3dc3c-865d-419e-bec2-e18c4b118224", "expires_at": "2015-06-05T11:16:58.557595", "utc_expires_at": "2015-06-05T16:16:58.557595"}} +``` + +In this example Alice used here login `alice` and password `s3cre7`. The authentication source is +determined by the [backend](/uc-doc/system/wazo-auth/stock_plugins) in the POST data. + +Alice could also have specified an expiration time on her POST request. The expiration value is the +number of seconds before the token expires. + +After retrieving her token, Alice can query other services that use wazo-auth and send her token to +those service. Those services can then use this token on Alice's behalf to access her personal +storage. + +If Alice wants to revoke her token before its expiration: + +```shell +curl -k -X DELETE -H 'Content-Type: application/json' "https://localhost/api/auth/0.1/token/1823c1ee-6c6a-0cdc-d869-964a7f08a744" +``` + +See [documentation](https://wazo-platform.org/documentation) for more details about the HTTP API. + +See [Service Authentication](/uc-doc/system/service_authentication) for details about the +authentication process. + +## Usage for services using wazo-auth + +A service that requires authentication and identification can use wazo-auth to externalise the +burden of authentication. The new service can then accept a token as part of its operations to +authenticate the user using the service. + +Once a service receives a token from one of its user, it will need to check the validity of that +token. There are 2 forms of verification, one that only checks if the token is valid and the other +returns information about this token's session if it is valid. + +Checking if a token is valid: + +```shell +curl -k -i -X HEAD -H 'Content-Type: application/json' "https://localhost/api/auth/0.1/token/1823c1ee-6c6a-0cdc-d869-964a7f08a744" +HTTP/1.1 204 NO CONTENT +Content-Type: text/html; charset=utf-8 +Content-Length: 0 +Date: Fri, 05 Jun 2015 14:49:50 GMT +Server: pcm-dev-0 + +# get more information about this token +curl -k -X GET -H 'Content-Type: application/json' "https://localhost/api/auth/0.1/token/1823c1ee-6c6a-0cdc-d869-964a7f08a744";echo +{"data": {"issued_at": "2015-06-05T10:16:58.557553", "utc_issued_at": "2015-06-05T15:16:58.557553", "token": "1823c1ee-6c6a-0cdc-d869-964a7f08a744", "auth_id": "63f3dc3c-865d-419e-bec2-e18c4b118224", "xivo_user_uuid": "63f3dc3c-865d-419e-bec2-e18c4b118224", "expires_at": "2015-06-05T11:16:58.557595", "utc_expires_at": "2015-06-05T16:16:58.557595"}} +``` + +## Launching wazo-auth + +```ascii +usage: wazo-auth [-h] [-c CONFIG_FILE] [-u USER] [-d] [-f] [-l LOG_LEVEL] + +optional arguments: + -h, --help show this help message and exit + -c CONFIG_FILE, --config-file CONFIG_FILE + The path to the config file + -u USER, --user USER User to run the daemon + -d, --debug Log debug messages + -l LOG_LEVEL, --log-level LOG_LEVEL + Logs messages with LOG_LEVEL details. Must be one of: + critical, error, warning, info, debug. Default: None +``` + +## Configuration + +## Policies + +A policy is a list of access that is used to access Wazo resources. Policies can be created, deleted +or modified using the REST API. + +## HTTP API Reference + +The complete HTTP API documentation is [here](https://wazo-platform.org/documentation). + +See also the [wazo-auth changelog](/uc-doc/api_sdk/rest_api/changelog). + +## Development + +See [wazo-auth Developer's Guide](/uc-doc/system/wazo-auth/developer). diff --git a/website/uc-doc/system/wazo-auth/introduction.md b/website/uc-doc/system/wazo-auth/introduction.md deleted file mode 100644 index 046de634..00000000 --- a/website/uc-doc/system/wazo-auth/introduction.md +++ /dev/null @@ -1,104 +0,0 @@ ---- -title: Introduction ---- - -wazo-auth is a scalable, extendable and configurable authentication service. It uses an HTTP -interface to emit tokens to users who can then use those tokens to identify and authenticate -themselves with other services compatible with wazo-auth. - -The HTTP API reference is at [documentation](https://wazo-platform.org/documentation). - -- [developer](/uc-doc/system/wazo-auth/developer) -- [stock_plugins](/uc-doc/system/wazo-auth/stock_plugins) - -## Usage - -wazo-auth is used through HTTP requests, using HTTPS. As a user, the most common operation is to get -a new token. This is done with the POST method. - -Alice retrieves a token using her username/password: - -```shell -# Alice creates a new token, using the wazo_user backend, expiring in 10 minutes -curl -k -X POST -H 'Content-Type: application/json' -u 'alice:s3cre7' "https://localhost/api/auth/0.1/token" -d '{"backend": "wazo_user", "expiration": 600}';echo -{"data": {"issued_at": "2015-06-05T10:16:58.557553", "utc_issued_at": "2015-06-05T15:16:58.557553", "token": "1823c1ee-6c6a-0cdc-d869-964a7f08a744", "auth_id": "63f3dc3c-865d-419e-bec2-e18c4b118224", "xivo_user_uuid": "63f3dc3c-865d-419e-bec2-e18c4b118224", "expires_at": "2015-06-05T11:16:58.557595", "utc_expires_at": "2015-06-05T16:16:58.557595"}} -``` - -In this example Alice used here login `alice` and password `s3cre7`. The authentication source is -determined by the [backend](/uc-doc/system/wazo-auth/stock_plugins) in the POST data. - -Alice could also have specified an expiration time on her POST request. The expiration value is the -number of seconds before the token expires. - -After retrieving her token, Alice can query other services that use wazo-auth and send her token to -those service. Those services can then use this token on Alice's behalf to access her personal -storage. - -If Alice wants to revoke her token before its expiration: - -```shell -curl -k -X DELETE -H 'Content-Type: application/json' "https://localhost/api/auth/0.1/token/1823c1ee-6c6a-0cdc-d869-964a7f08a744" -``` - -See [documentation](https://wazo-platform.org/documentation) for more details about the HTTP API. - -See [Service Authentication](/uc-doc/system/service_authentication) for details about the -authentication process. - -## Usage for services using wazo-auth - -A service that requires authentication and identification can use wazo-auth to externalise the -burden of authentication. The new service can then accept a token as part of its operations to -authenticate the user using the service. - -Once a service receives a token from one of its user, it will need to check the validity of that -token. There are 2 forms of verification, one that only checks if the token is valid and the other -returns information about this token's session if it is valid. - -Checking if a token is valid: - -```shell -curl -k -i -X HEAD -H 'Content-Type: application/json' "https://localhost/api/auth/0.1/token/1823c1ee-6c6a-0cdc-d869-964a7f08a744" -HTTP/1.1 204 NO CONTENT -Content-Type: text/html; charset=utf-8 -Content-Length: 0 -Date: Fri, 05 Jun 2015 14:49:50 GMT -Server: pcm-dev-0 - -# get more information about this token -curl -k -X GET -H 'Content-Type: application/json' "https://localhost/api/auth/0.1/token/1823c1ee-6c6a-0cdc-d869-964a7f08a744";echo -{"data": {"issued_at": "2015-06-05T10:16:58.557553", "utc_issued_at": "2015-06-05T15:16:58.557553", "token": "1823c1ee-6c6a-0cdc-d869-964a7f08a744", "auth_id": "63f3dc3c-865d-419e-bec2-e18c4b118224", "xivo_user_uuid": "63f3dc3c-865d-419e-bec2-e18c4b118224", "expires_at": "2015-06-05T11:16:58.557595", "utc_expires_at": "2015-06-05T16:16:58.557595"}} -``` - -## Launching wazo-auth - -```ascii -usage: wazo-auth [-h] [-c CONFIG_FILE] [-u USER] [-d] [-f] [-l LOG_LEVEL] - -optional arguments: - -h, --help show this help message and exit - -c CONFIG_FILE, --config-file CONFIG_FILE - The path to the config file - -u USER, --user USER User to run the daemon - -d, --debug Log debug messages - -l LOG_LEVEL, --log-level LOG_LEVEL - Logs messages with LOG_LEVEL details. Must be one of: - critical, error, warning, info, debug. Default: None -``` - -## Configuration - -## Policies - -A policy is a list of access that is used to access Wazo resources. Policies can be created, deleted -or modified using the REST API. - -## HTTP API Reference - -The complete HTTP API documentation is [here](https://wazo-platform.org/documentation). - -See also the [wazo-auth changelog](/uc-doc/api_sdk/rest_api/changelog). - -## Development - -See [wazo-auth Developer's Guide](/uc-doc/system/wazo-auth/developer). diff --git a/website/uc-doc/system/wazo-calld/developer.md b/website/uc-doc/system/wazo-calld/developer.md index fa8d8d33..b38070da 100644 --- a/website/uc-doc/system/wazo-calld/developer.md +++ b/website/uc-doc/system/wazo-calld/developer.md @@ -1,5 +1,6 @@ --- title: "Developer's Guide (wazo-calld)" +sidebar_label: Developer's Guide --- # Transfers diff --git a/website/uc-doc/system/wazo-calld/index.md b/website/uc-doc/system/wazo-calld/index.md index d5bb2ed4..be1b0591 100644 --- a/website/uc-doc/system/wazo-calld/index.md +++ b/website/uc-doc/system/wazo-calld/index.md @@ -1,3 +1,17 @@ --- title: 'wazo-calld' --- + +`wazo-calld` is the call control service for the Wazo platform. It manages the following resources: + +- applications +- calls +- fax +- relocates +- switchboards +- transfers +- voicemails + +## Development + +See [wazo-calld Developer's Guide](/uc-doc/system/wazo-calld/developer). diff --git a/website/uc-doc/system/wazo-confd/developer.md b/website/uc-doc/system/wazo-confd/developer.md index 2e39a822..1ff625ee 100644 --- a/website/uc-doc/system/wazo-confd/developer.md +++ b/website/uc-doc/system/wazo-confd/developer.md @@ -1,5 +1,6 @@ --- title: Developer's Guide (wazo-confd) +sidebar_label: Developer's Guide --- wazo-confd resources are organised through a plugin mechanism. There are 2 main plugin categories: diff --git a/website/uc-doc/system/wazo-confd/index.md b/website/uc-doc/system/wazo-confd/index.md index c667aae7..46f332b3 100644 --- a/website/uc-doc/system/wazo-confd/index.md +++ b/website/uc-doc/system/wazo-confd/index.md @@ -2,5 +2,9 @@ title: wazo-confd --- -- [Introduction](/uc-doc/system/wazo-confd/introduction) +`wazo-confd` is a HTTP server that provides a RESTful API service for configuring and managing basic +resources on a Wazo server. + +The HTTP API reference is available [here](/documentation). + - [Developer's Guide](/uc-doc/system/wazo-confd/developer) diff --git a/website/uc-doc/system/wazo-confd/introduction.md b/website/uc-doc/system/wazo-confd/introduction.md deleted file mode 100644 index 659fa38a..00000000 --- a/website/uc-doc/system/wazo-confd/introduction.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -title: Introduction ---- - -wazo-confd is a HTTP server that provides a RESTful API service for configuring and managing basic -resources on a Wazo server. - -The HTTP API reference is available [here](/documentation). - -- [Developer's Guide](/uc-doc/system/wazo-confd/developer) diff --git a/website/uc-doc/system/wazo-confgend/developer.md b/website/uc-doc/system/wazo-confgend/developer.md index d0afe251..b786c0b1 100644 --- a/website/uc-doc/system/wazo-confgend/developer.md +++ b/website/uc-doc/system/wazo-confgend/developer.md @@ -1,5 +1,6 @@ --- -title: Wazo confgend developer's guide +title: Developer's guide (wazo-confgend) +sidebar_label: Developer's Guide --- wazo-confgend uses drivers to implement the logic required to generate configuration files. It uses diff --git a/website/uc-doc/system/wazo-confgend/index.md b/website/uc-doc/system/wazo-confgend/index.md index e9f116aa..1bfd613b 100644 --- a/website/uc-doc/system/wazo-confgend/index.md +++ b/website/uc-doc/system/wazo-confgend/index.md @@ -5,5 +5,4 @@ title: 'wazo-confgend' wazo-confgend is a configuration file generator. It is mainly used to generate the Asterisk configuration files. -- [Developer's Guide](/uc-doc/system/wazo-confgend/introduction) - [Developer's Guide](/uc-doc/system/wazo-confgend/developer) diff --git a/website/uc-doc/system/wazo-confgend/introduction.md b/website/uc-doc/system/wazo-confgend/introduction.md deleted file mode 100644 index 21792e0b..00000000 --- a/website/uc-doc/system/wazo-confgend/introduction.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Introduction ---- - -wazo-confgend is a configuration file generator. It is mainly used to generate the Asterisk -configuration files. - -- [developer](/uc-doc/system/wazo-confgend/developer) diff --git a/website/uc-doc/system/wazo-dird/developer.md b/website/uc-doc/system/wazo-dird/developer.md index a6e0f8bc..1d310998 100644 --- a/website/uc-doc/system/wazo-dird/developer.md +++ b/website/uc-doc/system/wazo-dird/developer.md @@ -1,5 +1,6 @@ --- -title: "wazo-dird developer's guide" +title: "Developer's guide (wazo-dird)" +sidebar_label: Developer's Guide --- ![wazo-dird startup flow](/images/uc-doc/system/wazo-dird/startup.png) diff --git a/website/uc-doc/system/wazo-dird/index.md b/website/uc-doc/system/wazo-dird/index.md index 602619c0..665136d3 100644 --- a/website/uc-doc/system/wazo-dird/index.md +++ b/website/uc-doc/system/wazo-dird/index.md @@ -2,7 +2,48 @@ title: 'wazo-dird' --- -- [Introduction](/uc-doc/system/wazo-dird/introduction) +wazo-dird is the directory server for Wazo. It offers a simple REST interface to query all +directories that are configured. wazo-dird is extendable with plugins. + - [Configuration](/uc-doc/system/wazo-dird/configuration) - [Developer's](/uc-doc/system/wazo-dird/developer) - [Stock Plugins Documentation](/uc-doc/system/wazo-dird/stock_plugins) + +## Launching wazo-dird {#wazo-dird-usage} + +```ascii +usage: wazo-dird [-h] [-c CONFIG_FILE] [-d] [-f] [-l LOG_LEVEL] [-u USER] + +optional arguments: + -h, --help show this help message and exit + -c CONFIG_FILE, --config-file CONFIG_FILE + The path where is the config file. Default: /etc/wazo-dird/config.yml + -d, --debug Log debug messages. Overrides log_level. Default: + False + -l LOG_LEVEL, --log-level LOG_LEVEL + Logs messages with LOG_LEVEL details. Must be one of: + critical, error, warning, info, debug. Default: info + -u USER, --user USER The owner of the process. +``` + +## Terminology + +### Back-end + +A back-end is a connector to query a specific type of directory, e.g. one back-end to query LDAP +servers, another back-end to query CSV files, etc. + +### Source + +A source is an instance of a back-end. One backend may be used multiples times to query multiple +directories of the same type. For example, I could have the customer-csv and the employee-csv +sources, each using the CSV back-end, but reading a different file. + +### Plugins {#developing-plugins} + +A plugin is an extension point in wazo-dird. It is a way to add or modify the functionality of +wazo-dird. There are currently three types of plugins: + +- Back-ends to query different types of directories (LDAP, CSV, etc.) +- Services to provide different directory actions (lookup, reverse lookup, etc.) +- Views to expose directory results in different formats (JSON, XML, etc.) diff --git a/website/uc-doc/system/wazo-dird/introduction.md b/website/uc-doc/system/wazo-dird/introduction.md deleted file mode 100644 index 88aa4cb4..00000000 --- a/website/uc-doc/system/wazo-dird/introduction.md +++ /dev/null @@ -1,49 +0,0 @@ ---- -title: Introduction ---- - -wazo-dird is the directory server for Wazo. It offers a simple REST interface to query all -directories that are configured. wazo-dird is extendable with plugins. - -- [Configuration](/uc-doc/system/wazo-dird/configuration) -- [Developer's](/uc-doc/system/wazo-dird/developer) -- [Stock Plugins Documentation](/uc-doc/system/wazo-dird/stock_plugins) - -## Launching wazo-dird {#wazo-dird-usage} - -```ascii -usage: wazo-dird [-h] [-c CONFIG_FILE] [-d] [-f] [-l LOG_LEVEL] [-u USER] - -optional arguments: - -h, --help show this help message and exit - -c CONFIG_FILE, --config-file CONFIG_FILE - The path where is the config file. Default: /etc/wazo-dird/config.yml - -d, --debug Log debug messages. Overrides log_level. Default: - False - -l LOG_LEVEL, --log-level LOG_LEVEL - Logs messages with LOG_LEVEL details. Must be one of: - critical, error, warning, info, debug. Default: info - -u USER, --user USER The owner of the process. -``` - -## Terminology - -### Back-end - -A back-end is a connector to query a specific type of directory, e.g. one back-end to query LDAP -servers, another back-end to query CSV files, etc. - -### Source - -A source is an instance of a back-end. One backend may be used multiples times to query multiple -directories of the same type. For example, I could have the customer-csv and the employee-csv -sources, each using the CSV back-end, but reading a different file. - -### Plugins {#developing-plugins} - -A plugin is an extension point in wazo-dird. It is a way to add or modify the functionality of -wazo-dird. There are currently three types of plugins: - -- Back-ends to query different types of directories (LDAP, CSV, etc.) -- Services to provide different directory actions (lookup, reverse lookup, etc.) -- Views to expose directory results in different formats (JSON, XML, etc.) diff --git a/website/uc-doc/upgrade/upgrade_specific_version/index.md b/website/uc-doc/upgrade/upgrade_specific_version/index.md index 66965343..1d23a662 100644 --- a/website/uc-doc/upgrade/upgrade_specific_version/index.md +++ b/website/uc-doc/upgrade/upgrade_specific_version/index.md @@ -2,7 +2,17 @@ title: Upgrade to a specific version --- -- [Upgrade to a specific version](/uc-doc/upgrade/upgrade_specific_version/introduction) +## What is the point? + +Sometimes, you may need to upgrade your Wazo to a specific version, in case you don't want to +upgrade to the latest (which is not recommended, but sometimes necessary). + +## Prerequisites + +**Note**: These procedures are _complementary_ to the upgrade procedure listed in +[version specific upgrade](/uc-doc/upgrade/introduction#version-specific-upgrade). You must follow +the version-specific procedure _before_ running the following procedures. + - [Upgrade from Wazo \< 19.04](/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-stretch) - [Upgrade from Wazo \> 19.12](/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-buster) - [Upgrade from Wazo \> 23.05](/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-bullseye) diff --git a/website/uc-doc/upgrade/upgrade_specific_version/introduction.md b/website/uc-doc/upgrade/upgrade_specific_version/introduction.md deleted file mode 100644 index 1d23a662..00000000 --- a/website/uc-doc/upgrade/upgrade_specific_version/introduction.md +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: Upgrade to a specific version ---- - -## What is the point? - -Sometimes, you may need to upgrade your Wazo to a specific version, in case you don't want to -upgrade to the latest (which is not recommended, but sometimes necessary). - -## Prerequisites - -**Note**: These procedures are _complementary_ to the upgrade procedure listed in -[version specific upgrade](/uc-doc/upgrade/introduction#version-specific-upgrade). You must follow -the version-specific procedure _before_ running the following procedures. - -- [Upgrade from Wazo \< 19.04](/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-stretch) -- [Upgrade from Wazo \> 19.12](/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-buster) -- [Upgrade from Wazo \> 23.05](/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-bullseye) From e3fb52b691430740f4bca08cf29f2672a5f1e99f Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Fri, 25 Oct 2024 11:46:55 -0400 Subject: [PATCH 05/22] style: add Card & CardList --- website/src/components/Card/Card.module.css | 27 +++++++++++++++++++ website/src/components/Card/Card.tsx | 26 ++++++++++++++++++ .../src/components/Card/CardList.module.css | 5 ++++ website/src/components/Card/CardList.tsx | 22 +++++++++++++++ 4 files changed, 80 insertions(+) create mode 100644 website/src/components/Card/Card.module.css create mode 100644 website/src/components/Card/Card.tsx create mode 100644 website/src/components/Card/CardList.module.css create mode 100644 website/src/components/Card/CardList.tsx diff --git a/website/src/components/Card/Card.module.css b/website/src/components/Card/Card.module.css new file mode 100644 index 00000000..83aa95b3 --- /dev/null +++ b/website/src/components/Card/Card.module.css @@ -0,0 +1,27 @@ +.override { + box-shadow: none; + border: 1px solid var(--ifm-color-emphasis-300); +} + +a.override { + transition: border-color var(--ifm-transition-fast) var(--ifm-transition-timing-default), + color var(--ifm-transition-fast) var(--ifm-transition-timing-default); + color: var(--ifm-color-content); + text-decoration: none; +} +a.override:hover, a.override:active { + color: var(--ifm-pagination-nav-color-hover); + border-color: var(--ifm-pagination-nav-color-hover); +} + +.card__title { + font-weight: bold; + margin: 0; +} + +.card__description { + color: var(--ifm-color-content-secondary); + font-size: var(--ifm-h5-font-size); + font-weight: var(--ifm-font-weight-semibold); + margin: 0.05rem 0 0; +} diff --git a/website/src/components/Card/Card.tsx b/website/src/components/Card/Card.tsx new file mode 100644 index 00000000..cf6eabdd --- /dev/null +++ b/website/src/components/Card/Card.tsx @@ -0,0 +1,26 @@ +import Link from '@docusaurus/Link'; +import styles from './Card.module.css'; + +export type Props = { + href?: string | undefined; + text: string; + description?: string; +}; + +const Card = ({ href, text, description }: Props) => { + const RootElement = href ? Link : 'div'; + const RootProps = href ? { to: href } : {}; + + return ( + +
+

{text}

+ {description && ( +

{description}

+ )} +
+ + ); +}; + +export default Card; diff --git a/website/src/components/Card/CardList.module.css b/website/src/components/Card/CardList.module.css new file mode 100644 index 00000000..c608946e --- /dev/null +++ b/website/src/components/Card/CardList.module.css @@ -0,0 +1,5 @@ +.listing { + display: grid; + grid-template-columns: 1fr 1fr; + gap: var(--ifm-spacing-horizontal); +} diff --git a/website/src/components/Card/CardList.tsx b/website/src/components/Card/CardList.tsx new file mode 100644 index 00000000..4c7d07b1 --- /dev/null +++ b/website/src/components/Card/CardList.tsx @@ -0,0 +1,22 @@ +import Card, { type Props as CardProps } from './Card'; +import styles from './CardList.module.css'; + +type Props = { + items: CardProps[]; +}; + +const CardList = ({ items }: Props) => { + if (!items?.length) { + return undefined; + } + + return ( +
+ {items?.map((item: CardProps) => ( + + ))} +
+ ); +}; + +export default CardList; From dc4193d5ea8f389f39649d61f4ee8f1ee281c1b6 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Fri, 25 Oct 2024 12:45:57 -0400 Subject: [PATCH 06/22] docs(uc-doc): improve listing only page --- website/docusaurus.config.ts | 2 +- website/redirects.ts | 9 +- website/uc-doc/api_sdk/index.md | 15 ++- .../uc-doc/api_sdk/rest_api/confd/index.md | 10 +- website/uc-doc/api_sdk/rest_api/index.md | 18 ++- .../uc-doc/api_sdk/rest_api/sysconfd/index.md | 24 ++-- .../uc-doc/api_sdk/rest_api/webhookd/index.md | 13 ++- website/uc-doc/contact_center/index.md | 28 +++-- website/uc-doc/contributors/index.md | 41 ++++--- .../uc-doc/contributors/provisioning/index.md | 21 ++-- website/uc-doc/system/index.md | 104 ++++++++++++++---- 11 files changed, 202 insertions(+), 83 deletions(-) diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 92d7c18f..c18759e6 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -162,7 +162,7 @@ const config: Config = { [ '@docusaurus/plugin-client-redirects', { - redirects: REDIRECTS + redirects: REDIRECTS, }, ], ], diff --git a/website/redirects.ts b/website/redirects.ts index 7b06aa46..dd30a263 100644 --- a/website/redirects.ts +++ b/website/redirects.ts @@ -1,4 +1,4 @@ -import type { Options } from '@docusaurus/plugin-client-redirects' +import type { Options } from '@docusaurus/plugin-client-redirects'; const REDIRECTS: Options['redirects'] = [ { @@ -18,7 +18,10 @@ const REDIRECTS: Options['redirects'] = [ to: '/uc-doc/administration', }, { - from: ['/uc-doc/api_sdk/mobile/push_notification', '/uc-doc/api_sdk/mobile'], + from: [ + '/uc-doc/api_sdk/mobile/push_notification', + '/uc-doc/api_sdk/mobile', + ], to: '/uc-doc/api_sdk/mobile_push_notification', }, { @@ -59,4 +62,4 @@ const REDIRECTS: Options['redirects'] = [ }, ]; -export default REDIRECTS +export default REDIRECTS; diff --git a/website/uc-doc/api_sdk/index.md b/website/uc-doc/api_sdk/index.md index f2018cfe..7300dfa9 100644 --- a/website/uc-doc/api_sdk/index.md +++ b/website/uc-doc/api_sdk/index.md @@ -1,9 +1,14 @@ --- title: API and SDK --- +import CardList from '@site/src/components/Card/CardList'; -- [Message Bus](/uc-doc/api_sdk/message_bus) -- [REST API](/uc-doc/api_sdk/rest_api) -- [Subroutine](/uc-doc/api_sdk/subroutine) -- [Websocket](/uc-doc/api_sdk/websocket) -- [Mobile](/uc-doc/api_sdk/mobile) + diff --git a/website/uc-doc/api_sdk/rest_api/confd/index.md b/website/uc-doc/api_sdk/rest_api/confd/index.md index 2cdc7f5b..e33b0e38 100644 --- a/website/uc-doc/api_sdk/rest_api/confd/index.md +++ b/website/uc-doc/api_sdk/rest_api/confd/index.md @@ -3,7 +3,13 @@ title: wazo-confd REST API subtitle: API reference --- +import CardList from '@site/src/components/Card/CardList'; + API documentation is available [here](https://wazo-platform.org/documentation). This section contains extended documentation for certain aspects of the API. -- [func keys](/uc-doc/api_sdk/rest_api/confd/func_keys) -- [user import](/uc-doc/api_sdk/rest_api/confd/user_import) + diff --git a/website/uc-doc/api_sdk/rest_api/index.md b/website/uc-doc/api_sdk/rest_api/index.md index d1998043..cc25d09e 100644 --- a/website/uc-doc/api_sdk/rest_api/index.md +++ b/website/uc-doc/api_sdk/rest_api/index.md @@ -2,11 +2,17 @@ title: REST API --- +import CardList from '@site/src/components/Card/CardList'; + The Wazo REST APIs are the privileged way to programmatically interact with Wazo. -- [quickstart](/uc-doc/api_sdk/rest_api/quickstart) -- [examples](/uc-doc/api_sdk/rest_api/examples) -- [troubleshooting](/uc-doc/api_sdk/rest_api/troubleshooting) -- [reference](/uc-doc/api_sdk/rest_api/reference) -- [conventions](/uc-doc/api_sdk/rest_api/conventions) -- [changelog](/uc-doc/api_sdk/rest_api/changelog) + diff --git a/website/uc-doc/api_sdk/rest_api/sysconfd/index.md b/website/uc-doc/api_sdk/rest_api/sysconfd/index.md index 6c33a78e..6786d128 100644 --- a/website/uc-doc/api_sdk/rest_api/sysconfd/index.md +++ b/website/uc-doc/api_sdk/rest_api/sysconfd/index.md @@ -2,6 +2,8 @@ title: wazo-sysconfd REST API --- +import CardList from '@site/src/components/Card/CardList'; + This service provides a public API that can be used to change the configuration that are on a Wazo. **Warning** The 0.1 API is currently in development. Major changes could still happen and new @@ -9,12 +11,16 @@ resources will be added over time. ## API reference -- [asterisk voicemail](/uc-doc/api_sdk/rest_api/sysconfd/asterisk_voicemail) -- [common configuration](/uc-doc/api_sdk/rest_api/sysconfd/common_configuration) -- [dhcpd configuration](/uc-doc/api_sdk/rest_api/sysconfd/dhcpd_configuration) -- [ha](/uc-doc/api_sdk/rest_api/sysconfd/ha) -- [dns](/uc-doc/api_sdk/rest_api/sysconfd/dns) -- [services](/uc-doc/api_sdk/rest_api/sysconfd/services) -- [xivo services](/uc-doc/api_sdk/rest_api/sysconfd/xivo_services) -- [handlers](/uc-doc/api_sdk/rest_api/sysconfd/handlers) -- [status check](/uc-doc/api_sdk/rest_api/sysconfd/status_check) + diff --git a/website/uc-doc/api_sdk/rest_api/webhookd/index.md b/website/uc-doc/api_sdk/rest_api/webhookd/index.md index b2ba29ba..68d06a7f 100644 --- a/website/uc-doc/api_sdk/rest_api/webhookd/index.md +++ b/website/uc-doc/api_sdk/rest_api/webhookd/index.md @@ -2,7 +2,14 @@ title: 'wazo-webhookd REST API' --- -More specific documentation: +import CardList from '@site/src/components/Card/CardList'; + +## Specific documentations + + -- [User Filter](/uc-doc/api_sdk/rest_api/webhookd/user_filter) -- [Templates](/uc-doc/api_sdk/rest_api/webhookd/templates) diff --git a/website/uc-doc/contact_center/index.md b/website/uc-doc/contact_center/index.md index 8adabfc3..a012e1c1 100644 --- a/website/uc-doc/contact_center/index.md +++ b/website/uc-doc/contact_center/index.md @@ -2,29 +2,35 @@ title: Contact Center --- +import CardList from '@site/src/components/Card/CardList'; + + + +## Objectives + In Wazo, the contact center is implemented to fulfill the following objectives. -## Call routing +### Call routing Includes basic call distribution using call queues and skills-based routing -## Agent and Supervisor workstation +### Agent and Supervisor workstation Provides the ability to execute contact center actions such as: agent login, agent logout and to receive real time statistics regarding contact center status -## Statistics reporting +### Statistics reporting Provides contact center management reporting on contact center activities -## Advanced functionalities +### Advanced functionalities - Call recording - Screen Pop-up - ---- - -- [Agents](/uc-doc/contact_center/agents) -- [Queues](/uc-doc/contact_center/queues) -- [Skill Based Routing](/uc-doc/contact_center/skillbasedrouting) -- [Reporting](/uc-doc/contact_center/reporting) diff --git a/website/uc-doc/contributors/index.md b/website/uc-doc/contributors/index.md index 3361cc0d..3e828bec 100644 --- a/website/uc-doc/contributors/index.md +++ b/website/uc-doc/contributors/index.md @@ -2,22 +2,35 @@ title: Contributors --- +import CardList from '@site/src/components/Card/CardList'; + ## General information -- [Contributing Doc](/uc-doc/contributors/contributing_doc) -- [Debug Asterisk](/uc-doc/contributors/debug_asterisk) -- [Debug Daemon](/uc-doc/contributors/debug_daemon) -- [Contributing to Wazo](/uc-doc/contributors/contributing_to_wazo) -- [Generate Custom Prompts](/uc-doc/contributors/generate_custom_prompts) -- [Guidelines](/uc-doc/contributors/guidelines) -- [Network](/uc-doc/contributors/network) -- [Plugins](/uc-doc/contributors/plugins) -- [Profile Python](/uc-doc/contributors/profile_python) -- [Style Guide](/uc-doc/contributors/style_guide) -- [Translate](/uc-doc/contributors/translate) + + ## Component specific information -- [Diagrams](/uc-doc/contributors/diagrams) -- [Provisioning](/uc-doc/contributors/provisioning) -- [SCCP](/uc-doc/contributors/sccp) + diff --git a/website/uc-doc/contributors/provisioning/index.md b/website/uc-doc/contributors/provisioning/index.md index 92fd9231..86c9ada8 100644 --- a/website/uc-doc/contributors/provisioning/index.md +++ b/website/uc-doc/contributors/provisioning/index.md @@ -2,12 +2,19 @@ title: Provisioning --- +import CardList from '@site/src/components/Card/CardList'; + This section describes the information and tools for wazo-provd. -- [Managing DHCP Server Configuration](/uc-doc/contributors/provisioning/managing_dhcp_server_configuration) -- [Managing Plugins](/uc-doc/contributors/provisioning/managing_plugins) -- [Testing New SIP Phone](/uc-doc/contributors/provisioning/testing_new_sip_phone) -- [NAT Environment](/uc-doc/contributors/provisioning/nat_environment) -- [Developing Plugins](/uc-doc/contributors/provisioning/developing_plugins) -- [HTTP/TFTP request handling in wazo-provd 1](/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-1) -- [HTTP/TFTP request handling in wazo-provd 2](/uc-doc/contributors/provisioning/httptftp-requests-processing-in-provd-part-2) + + diff --git a/website/uc-doc/system/index.md b/website/uc-doc/system/index.md index 930f5e26..18a530a4 100644 --- a/website/uc-doc/system/index.md +++ b/website/uc-doc/system/index.md @@ -2,25 +2,85 @@ title: System --- -- [DHCP Server](/uc-doc/system/dhcp) -- [Network](/uc-doc/system/network) -- [Backup Restore](/uc-doc/system/backup_restore) -- [HTTPS Certificate](/uc-doc/system/https_certificate) -- [Configuration Files](/uc-doc/system/configuration_files) -- [Log Files](/uc-doc/system/log_files) -- [nginx](/uc-doc/system/nginx) -- [NTP](/uc-doc/system/ntp) -- [Performance](/uc-doc/system/performance) -- [Proxy](/uc-doc/system/proxy) -- [Service Discovery](/uc-doc/system/service_discovery) -- [Service Authentication](/uc-doc/system/service_authentication) -- [wazo-auth](/uc-doc/system/wazo-auth) -- [wazo-service](/uc-doc/system/service) -- [wazo-webhookd](/uc-doc/system/wazo-webhookd) -- [wazo-calld](/uc-doc/system/wazo-calld) -- [wazo-confd](/uc-doc/system/wazo-confd) -- [wazo-confgend](/uc-doc/system/wazo-confgend) -- [wazo-dird](/uc-doc/system/wazo-dird) -- [wazo-phoned](/uc-doc/system/wazo-phoned) -- [wazo-purge-db](/uc-doc/system/purge_logs) -- [wazo-sysconfd](/uc-doc/system/wazo-sysconfd) +import CardList from '@site/src/components/Card/CardList'; + +## Wazo Micro-Services + +Documentations for the main services that make up Wazo Platform system. + + + + +## Generic Services + +Documentations of various and generix services included inside the platform. + + From ddfadeec180e4c7f7a945d4bc4edace0088771ff Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Fri, 25 Oct 2024 13:03:17 -0400 Subject: [PATCH 07/22] style(uc-doc): better labels for main sidebar --- website/uc-doc/api_sdk/rest_api/acl.md | 1 + website/uc-doc/api_sdk/rest_api/changelog.md | 1 + .../uc-doc/api_sdk/rest_api/confd/index.md | 1 + .../uc-doc/api_sdk/rest_api/conventions.md | 1 + website/uc-doc/api_sdk/rest_api/examples.md | 1 + website/uc-doc/api_sdk/rest_api/quickstart.md | 1 + website/uc-doc/api_sdk/rest_api/reference.md | 1 + .../uc-doc/api_sdk/rest_api/sysconfd/index.md | 1 + .../api_sdk/rest_api/troubleshooting.md | 1 + .../uc-doc/api_sdk/rest_api/webhookd/index.md | 1 + .../api_sdk/rest_api/webhookd/templates.md | 36 +++++++++++++++++-- .../uc-doc/system/wazo-dird/configuration.md | 3 +- 12 files changed, 45 insertions(+), 4 deletions(-) diff --git a/website/uc-doc/api_sdk/rest_api/acl.md b/website/uc-doc/api_sdk/rest_api/acl.md index 0f070940..1314536b 100644 --- a/website/uc-doc/api_sdk/rest_api/acl.md +++ b/website/uc-doc/api_sdk/rest_api/acl.md @@ -1,5 +1,6 @@ --- title: REST API Permissions +sidebar_label: Permissions (ACLs) --- The tokens delivered by [wazo-auth](/uc-doc/system/wazo-auth/introduction/) have a list of diff --git a/website/uc-doc/api_sdk/rest_api/changelog.md b/website/uc-doc/api_sdk/rest_api/changelog.md index 7333c697..1dad1395 100644 --- a/website/uc-doc/api_sdk/rest_api/changelog.md +++ b/website/uc-doc/api_sdk/rest_api/changelog.md @@ -1,5 +1,6 @@ --- title: REST API changelog +sidebar_label: Changelog --- The changelog of REST API can be found in [GitHub](https://github.com/wazo-platform) repository of diff --git a/website/uc-doc/api_sdk/rest_api/confd/index.md b/website/uc-doc/api_sdk/rest_api/confd/index.md index e33b0e38..b1c43470 100644 --- a/website/uc-doc/api_sdk/rest_api/confd/index.md +++ b/website/uc-doc/api_sdk/rest_api/confd/index.md @@ -1,6 +1,7 @@ --- title: wazo-confd REST API subtitle: API reference +sidebar_label: wazo-confd --- import CardList from '@site/src/components/Card/CardList'; diff --git a/website/uc-doc/api_sdk/rest_api/conventions.md b/website/uc-doc/api_sdk/rest_api/conventions.md index d44fe368..f08e6e95 100644 --- a/website/uc-doc/api_sdk/rest_api/conventions.md +++ b/website/uc-doc/api_sdk/rest_api/conventions.md @@ -1,5 +1,6 @@ --- title: REST API Conventions +sidebar_label: Conventions --- ## Authentication {#rest-api-authentication} diff --git a/website/uc-doc/api_sdk/rest_api/examples.md b/website/uc-doc/api_sdk/rest_api/examples.md index 1dd3cd3d..d171ed3d 100644 --- a/website/uc-doc/api_sdk/rest_api/examples.md +++ b/website/uc-doc/api_sdk/rest_api/examples.md @@ -1,5 +1,6 @@ --- title: REST API Examples +sidebar_label: Examples --- wazo-confd examples can be found [here](/documentation/api/configuration.html#rest-api-example). diff --git a/website/uc-doc/api_sdk/rest_api/quickstart.md b/website/uc-doc/api_sdk/rest_api/quickstart.md index 67a0f35a..da8bbd89 100644 --- a/website/uc-doc/api_sdk/rest_api/quickstart.md +++ b/website/uc-doc/api_sdk/rest_api/quickstart.md @@ -1,5 +1,6 @@ --- title: REST API Quickstart +sidebar_label: Quickstart --- ## Introduction diff --git a/website/uc-doc/api_sdk/rest_api/reference.md b/website/uc-doc/api_sdk/rest_api/reference.md index e504c92c..bad17c8b 100644 --- a/website/uc-doc/api_sdk/rest_api/reference.md +++ b/website/uc-doc/api_sdk/rest_api/reference.md @@ -1,5 +1,6 @@ --- title: REST API Reference +sidebar_label: Reference --- ## Access diff --git a/website/uc-doc/api_sdk/rest_api/sysconfd/index.md b/website/uc-doc/api_sdk/rest_api/sysconfd/index.md index 6786d128..da66f7c9 100644 --- a/website/uc-doc/api_sdk/rest_api/sysconfd/index.md +++ b/website/uc-doc/api_sdk/rest_api/sysconfd/index.md @@ -1,5 +1,6 @@ --- title: wazo-sysconfd REST API +sidebar_label: wazo-sysconfd --- import CardList from '@site/src/components/Card/CardList'; diff --git a/website/uc-doc/api_sdk/rest_api/troubleshooting.md b/website/uc-doc/api_sdk/rest_api/troubleshooting.md index 4622fb21..4f8eaf73 100644 --- a/website/uc-doc/api_sdk/rest_api/troubleshooting.md +++ b/website/uc-doc/api_sdk/rest_api/troubleshooting.md @@ -1,5 +1,6 @@ --- title: REST API Troubleshooting +sidebar_label: Troubleshooting --- Here is a list of common problems you can encounter with Wazo REST APIs. diff --git a/website/uc-doc/api_sdk/rest_api/webhookd/index.md b/website/uc-doc/api_sdk/rest_api/webhookd/index.md index 68d06a7f..083e5364 100644 --- a/website/uc-doc/api_sdk/rest_api/webhookd/index.md +++ b/website/uc-doc/api_sdk/rest_api/webhookd/index.md @@ -1,5 +1,6 @@ --- title: 'wazo-webhookd REST API' +sidebar_label: wazo-webhookd --- import CardList from '@site/src/components/Card/CardList'; diff --git a/website/uc-doc/api_sdk/rest_api/webhookd/templates.md b/website/uc-doc/api_sdk/rest_api/webhookd/templates.md index 88e063be..f1e70e13 100644 --- a/website/uc-doc/api_sdk/rest_api/webhookd/templates.md +++ b/website/uc-doc/api_sdk/rest_api/webhookd/templates.md @@ -1,5 +1,6 @@ --- title: 'wazo-webhookd HTTP templates' +sidebar_label: HTTP Templates --- When creating a webhook (i.e. a subscription), you can customize parts of the HTTP request that will @@ -18,15 +19,44 @@ The following parts of the request are templated: Given a subscription: -![](/images/uc-doc/api_sdk/rest_api/webhookd/template-subscription.png) +```js +{ + "name": "Hello subscription", + "service": "http", + "event": [ + "hello" + ], + "config": { + "content_type": "text/plain", + "method": "POST", + "url": "https://example.com/event_handler?v=1.0", + "body": "I just received an event named {{ event_name }}. from the Wazo server { wazo_uuid }}.\n\nhello = \"{{ event['hello'] }}\"" + } +} +``` When an event is emitted: -![](/images/uc-doc/api_sdk/rest_api/webhookd/template-event.png) +```js +{ + "name": "hello_event", + "origin_uuid": "my-wazo", + "data": [ + "hello": "world", + ], +} +``` Then a HTTP request is sent to `https://example.com`: -![](/images/uc-doc/api_sdk/rest_api/webhookd/template-request.png) +``` +POST /event_handler?v=1.0 +Content-Type: text/plain + +I just received an event named hello_event, from the Wazo server my-wazo. + +The event contained the following data: hello = "world" +``` ## Reference diff --git a/website/uc-doc/system/wazo-dird/configuration.md b/website/uc-doc/system/wazo-dird/configuration.md index 5048e97a..c863096c 100644 --- a/website/uc-doc/system/wazo-dird/configuration.md +++ b/website/uc-doc/system/wazo-dird/configuration.md @@ -1,5 +1,6 @@ --- -title: 'wazo-dird configuration' +title: 'wazo-dird Configuration' +sidebar_label: Configuration --- There are three sources of configuration for wazo-dird: From d8cfa5eda73576f4f31b69a8a681b7610be863a9 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Fri, 25 Oct 2024 15:26:35 -0400 Subject: [PATCH 08/22] docs(uc-doc): improve sidebar + move few archives --- website/redirects.ts | 16 ++++++++++ website/uc-doc/api_sdk/rest_api/acl.md | 3 +- website/uc-doc/api_sdk/rest_api/changelog.md | 30 +++++++++++-------- .../uc-doc/api_sdk/rest_api/confd/index.md | 3 +- .../uc-doc/api_sdk/rest_api/conventions.md | 3 +- website/uc-doc/api_sdk/rest_api/examples.md | 3 +- website/uc-doc/api_sdk/rest_api/index.md | 4 +-- website/uc-doc/api_sdk/rest_api/quickstart.md | 3 +- website/uc-doc/api_sdk/rest_api/reference.md | 3 +- .../uc-doc/api_sdk/rest_api/sysconfd/index.md | 3 +- .../api_sdk/rest_api/troubleshooting.md | 3 +- .../uc-doc/api_sdk/rest_api/webhookd/index.md | 3 +- website/uc-doc/attribution.md | 8 ----- website/uc-doc/changelog.md | 3 -- .../uc-doc/contributors/contributing_doc.md | 2 +- .../contributors/contributing_to_wazo.md | 2 +- website/uc-doc/contributors/guidelines.md | 2 +- .../uc-doc/contributors/integration-tests.md | 4 +++ website/uc-doc/contributors/translate.md | 2 +- website/uc-doc/ecosystem/index.md | 9 ++++-- website/uc-doc/index.md | 30 +++++++++++++++---- website/uc-doc/installation/index.md | 1 + website/uc-doc/introduction.md | 22 -------------- website/uc-doc/upgrade/index.md | 1 + website/uc-doc/upgrade/upgrade_notes.md | 5 ++++ .../upgrade/version_deprecation_policy.md | 2 +- website/uc-doc/upgrade/z_archives/index.md | 4 +++ .../{ => z_archives}/migrate_i386_to_amd64.md | 0 .../upgrade_from_wazo_18_03.md | 0 .../upgrade_notes.md} | 0 30 files changed, 97 insertions(+), 77 deletions(-) delete mode 100644 website/uc-doc/attribution.md delete mode 100644 website/uc-doc/changelog.md delete mode 100644 website/uc-doc/introduction.md create mode 100644 website/uc-doc/upgrade/z_archives/index.md rename website/uc-doc/upgrade/{ => z_archives}/migrate_i386_to_amd64.md (100%) rename website/uc-doc/upgrade/{ => z_archives}/upgrade_from_wazo_18_03.md (100%) rename website/uc-doc/upgrade/{old_upgrade_notes.md => z_archives/upgrade_notes.md} (100%) diff --git a/website/redirects.ts b/website/redirects.ts index dd30a263..ac09f557 100644 --- a/website/redirects.ts +++ b/website/redirects.ts @@ -60,6 +60,22 @@ const REDIRECTS: Options['redirects'] = [ from: '/uc-doc/system/wazo-dird/introduction', to: '/uc-doc/system/wazo-dird', }, + { + from: ['/uc-doc/introduction', '/uc-doc/attribution', '/uc-doc/changelog'], + to: '/uc-doc', + }, + { + from: '/uc-doc/upgrade/old_upgrade_notes', + to: '/uc-doc/upgrade/archives/upgrade_notes', + }, + { + from: '/uc-doc/upgrade/upgrade_from_wazo_18_03', + to: '/uc-doc/upgrade/archives/upgrade_from_wazo_18_03', + }, + { + from: '/uc-doc/upgrade/migrate_i386_to_amd64', + to: '/uc-doc/upgrade/archives/migrate_i386_to_amd64', + }, ]; export default REDIRECTS; diff --git a/website/uc-doc/api_sdk/rest_api/acl.md b/website/uc-doc/api_sdk/rest_api/acl.md index 1314536b..48ac7082 100644 --- a/website/uc-doc/api_sdk/rest_api/acl.md +++ b/website/uc-doc/api_sdk/rest_api/acl.md @@ -1,6 +1,5 @@ --- -title: REST API Permissions -sidebar_label: Permissions (ACLs) +title: Permissions (ACLs) --- The tokens delivered by [wazo-auth](/uc-doc/system/wazo-auth/introduction/) have a list of diff --git a/website/uc-doc/api_sdk/rest_api/changelog.md b/website/uc-doc/api_sdk/rest_api/changelog.md index 1dad1395..6a212e18 100644 --- a/website/uc-doc/api_sdk/rest_api/changelog.md +++ b/website/uc-doc/api_sdk/rest_api/changelog.md @@ -1,18 +1,24 @@ --- -title: REST API changelog -sidebar_label: Changelog +title: Changelog --- +import CardList from '@site/src/components/Card/CardList'; + The changelog of REST API can be found in [GitHub](https://github.com/wazo-platform) repository of each project: -- [wazo-agentd changelog](https://github.com/wazo-platform/wazo-agentd/blob/master/CHANGELOG.md) -- [wazo-auth changelog](https://github.com/wazo-platform/wazo-auth/blob/master/CHANGELOG.md) -- [wazo-call-logd changelog](https://github.com/wazo-platform/wazo-call-logd/blob/master/CHANGELOG.md) -- [wazo-calld changelog](https://github.com/wazo-platform/wazo-calld/blob/master/CHANGELOG.md) -- [wazo-chatd changelog](https://github.com/wazo-platform/wazo-chatd/blob/master/CHANGELOG.md) -- [wazo-confd changelog](https://github.com/wazo-platform/wazo-confd/blob/master/CHANGELOG.md) -- [wazo-dird changelog](https://github.com/wazo-platform/wazo-dird/blob/master/CHANGELOG.md) -- [wazo-plugind changelog](https://github.com/wazo-platform/wazo-plugind/blob/master/CHANGELOG.md) -- [wazo-setupd changelog](https://github.com/wazo-platform/wazo-setupd/blob/master/CHANGELOG.md) -- [wazo-webhookd changelog](https://github.com/wazo-platform/wazo-webhookd/blob/master/CHANGELOG.md) + + diff --git a/website/uc-doc/api_sdk/rest_api/confd/index.md b/website/uc-doc/api_sdk/rest_api/confd/index.md index b1c43470..b08c66ba 100644 --- a/website/uc-doc/api_sdk/rest_api/confd/index.md +++ b/website/uc-doc/api_sdk/rest_api/confd/index.md @@ -1,7 +1,6 @@ --- -title: wazo-confd REST API +title: wazo-confd subtitle: API reference -sidebar_label: wazo-confd --- import CardList from '@site/src/components/Card/CardList'; diff --git a/website/uc-doc/api_sdk/rest_api/conventions.md b/website/uc-doc/api_sdk/rest_api/conventions.md index f08e6e95..f98e4691 100644 --- a/website/uc-doc/api_sdk/rest_api/conventions.md +++ b/website/uc-doc/api_sdk/rest_api/conventions.md @@ -1,6 +1,5 @@ --- -title: REST API Conventions -sidebar_label: Conventions +title: Conventions --- ## Authentication {#rest-api-authentication} diff --git a/website/uc-doc/api_sdk/rest_api/examples.md b/website/uc-doc/api_sdk/rest_api/examples.md index d171ed3d..029ceea0 100644 --- a/website/uc-doc/api_sdk/rest_api/examples.md +++ b/website/uc-doc/api_sdk/rest_api/examples.md @@ -1,6 +1,5 @@ --- -title: REST API Examples -sidebar_label: Examples +title: Examples --- wazo-confd examples can be found [here](/documentation/api/configuration.html#rest-api-example). diff --git a/website/uc-doc/api_sdk/rest_api/index.md b/website/uc-doc/api_sdk/rest_api/index.md index cc25d09e..6b22300f 100644 --- a/website/uc-doc/api_sdk/rest_api/index.md +++ b/website/uc-doc/api_sdk/rest_api/index.md @@ -9,10 +9,10 @@ The Wazo REST APIs are the privileged way to programmatically interact with Wazo diff --git a/website/uc-doc/api_sdk/rest_api/quickstart.md b/website/uc-doc/api_sdk/rest_api/quickstart.md index da8bbd89..52cee578 100644 --- a/website/uc-doc/api_sdk/rest_api/quickstart.md +++ b/website/uc-doc/api_sdk/rest_api/quickstart.md @@ -1,6 +1,5 @@ --- -title: REST API Quickstart -sidebar_label: Quickstart +title: Quickstart --- ## Introduction diff --git a/website/uc-doc/api_sdk/rest_api/reference.md b/website/uc-doc/api_sdk/rest_api/reference.md index bad17c8b..4a6afc28 100644 --- a/website/uc-doc/api_sdk/rest_api/reference.md +++ b/website/uc-doc/api_sdk/rest_api/reference.md @@ -1,6 +1,5 @@ --- -title: REST API Reference -sidebar_label: Reference +title: Reference --- ## Access diff --git a/website/uc-doc/api_sdk/rest_api/sysconfd/index.md b/website/uc-doc/api_sdk/rest_api/sysconfd/index.md index da66f7c9..bc3f4ac3 100644 --- a/website/uc-doc/api_sdk/rest_api/sysconfd/index.md +++ b/website/uc-doc/api_sdk/rest_api/sysconfd/index.md @@ -1,6 +1,5 @@ --- -title: wazo-sysconfd REST API -sidebar_label: wazo-sysconfd +title: wazo-sysconfd --- import CardList from '@site/src/components/Card/CardList'; diff --git a/website/uc-doc/api_sdk/rest_api/troubleshooting.md b/website/uc-doc/api_sdk/rest_api/troubleshooting.md index 4f8eaf73..bfdc8a9f 100644 --- a/website/uc-doc/api_sdk/rest_api/troubleshooting.md +++ b/website/uc-doc/api_sdk/rest_api/troubleshooting.md @@ -1,6 +1,5 @@ --- -title: REST API Troubleshooting -sidebar_label: Troubleshooting +title: Troubleshooting --- Here is a list of common problems you can encounter with Wazo REST APIs. diff --git a/website/uc-doc/api_sdk/rest_api/webhookd/index.md b/website/uc-doc/api_sdk/rest_api/webhookd/index.md index 083e5364..2b249f1f 100644 --- a/website/uc-doc/api_sdk/rest_api/webhookd/index.md +++ b/website/uc-doc/api_sdk/rest_api/webhookd/index.md @@ -1,6 +1,5 @@ --- -title: 'wazo-webhookd REST API' -sidebar_label: wazo-webhookd +title: wazo-webhookd --- import CardList from '@site/src/components/Card/CardList'; diff --git a/website/uc-doc/attribution.md b/website/uc-doc/attribution.md deleted file mode 100644 index 88d4a67c..00000000 --- a/website/uc-doc/attribution.md +++ /dev/null @@ -1,8 +0,0 @@ ---- -title: Attribution Notice ---- - -The major part of this documentation has been copied (2016-11-25) from the XiVO documentation -(originally hosted at `http://documentation.xivo.io`). That documentation was licensed under the -[Create Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/) -and was Copyright 2012-2016 Avencall diff --git a/website/uc-doc/changelog.md b/website/uc-doc/changelog.md deleted file mode 100644 index c7003366..00000000 --- a/website/uc-doc/changelog.md +++ /dev/null @@ -1,3 +0,0 @@ ---- -title: Documentation changelog ---- diff --git a/website/uc-doc/contributors/contributing_doc.md b/website/uc-doc/contributors/contributing_doc.md index aad7cb28..fba6b3e2 100644 --- a/website/uc-doc/contributors/contributing_doc.md +++ b/website/uc-doc/contributors/contributing_doc.md @@ -1,5 +1,5 @@ --- -title: Contributing to the Documentation +title: Contribute to Documentation --- ## Documentation guideline {#documentation-guideline} diff --git a/website/uc-doc/contributors/contributing_to_wazo.md b/website/uc-doc/contributors/contributing_to_wazo.md index b3643e9c..0f2afcea 100644 --- a/website/uc-doc/contributors/contributing_to_wazo.md +++ b/website/uc-doc/contributors/contributing_to_wazo.md @@ -1,5 +1,5 @@ --- -title: How to contribute to the Wazo Platform +title: Contribute to Wazo Platform --- In order to contribute to the Wazo Platform you need to be able to retrieve the source code, edit diff --git a/website/uc-doc/contributors/guidelines.md b/website/uc-doc/contributors/guidelines.md index f451f99f..2d67f05f 100644 --- a/website/uc-doc/contributors/guidelines.md +++ b/website/uc-doc/contributors/guidelines.md @@ -1,5 +1,5 @@ --- -title: Wazo Guidelines +title: Our Guidelines --- ## Inter-process communication diff --git a/website/uc-doc/contributors/integration-tests.md b/website/uc-doc/contributors/integration-tests.md index 775aa80a..164a9fee 100644 --- a/website/uc-doc/contributors/integration-tests.md +++ b/website/uc-doc/contributors/integration-tests.md @@ -1,3 +1,7 @@ +--- +title: Integration Tests +--- + This document describes the conventional setup for per-component integration tests in wazo projects. ## Requirements diff --git a/website/uc-doc/contributors/translate.md b/website/uc-doc/contributors/translate.md index 8d88cfd7..474d334d 100644 --- a/website/uc-doc/contributors/translate.md +++ b/website/uc-doc/contributors/translate.md @@ -1,5 +1,5 @@ --- -title: Translating Wazo +title: Translate --- French and English are maintained by the Wazo authors. Other languages are provided by the diff --git a/website/uc-doc/ecosystem/index.md b/website/uc-doc/ecosystem/index.md index 2d7f331e..3611c857 100644 --- a/website/uc-doc/ecosystem/index.md +++ b/website/uc-doc/ecosystem/index.md @@ -2,5 +2,10 @@ title: Ecosystem --- - -- [Supported Devices](https://wazo-platform.org/uc-doc/ecosystem/supported_devices) +import CardList from '@site/src/components/Card/CardList'; + + diff --git a/website/uc-doc/index.md b/website/uc-doc/index.md index 1323164f..faa4bd94 100644 --- a/website/uc-doc/index.md +++ b/website/uc-doc/index.md @@ -1,14 +1,34 @@ --- -title: Wazo Documentation +title: Unified Communication Documentation +sidebar_label: Introduction +sidebar_position: 1 --- -Wazo is an application suite based on several free existing components including +Wazo Platform is an application suite based on several free existing components including [Asterisk](https://www.asterisk.org/), and our own developments to provide communication services (IPBX, Unified Messaging, ...) to businesses. -Wazo is a [free software](https://www.gnu.org/philosophy/free-sw.html). Most of its distinctive -components, and Wazo as a whole, are distributed under the _GPLv3 license_. +The platform released as a [free software](https://www.gnu.org/philosophy/free-sw.html). Most of its distinctive components, and Wazo Platform as a whole, are distributed under the _GPLv3 license_. You may also check the [Wazo blog](/blog) for more information. -See [Attribution Notice](/uc-doc/attribution/) +## Wazo History + +Wazo is a fork of XiVO, which was created in 2005 in France by Sylvain Boily and the company +Proformatique. In 2010, Proformatique merged with Avencall, and Avencall acquired the copyright and +trademark of XiVO. + +Sylvain then moved to Quebec City and founded Proformatique, Inc. where the XiVO core development +team worked from 2011 until November 2016. + +In November 2016, Proformatique Inc. was shut down and the development team +[forked XiVO to create Wazo](/blog/introducing-wazo). Its first release, Wazo 16.16, was released in +December 2016. + +:::note[Attribution Notice] +The major part of this documentation has been copied (2016-11-25) from the XiVO documentation +(originally hosted at `http://documentation.xivo.io`). That documentation was licensed under the +[Create Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/) +and was Copyright 2012-2016 Avencall +::: + diff --git a/website/uc-doc/installation/index.md b/website/uc-doc/installation/index.md index 5869ec84..d1420fd1 100644 --- a/website/uc-doc/installation/index.md +++ b/website/uc-doc/installation/index.md @@ -1,5 +1,6 @@ --- title: Installation +sidebar_position: 2 --- ## Requirements diff --git a/website/uc-doc/introduction.md b/website/uc-doc/introduction.md deleted file mode 100644 index 1cd2b462..00000000 --- a/website/uc-doc/introduction.md +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Introduction ---- - -Wazo Platform can be used to build a PABX application based on several free existing components -including Asterisk and our own developments. - -Wazo Platform is free software. Most of its distinctive components, and Wazo Platform as a whole, -are distributed under the GPLv3 license. - -## Wazo History - -Wazo is a fork of XiVO, which was created in 2005 in France by Sylvain Boily and the company -Proformatique. In 2010, Proformatique merged with Avencall, and Avencall acquired the copyright and -trademark of XiVO. - -Sylvain then moved to Quebec City and founded Proformatique, Inc. where the XiVO core development -team worked from 2011 until November 2016. - -In November 2016, Proformatique Inc. was shut down and the development team -[forked XiVO to create Wazo](/blog/introducing-wazo). Its first release, Wazo 16.16, was released in -December 2016. diff --git a/website/uc-doc/upgrade/index.md b/website/uc-doc/upgrade/index.md index 6febb3cc..1db60cac 100644 --- a/website/uc-doc/upgrade/index.md +++ b/website/uc-doc/upgrade/index.md @@ -1,5 +1,6 @@ --- title: Upgrading +sidebar_position: 3 --- Upgrading a Wazo is done by executing commands through a terminal on the server. You can connect to diff --git a/website/uc-doc/upgrade/upgrade_notes.md b/website/uc-doc/upgrade/upgrade_notes.md index 89e00e7c..33397464 100644 --- a/website/uc-doc/upgrade/upgrade_notes.md +++ b/website/uc-doc/upgrade/upgrade_notes.md @@ -1,5 +1,6 @@ --- title: Upgrade notes +sidebar_position: 3 --- ## 24.15 {#24-15} @@ -15,6 +16,10 @@ for more information. packaging. If you have any issues with file permissions, it is still possible to run it manually by executing `xivo-fix-paths-rights`. +Consult the +[24.14 Tickets](https://wazo-dev.atlassian.net/issues/?jql=project%20%3D%20WAZO%20AND%20fixVersion%20%3D%2024.14) +for more information. + ## 24.13 {#24-13} Consult the diff --git a/website/uc-doc/upgrade/version_deprecation_policy.md b/website/uc-doc/upgrade/version_deprecation_policy.md index b633297f..ce6cb784 100644 --- a/website/uc-doc/upgrade/version_deprecation_policy.md +++ b/website/uc-doc/upgrade/version_deprecation_policy.md @@ -1,5 +1,5 @@ --- -title: Deprecated Wazo versions +title: Deprecated Versions Policy --- ## General policy diff --git a/website/uc-doc/upgrade/z_archives/index.md b/website/uc-doc/upgrade/z_archives/index.md new file mode 100644 index 00000000..614c1b98 --- /dev/null +++ b/website/uc-doc/upgrade/z_archives/index.md @@ -0,0 +1,4 @@ +--- +title: Old Archives +slug: /archives +--- diff --git a/website/uc-doc/upgrade/migrate_i386_to_amd64.md b/website/uc-doc/upgrade/z_archives/migrate_i386_to_amd64.md similarity index 100% rename from website/uc-doc/upgrade/migrate_i386_to_amd64.md rename to website/uc-doc/upgrade/z_archives/migrate_i386_to_amd64.md diff --git a/website/uc-doc/upgrade/upgrade_from_wazo_18_03.md b/website/uc-doc/upgrade/z_archives/upgrade_from_wazo_18_03.md similarity index 100% rename from website/uc-doc/upgrade/upgrade_from_wazo_18_03.md rename to website/uc-doc/upgrade/z_archives/upgrade_from_wazo_18_03.md diff --git a/website/uc-doc/upgrade/old_upgrade_notes.md b/website/uc-doc/upgrade/z_archives/upgrade_notes.md similarity index 100% rename from website/uc-doc/upgrade/old_upgrade_notes.md rename to website/uc-doc/upgrade/z_archives/upgrade_notes.md From 22ee82b419794f0f09a0e8ca859832d6d92f92f9 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Mon, 28 Oct 2024 15:10:51 -0400 Subject: [PATCH 09/22] chore(uc-doc): keep content sync with old version --- .gitignore | 1 + scripts/beta-sync.sh | 38 ++++++++++++++++++++++++++++++++------ 2 files changed, 33 insertions(+), 6 deletions(-) diff --git a/.gitignore b/.gitignore index 61d2e695..4827b8ce 100644 --- a/.gitignore +++ b/.gitignore @@ -60,6 +60,7 @@ public config.js config-wazo.js content/blog/* +content/uc-doc/* # Mac files .DS_Store diff --git a/scripts/beta-sync.sh b/scripts/beta-sync.sh index d361915c..050c084d 100644 --- a/scripts/beta-sync.sh +++ b/scripts/beta-sync.sh @@ -1,12 +1,6 @@ #!/bin/bash # Goal: Temporary script that copy beta content to old website until migration will be done -# 1. Sync release note & blog posts -echo "🔃 Sync release note & blog posts from docusaurus\n" -rm -r content/blog || true -mkdir content/blog || true -cp website/release-notes/*.md website/blog/*.md content/blog/ - if [[ "$OSTYPE" == "darwin"* ]]; then # macOS sed_cmd="sed -i ''" @@ -15,6 +9,13 @@ else sed_cmd="sed -i" fi +# 1. Sync release note & blog posts +echo "🔃 Sync release note & blog posts from docusaurus\n" +rm -r content/blog || true +mkdir content/blog || true +cp website/release-notes/*.md website/blog/*.md content/blog/ + + # Modify author format $sed_cmd 's/authors: /author: /g' content/blog/*.md $sed_cmd 's/author: \[\(.*\)\]/author: \1/g' content/blog/*.md @@ -22,3 +23,28 @@ $sed_cmd 's/author: \[\(.*\)\]/author: \1/g' content/blog/*.md $sed_cmd 's/tags: \[\(.*\)\]/tags: \1/g' content/blog/*.md # Update image source URLs $sed_cmd 's|../static|https://beta.wazo-platform.org|g' content/blog/*.md + +# 2. Sync uc-doc +echo "🔃 Sync uc-doc\n" +rm -r content/uc-doc || true +mkdir content/uc-doc || true +cp -R website/uc-doc/** content/uc-doc + +cardListFiles=$(grep -rl "import CardList" content/uc-doc/**) + +for file in $cardListFiles; do + # Cleanup MDX component + $sed_cmd \ + -e "s/import CardList from '@site\/src\/components\/Card\/CardList';//g" \ + -e "s///g" \ + "$file" + + # Convert items to markdown list of link + $sed_cmd "s/.*text: '\([^']*\)',.*'\([^']*\)'.*/- [\1](\2)/g" "$file" +done + + + From 1a0a13ee54da259ef6e0dc8c4a521940f91bbbd9 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Mon, 11 Nov 2024 14:37:03 -0500 Subject: [PATCH 10/22] style(gastby): make parent element of table of content clickable --- src/component/uc-doc/TableOfContents.js | 10 +++++++++- src/component/use-cases/index.js | 2 +- src/styles/platform/styles.scss | 19 +++++++++++++------ 3 files changed, 23 insertions(+), 8 deletions(-) diff --git a/src/component/uc-doc/TableOfContents.js b/src/component/uc-doc/TableOfContents.js index bbf4e9b5..f8c60ff9 100644 --- a/src/component/uc-doc/TableOfContents.js +++ b/src/component/uc-doc/TableOfContents.js @@ -1,3 +1,4 @@ +/* eslint-disable jsx-a11y/click-events-have-key-events, jsx-a11y/no-static-element-interactions */ import React, { useEffect, useState } from 'react'; import { Link } from "gatsby" @@ -79,6 +80,10 @@ const Page = () => { const renderLoading = () =>

Loading ...

const renderLinksRecurse = (linksObject) => { + if(!linksObject) { + return; + } + const subLinksKeys = Object.keys(linksObject); let itemKey; @@ -105,7 +110,10 @@ const Page = () => { return (
  • - handleMenuClick(e, itemKey)}>{ self ? formatLinkTitle(self.title) : 'More' } + + { self ? formatLinkTitle(self.title) : 'More' } + handleMenuClick(e, itemKey)} className="secondary-navigation-submenu-icon"> +
      { titlesSortedKeys.map(subLinksKey => renderLinksRecurse(linksObject[subLinksKey])) }
    diff --git a/src/component/use-cases/index.js b/src/component/use-cases/index.js index 7200b8fb..203b0bfc 100644 --- a/src/component/use-cases/index.js +++ b/src/component/use-cases/index.js @@ -48,7 +48,7 @@ const Page = ({ pageContext: { installDoc } }) => ( icon="fa fa-phone" introduction="Audio calls, video calls, chat, call centers, conferences, voicemail and more." links={[ - { to: '/uc-doc/installation/install-system', text: 'Install Procedure' }, + { to: '/uc-doc/installation', text: 'Install Procedure' }, { to: '/uc-doc/', text: 'Documentation' }, ]} /> diff --git a/src/styles/platform/styles.scss b/src/styles/platform/styles.scss index ae631a56..2467fdb9 100644 --- a/src/styles/platform/styles.scss +++ b/src/styles/platform/styles.scss @@ -846,7 +846,8 @@ body.documentation { } > a { color: #085b77; - &:after { + .secondary-navigation-submenu-icon { + opacity: 1; transform: translate(0, -50%) rotate(180deg); } } @@ -862,17 +863,23 @@ body.documentation { position: relative; display: block; - &:after { + .secondary-navigation-submenu-icon { + transition: 250ms ease opacity; content: ''; - background: url(/images/icons/chevron-down-solid.svg) top left no-repeat; - background-size: contain; + background: url(/images/icons/chevron-down-solid.svg) center no-repeat; + background-size: 14px 14px; display: block; - width: 10px; - height: 10px; + width: 20px; + height: 20px; position: absolute; right: 10px; top: 50%; transform: translate(0, -50%); + opacity: 0.4; + + &:hover, &:active { + opacity: 1; + } } } } From 079d59e50dcf7316d68e345e206addc5b10ef31b Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Mon, 11 Nov 2024 16:10:18 -0500 Subject: [PATCH 11/22] refactor(gatsby): also apply redirect to old website --- gatsby-node.js => gatsby-node.ts | 46 +++++++++++++++++--------------- 1 file changed, 25 insertions(+), 21 deletions(-) rename gatsby-node.js => gatsby-node.ts (95%) diff --git a/gatsby-node.js b/gatsby-node.ts similarity index 95% rename from gatsby-node.js rename to gatsby-node.ts index 0e7d9376..47493032 100644 --- a/gatsby-node.js +++ b/gatsby-node.ts @@ -7,6 +7,7 @@ const algoliasearch = require('algoliasearch'); const striptags = require('striptags'); const RSS = require('rss'); +const redirects = require('./website/redirects') const config = require('./config'); const constants = require('./src/contants'); @@ -537,37 +538,40 @@ exports.createPages = async ({ graphql, actions: { createPage, createRedirect } // Generate redirect 301 // --------- console.log('Generating 301 redirects'); + const generate301 = (fromPath, toPath) => { + const enhancedFromPath = fromPath.endsWith('.html') ? fromPath : fromPath.endsWith('/') ? fromPath : `${fromPath}/` + + createRedirect({ + fromPath: enhancedFromPath, + isPermanent: true, + redirectInBrowser: true, + toPath, + }); + } + if (corporate) { ['/api/nestbox-deployd.html', '/documentation/api/nestbox-deployd.html'].forEach((fromPath) => { - newPage(fromPath, '404', {}); - createRedirect({ - fromPath, - isPermanent: true, - redirectInBrowser: true, - toPath: `/documentation/api/euc-deployd.html`, - }); + generate301(fromPath, '/documentation/api/euc-deployd.html'); }); ['/api/nestbox-configuration.html', '/documentation/api/nestbox-configuration.html'].forEach((fromPath) => { - newPage(fromPath, '404', {}); - createRedirect({ - fromPath, - isPermanent: true, - redirectInBrowser: true, - toPath: `/documentation/api/euc-configuration.html`, - }); + generate301(fromPath, '/documentation/api/euc-configuration.html'); }); ['/api/nestbox-authentication.html', '/documentation/api/nestbox-authentication.html'].forEach((fromPath) => { - newPage(fromPath, '404', {}); - createRedirect({ - fromPath, - isPermanent: true, - redirectInBrowser: true, - toPath: `/documentation/api/euc-authentication.html`, - }); + generate301(fromPath, '/documentation/api/euc-authentication.html'); }); } + + redirects.default.forEach(redirect => { + if(Array.isArray(redirect.from)) { + redirect.from.forEach(from => { + generate301(from, redirect.to) + }) + }else{ + generate301(redirect.from, redirect.to) + } + }) }; exports.onCreateWebpackConfig = ({ actions }) => { From 2231234daae440849d6a27bd4f45466c9e52ecb8 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Tue, 12 Nov 2024 10:41:41 -0500 Subject: [PATCH 12/22] style: add uc-doc to header --- website/docusaurus.config.ts | 11 ++++++++--- website/sidebars.ts | 16 +++++----------- 2 files changed, 13 insertions(+), 14 deletions(-) diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index c18759e6..257b1727 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -69,10 +69,15 @@ const config: Config = { }, items: [ { - type: 'docSidebar', - sidebarId: 'docsSidebar', + type: 'dropdown', + label: 'Documentation', position: 'left', - label: 'Docs', + to: '/docs/intro', + items: [ + { to: '/docs/intro', label: 'Introduction' }, + { to: '/uc-doc', label: 'UC Documentation' }, + { to: '/docs/category/api', label: 'API Documentation' }, + ], }, { to: '/blog', label: 'Blog', position: 'left' }, { to: '/release-notes', label: 'Release notes', position: 'left' }, diff --git a/website/sidebars.ts b/website/sidebars.ts index 794b9672..269e28ac 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -12,20 +12,14 @@ import type { SidebarsConfig } from '@docusaurus/plugin-content-docs'; */ const sidebars: SidebarsConfig = { // By default, Docusaurus generates a sidebar from the docs folder structure - docsSidebar: [{ type: 'autogenerated', dirName: '.' }], - - // But you can create a sidebar manually - /* - tutorialSidebar: [ - 'intro', - 'hello', + docsSidebar: [ + { type: 'autogenerated', dirName: '.' }, { - type: 'category', - label: 'Tutorial', - items: ['tutorial-basics/create-a-document'], + type: 'link', + href: '/uc-doc', + label: 'UC Documentation' }, ], - */ }; export default sidebars; From adc9362a032f59d5e420e73b64eb68072ca2a2c5 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Tue, 12 Nov 2024 13:51:38 -0500 Subject: [PATCH 13/22] build(docusaurus): add volumes for uc-doc folder --- docker-compose.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/docker-compose.yml b/docker-compose.yml index 6131ba7c..0e18842f 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -10,6 +10,7 @@ services: - ./content:/app/content - ./website/release-notes:/app/website/release-notes:ro - ./website/blog:/app/website/blog:ro + - ./website/uc-doc:/app/website/uc-doc:ro - ./.prettierrc:/app/.prettierrc:ro - ./static:/app/static:ro - ./gatsby-node.js:/app/gatsby-node.js:ro From 8d0eedab9f5b868d65ff6cd01c91b9766cccb7b4 Mon Sep 17 00:00:00 2001 From: Jerome Date: Tue, 12 Nov 2024 15:27:35 -0500 Subject: [PATCH 14/22] fix: md syntax --- website/uc-doc/system/service_authentication/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/uc-doc/system/service_authentication/index.md b/website/uc-doc/system/service_authentication/index.md index 794be75e..edc27f1c 100644 --- a/website/uc-doc/system/service_authentication/index.md +++ b/website/uc-doc/system/service_authentication/index.md @@ -21,7 +21,7 @@ Here is the call flow to access a REST resource of a Wazo service: **service**: Service who needs to access a REST resource. -**wazo-{daemon}**: Server that exposes a REST resource. This resource must have an attached ACL. +**wazo-daemon**: Server that exposes a REST resource. This resource must have an attached ACL. **wazo-auth**: Server that authenticates the Service and validates the required ACL with the token. From fc60ea102b459cd29cffd1cebea58b5170ee15bb Mon Sep 17 00:00:00 2001 From: Jerome Date: Tue, 12 Nov 2024 15:39:52 -0500 Subject: [PATCH 15/22] fix: redirects --- website/uc-doc/upgrade/archives/index.md | 5 +++++ .../{z_archives => archives}/migrate_i386_to_amd64.md | 0 .../{z_archives => archives}/upgrade_from_wazo_18_03.md | 0 .../uc-doc/upgrade/{z_archives => archives}/upgrade_notes.md | 0 website/uc-doc/upgrade/upgrade_notes.md | 2 +- website/uc-doc/upgrade/upgrade_notes_details/index.md | 1 + website/uc-doc/upgrade/upgrade_specific_version/index.md | 1 + website/uc-doc/upgrade/version_deprecation_policy.md | 1 + website/uc-doc/upgrade/z_archives/index.md | 4 ---- 9 files changed, 9 insertions(+), 5 deletions(-) create mode 100644 website/uc-doc/upgrade/archives/index.md rename website/uc-doc/upgrade/{z_archives => archives}/migrate_i386_to_amd64.md (100%) rename website/uc-doc/upgrade/{z_archives => archives}/upgrade_from_wazo_18_03.md (100%) rename website/uc-doc/upgrade/{z_archives => archives}/upgrade_notes.md (100%) delete mode 100644 website/uc-doc/upgrade/z_archives/index.md diff --git a/website/uc-doc/upgrade/archives/index.md b/website/uc-doc/upgrade/archives/index.md new file mode 100644 index 00000000..2fb551bb --- /dev/null +++ b/website/uc-doc/upgrade/archives/index.md @@ -0,0 +1,5 @@ +--- +title: Archives +slug: /archives +sidebar_position: 5 +--- diff --git a/website/uc-doc/upgrade/z_archives/migrate_i386_to_amd64.md b/website/uc-doc/upgrade/archives/migrate_i386_to_amd64.md similarity index 100% rename from website/uc-doc/upgrade/z_archives/migrate_i386_to_amd64.md rename to website/uc-doc/upgrade/archives/migrate_i386_to_amd64.md diff --git a/website/uc-doc/upgrade/z_archives/upgrade_from_wazo_18_03.md b/website/uc-doc/upgrade/archives/upgrade_from_wazo_18_03.md similarity index 100% rename from website/uc-doc/upgrade/z_archives/upgrade_from_wazo_18_03.md rename to website/uc-doc/upgrade/archives/upgrade_from_wazo_18_03.md diff --git a/website/uc-doc/upgrade/z_archives/upgrade_notes.md b/website/uc-doc/upgrade/archives/upgrade_notes.md similarity index 100% rename from website/uc-doc/upgrade/z_archives/upgrade_notes.md rename to website/uc-doc/upgrade/archives/upgrade_notes.md diff --git a/website/uc-doc/upgrade/upgrade_notes.md b/website/uc-doc/upgrade/upgrade_notes.md index 33397464..8b99fae4 100644 --- a/website/uc-doc/upgrade/upgrade_notes.md +++ b/website/uc-doc/upgrade/upgrade_notes.md @@ -1,6 +1,6 @@ --- title: Upgrade notes -sidebar_position: 3 +sidebar_position: 1 --- ## 24.15 {#24-15} diff --git a/website/uc-doc/upgrade/upgrade_notes_details/index.md b/website/uc-doc/upgrade/upgrade_notes_details/index.md index 45735125..6c889334 100644 --- a/website/uc-doc/upgrade/upgrade_notes_details/index.md +++ b/website/uc-doc/upgrade/upgrade_notes_details/index.md @@ -1,3 +1,4 @@ --- title: Upgrade notes (Versions details) +sidebar_position: 2 --- diff --git a/website/uc-doc/upgrade/upgrade_specific_version/index.md b/website/uc-doc/upgrade/upgrade_specific_version/index.md index 1d23a662..7fe0e625 100644 --- a/website/uc-doc/upgrade/upgrade_specific_version/index.md +++ b/website/uc-doc/upgrade/upgrade_specific_version/index.md @@ -1,5 +1,6 @@ --- title: Upgrade to a specific version +sidebar_position: 3 --- ## What is the point? diff --git a/website/uc-doc/upgrade/version_deprecation_policy.md b/website/uc-doc/upgrade/version_deprecation_policy.md index ce6cb784..5f2e213d 100644 --- a/website/uc-doc/upgrade/version_deprecation_policy.md +++ b/website/uc-doc/upgrade/version_deprecation_policy.md @@ -1,5 +1,6 @@ --- title: Deprecated Versions Policy +sidebar_position: 4 --- ## General policy diff --git a/website/uc-doc/upgrade/z_archives/index.md b/website/uc-doc/upgrade/z_archives/index.md deleted file mode 100644 index 614c1b98..00000000 --- a/website/uc-doc/upgrade/z_archives/index.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Old Archives -slug: /archives ---- From b159c7cac0c6ebf7139002528862159a22bbce81 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Tue, 12 Nov 2024 15:38:23 -0500 Subject: [PATCH 16/22] build: upgrade linter --- .prettierignore | 12 ++++++++++++ biome.json | 2 +- package.json | 6 +++--- yarn.lock | 8 ++++---- 4 files changed, 20 insertions(+), 8 deletions(-) create mode 100644 .prettierignore diff --git a/.prettierignore b/.prettierignore new file mode 100644 index 00000000..d48e9280 --- /dev/null +++ b/.prettierignore @@ -0,0 +1,12 @@ +# Files with docusaurus MDX +website/uc-doc/system/index.md +website/uc-doc/ecosystem/index.md +website/uc-doc/contributors/provisioning/index.md +website/uc-doc/contributors/index.md +website/uc-doc/contact_center/index.md +website/uc-doc/api_sdk/rest_api/webhookd/index.md +website/uc-doc/api_sdk/rest_api/sysconfd/index.md +website/uc-doc/api_sdk/rest_api/index.md +website/uc-doc/api_sdk/rest_api/confd/index.md +website/uc-doc/api_sdk/rest_api/changelog.md +website/uc-doc/api_sdk/index.md diff --git a/biome.json b/biome.json index 5d6bf192..0fabfff7 100644 --- a/biome.json +++ b/biome.json @@ -1,7 +1,7 @@ { "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json", "files": { - "ignore": ["static/**/*", ".docusaurus/**/*", "package.json"] + "ignore": ["static/**/*", ".docusaurus/**/*", "package.json", "build"] }, "organizeImports": { "enabled": true diff --git a/package.json b/package.json index da549d48..d5ea90c5 100644 --- a/package.json +++ b/package.json @@ -8,8 +8,8 @@ "build": "yarn beta-sync && ./node_modules/.bin/gatsby build --prefix-paths", "develop": "yarn beta-sync && ./node_modules/.bin/gatsby develop", "format": "prettier --write 'src/**/*.{js,jsx}' 'tests/src/*.js' 'gatsby-node.js'", - "format:uc-doc": "prettier --print-width 100 --prose-wrap always --write 'content/uc-doc/**/*.md'", - "check-format:uc-doc": "prettier --check --print-width 100 --prose-wrap always 'content/uc-doc/**/*.md'", + "format:uc-doc": "prettier --print-width 100 --prose-wrap always --write 'website/uc-doc/**/*.md'", + "check-format:uc-doc": "prettier --check --print-width 100 --prose-wrap always 'website/uc-doc/**/*.md'", "beta-sync": "sh ./scripts/beta-sync.sh", "start": "npm run develop", "serve": "./node_modules/.bin/gatsby serve" @@ -49,7 +49,7 @@ "devDependencies": { "dart-sass": "^1.25.0", "gatsby-plugin-sass": "^5.18.1", - "prettier": "^2.7.1" + "prettier": "^3.3.3" }, "repository": { "type": "git", diff --git a/yarn.lock b/yarn.lock index d69f16bd..13504893 100644 --- a/yarn.lock +++ b/yarn.lock @@ -9435,10 +9435,10 @@ prepend-http@^2.0.0: resolved "https://registry.yarnpkg.com/prepend-http/-/prepend-http-2.0.0.tgz#e92434bfa5ea8c19f41cdfd401d741a3c819d897" integrity sha512-ravE6m9Atw9Z/jjttRUZ+clIXogdghyZAuWJ3qEzjT+jI/dL1ifAqhZeC5VHzQp1MSt1+jxKkFNemj/iO7tVUA== -prettier@^2.7.1: - version "2.8.0" - resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.8.0.tgz#c7df58393c9ba77d6fba3921ae01faf994fb9dc9" - integrity sha512-9Lmg8hTFZKG0Asr/kW9Bp8tJjRVluO8EJQVfY2T7FMw9T5jy4I/Uvx0Rca/XWf50QQ1/SS48+6IJWnrb+2yemA== +prettier@^3.3.3: + version "3.3.3" + resolved "https://registry.yarnpkg.com/prettier/-/prettier-3.3.3.tgz#30c54fe0be0d8d12e6ae61dbb10109ea00d53105" + integrity sha512-i2tDNA0O5IrMO757lfrdQZCc2jPNDVntV0m/+4whiDfWaTKfMNgR7Qz0NAeGz/nRqF4m5/6CLzbP4/liHt12Ew== pretty-bytes@^5.4.1: version "5.6.0" From e7e5bf5391c052e62f9268cbea9f0c3cb471053c Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Tue, 12 Nov 2024 15:38:33 -0500 Subject: [PATCH 17/22] style: lint markdown files --- .github/workflows/test-deploy.yml | 1 + website/sidebars.ts | 2 +- website/uc-doc/administration/call_policy.md | 14 ++-- .../uc-doc/administration/sip_templates.md | 6 +- website/uc-doc/api_sdk/message_bus.md | 4 +- .../api_sdk/mobile_push_notification.md | 65 ++++++++----------- website/uc-doc/api_sdk/rest_api/acl.md | 5 +- website/uc-doc/api_sdk/rest_api/quickstart.md | 6 +- website/uc-doc/api_sdk/websocket.md | 2 +- .../uc-doc/contributors/contributing_doc.md | 3 +- .../contributors/generate_custom_prompts.md | 4 +- website/uc-doc/high_availability/index.md | 1 - website/uc-doc/index.md | 14 ++-- website/uc-doc/installation/index.md | 3 +- website/uc-doc/system/network/index.md | 6 +- .../uc-doc/system/wazo-dird/stock_plugins.md | 3 +- website/uc-doc/system/wazo-webhookd/index.md | 17 +++-- 17 files changed, 73 insertions(+), 83 deletions(-) diff --git a/.github/workflows/test-deploy.yml b/.github/workflows/test-deploy.yml index f5d73d5d..0652f3d0 100644 --- a/.github/workflows/test-deploy.yml +++ b/.github/workflows/test-deploy.yml @@ -23,4 +23,5 @@ jobs: corepack enable cd website yarn install --immutable + yarn lint yarn build diff --git a/website/sidebars.ts b/website/sidebars.ts index 269e28ac..c30ac2e5 100644 --- a/website/sidebars.ts +++ b/website/sidebars.ts @@ -17,7 +17,7 @@ const sidebars: SidebarsConfig = { { type: 'link', href: '/uc-doc', - label: 'UC Documentation' + label: 'UC Documentation', }, ], }; diff --git a/website/uc-doc/administration/call_policy.md b/website/uc-doc/administration/call_policy.md index a2ce306a..77737183 100644 --- a/website/uc-doc/administration/call_policy.md +++ b/website/uc-doc/administration/call_policy.md @@ -34,16 +34,14 @@ endpoints configuration. SIP endpoint options can be configured in two ways: -1. through SIP templates, which can be applied to all or a subset of SIP endpoints in a tenant; - each tenant has a `global` SIP template which represent common options which can apply to all SIP - endpoints. Other templates can specify options for a specific subset of SIP endpoints. - See [SIP templates documentation](/uc-doc/administration/sip_templates) for information on how to +1. through SIP templates, which can be applied to all or a subset of SIP endpoints in a tenant; each + tenant has a `global` SIP template which represent common options which can apply to all SIP + endpoints. Other templates can specify options for a specific subset of SIP endpoints. See + [SIP templates documentation](/uc-doc/administration/sip_templates) for information on how to query and configure SIP templates. -2. directly through a SIP endpoint's individual configuration; - individual endpoint configuration can be changed through the - `/api/confd/1.1/endpoints/sip/{sip_uuid}` REST API endpoint. - See +2. directly through a SIP endpoint's individual configuration; individual endpoint configuration can + be changed through the `/api/confd/1.1/endpoints/sip/{sip_uuid}` REST API endpoint. See [API reference](/documentation/api/configuration.html#tag/endpoints/operation/update_endpoint_sip) for details. diff --git a/website/uc-doc/administration/sip_templates.md b/website/uc-doc/administration/sip_templates.md index 71dc24de..9c349a95 100644 --- a/website/uc-doc/administration/sip_templates.md +++ b/website/uc-doc/administration/sip_templates.md @@ -8,9 +8,9 @@ of the Wazo platform. Those templates form a multiple-inheritance hierarchy, such that a template can inherit from parent templates, including all options defined in those parent templates while overriding, removing or -adding some options. -This results in a powerful way to configure different classes of SIP devices(hardware phones or -softphones) and support various specific scenarios which require specific configuration. +adding some options. This results in a powerful way to configure different classes of SIP +devices(hardware phones or softphones) and support various specific scenarios which require specific +configuration. The SIP template API is part of the `wazo-confd` component. diff --git a/website/uc-doc/api_sdk/message_bus.md b/website/uc-doc/api_sdk/message_bus.md index ef96ab86..1e98e7b0 100644 --- a/website/uc-doc/api_sdk/message_bus.md +++ b/website/uc-doc/api_sdk/message_bus.md @@ -776,8 +776,8 @@ Those events are published during the different steps of a relocate operation. - headers: - `"user_uuid:XXX": true` where `XXX` is the initiator's user UUID - required ACL: `events.relocates.XXX` where `XXX` is the initiator's user UUID -- event specific data: a relocate object, see [Documentation](https://wazo-platform.org/documentation), section - `wazo-calld`. +- event specific data: a relocate object, see + [Documentation](https://wazo-platform.org/documentation), section `wazo-calld`. Example: diff --git a/website/uc-doc/api_sdk/mobile_push_notification.md b/website/uc-doc/api_sdk/mobile_push_notification.md index 32b65819..fda26c6e 100644 --- a/website/uc-doc/api_sdk/mobile_push_notification.md +++ b/website/uc-doc/api_sdk/mobile_push_notification.md @@ -23,73 +23,64 @@ API v1, deprecating support for legacy APIs. The configuration procedure is as follow: -1. **create a Firebase project and enable Firebase Cloud Messaging API support** - To support relaying notifications to Android mobile users through FCM service, one must first - have an active Firebase project account with Firebase Cloud Messaging support enabled for that - FCM project. - See [Official Firebase documentation](https://firebase.google.com/docs/web/setup/#create-project) - for more information. -2. **create a service account in the Firebase project** - With a Firebase project account and FCM API enabled, a service account must be created in the - project; That service account will be used by Wazo to authenticate to Firebase APIs. - See +1. **create a Firebase project and enable Firebase Cloud Messaging API support** To support relaying + notifications to Android mobile users through FCM service, one must first have an active Firebase + project account with Firebase Cloud Messaging support enabled for that FCM project. See + [Official Firebase documentation](https://firebase.google.com/docs/web/setup/#create-project) for + more information. +2. **create a service account in the Firebase project** With a Firebase project account and FCM API + enabled, a service account must be created in the project; That service account will be used by + Wazo to authenticate to Firebase APIs. See [Google Cloud service account documentation](https://cloud.google.com/iam/docs/service-accounts-create?hl=en) for more information; 3. **download the service account JSON credentials file** A JSON file containing the service account - credentials can be downloaded from the Firebase console; - See + credentials can be downloaded from the Firebase console; See [Firebase documentation](https://firebase.google.com/docs/admin/setup#initialize_the_sdk_in_non-google_environments). 4. **create or update the external mobile config in wazo-auth, providing the content of the - downloaded service account credentials** - Using the wazo-auth REST API, the endpoint `/0.1/external/mobile/config` is used to manage the - configuration for mobile push notifications support; + downloaded service account credentials** Using the wazo-auth REST API, the endpoint + `/0.1/external/mobile/config` is used to manage the configuration for mobile push notifications + support; - `POST` on that endpoint will create a fresh configuration if none exist, and `PUT` will allow updating the fields of that configuration; - the `fcm_service_account_info` field must be filled with the content of the downloaded JSON file from step 3 (as a JSON string); - the `fcm_sender_id` is also required and should be the FCM project number assigned to the - project, as shown in the Firebase console; - see the + project, as shown in the Firebase console; see the [API reference](/documentation/api/authentication.html#tag/external/paths/~1external~1%7Bauth_type%7D~1config/post) for more details on that endpoint. ### Configuring APNS support To support push notifications to iOS devices, the requirements and procedure are similar to FCM -support. An Apple developer account is required. -This account is used to register an Apple app (the mobile client), which support push +support. An Apple developer account is required. This account is used to register an Apple app (the +mobile client), which support push notifications. A certificate is generated for that app, and is +provided to the Wazo Platform stack for authentication to APNS when delivering the push notifications. -A certificate is generated for that app, and is provided to the Wazo Platform stack for -authentication to APNS when delivering the push notifications. -1. **Enroll in the Apple developer program** - To provide push notifications to a mobile client on an iOS device, an Apple developer account is - required See +1. **Enroll in the Apple developer program** To provide push notifications to a mobile client on an + iOS device, an Apple developer account is required See [Apple documentation](https://developer.apple.com/support/app-account/#organization); -2. **Register an app** - An app corresponding to the iOS mobile client should be registered -3. **Enable push notification support for the app** - Push notifications through APNS must be enabled for the registered app; See +2. **Register an app** An app corresponding to the iOS mobile client should be registered +3. **Enable push notification support for the app** Push notifications through APNS must be enabled + for the registered app; See [Apple documentation](https://developer.apple.com/documentation/usernotifications/registering-your-app-with-apns); -4. **Generate certificates for the app** - A VoIP services certificate tied to the registered Apple app must be generated to secure the - connection between the Wazo Platform stack and the APNS servers; - See +4. **Generate certificates for the app** A VoIP services certificate tied to the registered Apple + app must be generated to secure the connection between the Wazo Platform stack and the APNS + servers; See [Apple documentation on this subject](https://developer.apple.com/documentation/usernotifications/establishing-a-certificate-based-connection-to-apns); See also [more Apple documentation on creating a certificate for your Apple app](https://developer.apple.com/help/account/create-certificates/create-voip-services-certificates) 5. **Create or update the external mobile config in wazo-auth, providing the certificate content** An external credential configuration of type `mobile` must be created in the Wazo Platform stack, - through which the previously generated certificate can be provided. - In the **wazo-auth** REST API, the endpoint `/0.1/external/mobile/config` is used to manage the - configuration for mobile push notifications support; + through which the previously generated certificate can be provided. In the **wazo-auth** REST + API, the endpoint `/0.1/external/mobile/config` is used to manage the configuration for mobile + push notifications support; - `POST` on that endpoint will create a fresh configuration if none exist, and `PUT` will allow updating the fields of that configuration; - the `ios_apn_certificate` field must be filled with the content of the public part of the certificate created in step 4; - the `ios_apn_private` field must be filled with the certificate signing request created in step - 4; - see the + 4; see the [API reference](/documentation/api/authentication.html#tag/external/paths/~1external~1%7Bauth_type%7D~1config/post) for more details on that endpoint. diff --git a/website/uc-doc/api_sdk/rest_api/acl.md b/website/uc-doc/api_sdk/rest_api/acl.md index 48ac7082..14429e9c 100644 --- a/website/uc-doc/api_sdk/rest_api/acl.md +++ b/website/uc-doc/api_sdk/rest_api/acl.md @@ -63,5 +63,6 @@ Where `{user_id}` is the user uuid from the token. ## Available ACLs -The ACL corresponding to each resource is documented in [auth.wazo.community](https://auth.wazo.community). Some -resources may not have any associated ACL yet, so you must use `{service}.#` instead. +The ACL corresponding to each resource is documented in +[auth.wazo.community](https://auth.wazo.community). Some resources may not have any associated ACL +yet, so you must use `{service}.#` instead. diff --git a/website/uc-doc/api_sdk/rest_api/quickstart.md b/website/uc-doc/api_sdk/rest_api/quickstart.md index 52cee578..0406c22c 100644 --- a/website/uc-doc/api_sdk/rest_api/quickstart.md +++ b/website/uc-doc/api_sdk/rest_api/quickstart.md @@ -80,9 +80,9 @@ Now that we have access to REST API specifications, we can use them: And that's it, you are ready to use any REST API with your authentication token. **Note**: Be aware that this token will expire, and that you will need to get a new one when that -happens. You can take a look at [auth.wazo.community](https://auth.wazo.community) for an easier manual token generation -process. Note that the `auth.wazo.community` server will never know the tokens that you generate, -you browser will ask your Wazo directly. +happens. You can take a look at [auth.wazo.community](https://auth.wazo.community) for an easier +manual token generation process. Note that the `auth.wazo.community` server will never know the +tokens that you generate, you browser will ask your Wazo directly. **Warning**: Also, note that this authentication token gives **all permissions** to anyone who knows it. Same goes for the account password we created earlier. Remember to delete this account, or at diff --git a/website/uc-doc/api_sdk/websocket.md b/website/uc-doc/api_sdk/websocket.md index a15bb123..8263ee4f 100644 --- a/website/uc-doc/api_sdk/websocket.md +++ b/website/uc-doc/api_sdk/websocket.md @@ -82,7 +82,7 @@ be surrounded by the following enveloppe: Here's a rudimentary example of a web page accessing the service: ```html - + diff --git a/website/uc-doc/contributors/contributing_doc.md b/website/uc-doc/contributors/contributing_doc.md index fba6b3e2..36c50a01 100644 --- a/website/uc-doc/contributors/contributing_doc.md +++ b/website/uc-doc/contributors/contributing_doc.md @@ -5,7 +5,8 @@ title: Contribute to Documentation ## Documentation guideline {#documentation-guideline} Here\'s the guideline/conventions to follow for the Wazo documentation. Wazo documentation is -generated with GatbsyJS. The source code is available on [GitHub](https://github.com/wazo-platform/wazo-platform.org) +generated with GatbsyJS. The source code is available on +[GitHub](https://github.com/wazo-platform/wazo-platform.org) ### Language {#language} diff --git a/website/uc-doc/contributors/generate_custom_prompts.md b/website/uc-doc/contributors/generate_custom_prompts.md index 9158a8f6..866d778a 100644 --- a/website/uc-doc/contributors/generate_custom_prompts.md +++ b/website/uc-doc/contributors/generate_custom_prompts.md @@ -14,8 +14,8 @@ only covers the Wazo prompts, but it may be adapted for Asterisk prompts. 1. Create an account on Transifex and join the team of translation of Wazo. 2. Translate the prompts in the wazo-prompt resource. -3. Go to [Transifex](https://www.transifex.com/wazo/wazo) and download the file on your Wazo. You should have - a file named like `for_use_wazo_wazo-prompt_pt_BR.ini`. +3. Go to [Transifex](https://www.transifex.com/wazo/wazo) and download the file on your Wazo. You + should have a file named like `for_use_wazo_wazo-prompt_pt_BR.ini`. 4. On your Wazo, download the tool to automate the use of Google TTS: ```shell diff --git a/website/uc-doc/high_availability/index.md b/website/uc-doc/high_availability/index.md index b33418c6..977b0866 100644 --- a/website/uc-doc/high_availability/index.md +++ b/website/uc-doc/high_availability/index.md @@ -204,4 +204,3 @@ Here's the list of limitations that are more relevant on an administrator standp When replicating the database between master and slave, if you encounter problems related to the system locale, see `postgresql_localization_errors` - diff --git a/website/uc-doc/index.md b/website/uc-doc/index.md index faa4bd94..c8d3a934 100644 --- a/website/uc-doc/index.md +++ b/website/uc-doc/index.md @@ -8,7 +8,8 @@ Wazo Platform is an application suite based on several free existing components [Asterisk](https://www.asterisk.org/), and our own developments to provide communication services (IPBX, Unified Messaging, ...) to businesses. -The platform released as a [free software](https://www.gnu.org/philosophy/free-sw.html). Most of its distinctive components, and Wazo Platform as a whole, are distributed under the _GPLv3 license_. +The platform released as a [free software](https://www.gnu.org/philosophy/free-sw.html). Most of its +distinctive components, and Wazo Platform as a whole, are distributed under the _GPLv3 license_. You may also check the [Wazo blog](/blog) for more information. @@ -25,10 +26,7 @@ In November 2016, Proformatique Inc. was shut down and the development team [forked XiVO to create Wazo](/blog/introducing-wazo). Its first release, Wazo 16.16, was released in December 2016. -:::note[Attribution Notice] -The major part of this documentation has been copied (2016-11-25) from the XiVO documentation -(originally hosted at `http://documentation.xivo.io`). That documentation was licensed under the -[Create Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/) -and was Copyright 2012-2016 Avencall -::: - +:::note[Attribution Notice] The major part of this documentation has been copied (2016-11-25) from the +XiVO documentation (originally hosted at `http://documentation.xivo.io`). That documentation was licensed +under the [Create Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/) +and was Copyright 2012-2016 Avencall ::: diff --git a/website/uc-doc/installation/index.md b/website/uc-doc/installation/index.md index d1420fd1..0cdfae7a 100644 --- a/website/uc-doc/installation/index.md +++ b/website/uc-doc/installation/index.md @@ -60,7 +60,8 @@ To install the Unified Communication use case in an all-in-one setup, do the fol ``` 6. Edit the file `inventories/uc-engine` to add your preferences and passwords. The various - variables that can be customized are described [here](https://github.com/wazo-platform/wazo-ansible/blob/master/README.md#variables). + variables that can be customized are described + [here](https://github.com/wazo-platform/wazo-ansible/blob/master/README.md#variables). By default, Wazo Platform will install the development version. To install the latest stable version, activate the following settings in `inventories/uc-engine`: diff --git a/website/uc-doc/system/network/index.md b/website/uc-doc/system/network/index.md index 5945b16b..dd32f54e 100644 --- a/website/uc-doc/system/network/index.md +++ b/website/uc-doc/system/network/index.md @@ -25,9 +25,9 @@ are applied at startup (i.e. each time the network interface goes up). fi ``` -3. Fields \, \ and \ should be replaced by your specific - configuration. For example, if you want to add a route for 192.168.50.128/25 via 192.168.17.254 - which should be added when eth0 goes up: +3. Fields \, \ and \ should be replaced by your + specific configuration. For example, if you want to add a route for 192.168.50.128/25 via + 192.168.17.254 which should be added when eth0 goes up: ```sh #!/bin/sh diff --git a/website/uc-doc/system/wazo-dird/stock_plugins.md b/website/uc-doc/system/wazo-dird/stock_plugins.md index 7baa9ba8..8ef75745 100644 --- a/website/uc-doc/system/wazo-dird/stock_plugins.md +++ b/website/uc-doc/system/wazo-dird/stock_plugins.md @@ -8,7 +8,8 @@ title: Stock Plugins Documentation View name: default_json -Purpose: present directory entries in JSON format. The format is detailed in [documentation](https://wazo-platform.org/documentation). +Purpose: present directory entries in JSON format. The format is detailed in +[documentation](https://wazo-platform.org/documentation). ### headers diff --git a/website/uc-doc/system/wazo-webhookd/index.md b/website/uc-doc/system/wazo-webhookd/index.md index 61fe1202..3c1b5e3e 100644 --- a/website/uc-doc/system/wazo-webhookd/index.md +++ b/website/uc-doc/system/wazo-webhookd/index.md @@ -5,9 +5,9 @@ title: 'wazo-webhookd' ## Overview wazo-webhookd is a component responsible for managing _subscriptions_ to internal platform events, -such that custom behavior can be triggered in reaction to those events. -This can be used to allow components external to the Wazo Platform to be notified of those events, -in effect allowing for asynchronous integrations with other systems. +such that custom behavior can be triggered in reaction to those events. This can be used to allow +components external to the Wazo Platform to be notified of those events, in effect allowing for +asynchronous integrations with other systems. A subscription is a resource managed through wazo-webhookd, which associates a list of internal events to some type of reaction mechanism which is to be triggered from those events. @@ -26,16 +26,15 @@ are: As well as supporting configuration of custom behaviors through HTTP subscriptions and custom Python plugins, wazo-webhookd can also automatically create and manage special subscriptions for mobile -users. -These _mobile subscriptions_ can provide push notification services for Wazo Platform events +users. These _mobile subscriptions_ can provide push notification services for Wazo Platform events relevant to mobile users, such as incoming calls, voicemails, missed calls, chat messages, etc. When a mobile user logs in, authentication events generated by that login are handled by wazo-webhookd, which in turn creates a mobile subscription for that user. That subscription -specifies the internal events which are relevant for push notifications to mobile users. -When those events are emitted by the platform, the subscription triggers the "hook" code that -generates the relevant push notifications, by interacting with the configured third-party push -notification service providers APIs (e.g. FCM, APNS). +specifies the internal events which are relevant for push notifications to mobile users. When those +events are emitted by the platform, the subscription triggers the "hook" code that generates the +relevant push notifications, by interacting with the configured third-party push notification +service providers APIs (e.g. FCM, APNS). Note: those subscriptions can not be created manually through the REST API. From ae4dca22f2497c17c9c63c7051c8951c15cd849c Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Tue, 12 Nov 2024 15:42:01 -0500 Subject: [PATCH 18/22] style(docusaurus): change documentation dropdown --- website/docusaurus.config.ts | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/website/docusaurus.config.ts b/website/docusaurus.config.ts index 257b1727..e206d327 100644 --- a/website/docusaurus.config.ts +++ b/website/docusaurus.config.ts @@ -74,9 +74,8 @@ const config: Config = { position: 'left', to: '/docs/intro', items: [ - { to: '/docs/intro', label: 'Introduction' }, - { to: '/uc-doc', label: 'UC Documentation' }, { to: '/docs/category/api', label: 'API Documentation' }, + { to: '/uc-doc', label: 'UC Documentation' }, ], }, { to: '/blog', label: 'Blog', position: 'left' }, From f41317aa23bc55c9b1f842721c78c14241054850 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Tue, 12 Nov 2024 15:48:17 -0500 Subject: [PATCH 19/22] build(docusaurus): rewrite links that use redirects --- .prettierignore | 1 + website/blog/new-public-release-wazo-1913.md | 2 +- website/blog/wazo-c4-ansible.md | 2 +- website/docs/contribute/codebase.md | 2 +- website/docs/contribute/description.md | 2 +- website/release-notes/sprint-review-1704.md | 2 +- website/release-notes/sprint-review-1705.md | 2 +- website/release-notes/sprint-review-1706.md | 2 +- website/release-notes/sprint-review-1707.md | 2 +- website/release-notes/sprint-review-1708.md | 2 +- website/release-notes/sprint-review-1709.md | 2 +- website/release-notes/sprint-review-1710.md | 2 +- website/release-notes/sprint-review-1711.md | 2 +- website/release-notes/sprint-review-1712.md | 2 +- website/release-notes/sprint-review-1713.md | 2 +- website/release-notes/sprint-review-1714.md | 2 +- website/release-notes/sprint-review-1715.md | 2 +- website/release-notes/sprint-review-1716.md | 2 +- website/release-notes/sprint-review-1717.md | 4 ++-- website/release-notes/sprint-review-1801.md | 4 ++-- website/release-notes/sprint-review-1802.md | 4 ++-- website/release-notes/sprint-review-1803.md | 4 ++-- website/release-notes/sprint-review-1915.md | 4 ++-- website/release-notes/sprint-review-1916.md | 4 ++-- website/release-notes/sprint-review-1917.md | 4 ++-- website/release-notes/sprint-review-2001.md | 6 +++--- website/release-notes/sprint-review-2002.md | 4 ++-- website/release-notes/sprint-review-2003.md | 4 ++-- website/release-notes/sprint-review-2004.md | 4 ++-- website/release-notes/sprint-review-2005.md | 2 +- website/release-notes/sprint-review-2006.md | 2 +- website/release-notes/sprint-review-2007.md | 2 +- website/release-notes/sprint-review-2008.md | 2 +- website/release-notes/sprint-review-2009.md | 2 +- website/release-notes/sprint-review-2010.md | 2 +- website/release-notes/sprint-review-2011.md | 2 +- website/release-notes/sprint-review-2012.md | 2 +- website/release-notes/sprint-review-2013.md | 2 +- website/release-notes/sprint-review-2014.md | 2 +- website/release-notes/sprint-review-2015.md | 2 +- website/release-notes/sprint-review-2016.md | 2 +- website/release-notes/sprint-review-2017.md | 2 +- website/release-notes/sprint-review-2101.md | 2 +- website/release-notes/sprint-review-2102.md | 2 +- website/release-notes/sprint-review-2103.md | 2 +- website/release-notes/sprint-review-2104.md | 2 +- website/release-notes/sprint-review-2105.md | 2 +- website/release-notes/sprint-review-2106.md | 2 +- website/release-notes/sprint-review-2107.md | 2 +- website/release-notes/sprint-review-2108.md | 2 +- website/release-notes/sprint-review-2109.md | 2 +- website/release-notes/sprint-review-2110.md | 2 +- website/release-notes/sprint-review-2111.md | 2 +- website/release-notes/sprint-review-2112.md | 2 +- website/release-notes/sprint-review-2113.md | 2 +- website/release-notes/sprint-review-2114.md | 2 +- website/release-notes/sprint-review-2115.md | 2 +- website/release-notes/sprint-review-2116.md | 2 +- website/release-notes/sprint-review-2201.md | 2 +- website/release-notes/sprint-review-2202.md | 2 +- website/release-notes/sprint-review-2203.md | 2 +- website/release-notes/sprint-review-2204.md | 2 +- website/release-notes/sprint-review-2205.md | 2 +- website/release-notes/sprint-review-2206.md | 2 +- website/release-notes/sprint-review-2207.md | 2 +- website/release-notes/sprint-review-2208.md | 2 +- website/release-notes/sprint-review-2209.md | 2 +- website/release-notes/sprint-review-2210.md | 2 +- website/release-notes/sprint-review-2211.md | 2 +- website/release-notes/sprint-review-2212.md | 2 +- website/release-notes/sprint-review-2213.md | 2 +- website/release-notes/sprint-review-2214.md | 2 +- website/release-notes/sprint-review-2215.md | 2 +- website/release-notes/sprint-review-2216.md | 2 +- website/release-notes/sprint-review-2217.md | 2 +- website/release-notes/sprint-review-2301.md | 2 +- website/release-notes/sprint-review-2302.md | 2 +- website/release-notes/sprint-review-2303.md | 2 +- website/release-notes/sprint-review-2304.md | 2 +- website/release-notes/sprint-review-2305.md | 2 +- website/release-notes/sprint-review-2306.md | 2 +- website/release-notes/sprint-review-2307.md | 2 +- website/release-notes/sprint-review-2308.md | 2 +- website/release-notes/sprint-review-2309.md | 2 +- website/release-notes/sprint-review-2310.md | 2 +- website/release-notes/sprint-review-2311.md | 2 +- website/release-notes/sprint-review-2312.md | 2 +- website/release-notes/sprint-review-2313.md | 2 +- website/release-notes/sprint-review-2314.md | 2 +- website/release-notes/sprint-review-2315.md | 2 +- website/release-notes/sprint-review-2316.md | 2 +- website/release-notes/sprint-review-2317.md | 2 +- website/release-notes/sprint-review-2401.md | 2 +- website/release-notes/sprint-review-2402.md | 2 +- website/release-notes/sprint-review-2403.md | 2 +- website/release-notes/sprint-review-2404.md | 2 +- website/release-notes/sprint-review-2405.md | 2 +- website/release-notes/sprint-review-2406.md | 2 +- website/release-notes/sprint-review-2407.md | 2 +- website/release-notes/sprint-review-2408.md | 2 +- website/release-notes/sprint-review-2409.md | 2 +- website/release-notes/sprint-review-2410.md | 2 +- website/release-notes/sprint-review-2411.md | 2 +- website/release-notes/sprint-review-2412.md | 2 +- website/release-notes/sprint-review-2413.md | 2 +- website/release-notes/sprint-review-2414.md | 2 +- website/release-notes/sprint-review-2415.md | 2 +- website/uc-doc/contributors/contributing_to_wazo.md | 2 +- website/uc-doc/index.md | 6 ++++-- website/uc-doc/upgrade/archives/migrate_i386_to_amd64.md | 2 +- website/uc-doc/upgrade/upgrade_notes.md | 2 +- website/uc-doc/upgrade/upgrade_specific_version/index.md | 2 +- 112 files changed, 127 insertions(+), 124 deletions(-) diff --git a/.prettierignore b/.prettierignore index d48e9280..e65d525e 100644 --- a/.prettierignore +++ b/.prettierignore @@ -10,3 +10,4 @@ website/uc-doc/api_sdk/rest_api/index.md website/uc-doc/api_sdk/rest_api/confd/index.md website/uc-doc/api_sdk/rest_api/changelog.md website/uc-doc/api_sdk/index.md +website/uc-doc/index.md diff --git a/website/blog/new-public-release-wazo-1913.md b/website/blog/new-public-release-wazo-1913.md index f113f48b..1d3bf19f 100644 --- a/website/blog/new-public-release-wazo-1913.md +++ b/website/blog/new-public-release-wazo-1913.md @@ -39,7 +39,7 @@ Enter [Wazo Platform](/): an API engine that gives all the API toolbox needed to ## Where do I start building with Wazo Platform? -The complete documentation is available [here](/documentation) and there is an example of using the API in the [install documentation](/use-cases). +The complete documentation is available [here](/documentation) and there is an example of using the API in the [install documentation](https://wazo-platform.org/use-cases). We certainly are looking forward to seeing what you will build! ## Wazo was Free Software. How about Wazo Platform? diff --git a/website/blog/wazo-c4-ansible.md b/website/blog/wazo-c4-ansible.md index 44ad9605..34e97fba 100644 --- a/website/blog/wazo-c4-ansible.md +++ b/website/blog/wazo-c4-ansible.md @@ -222,4 +222,4 @@ $ ansible-playbook -i inventories/c4-router-vagrant c4-router.yaml ## Conclusions -Wazo Platform C4 is easily deployable with our Ansible recipes on bare-metal or virtual machines as you can see, just by following a few simple steps. For more detailed information and other installation methods please refer to [the official Wazo C4 Install guide](/use-cases/class-4). +Wazo Platform C4 is easily deployable with our Ansible recipes on bare-metal or virtual machines as you can see, just by following a few simple steps. For more detailed information and other installation methods please refer to [the official Wazo C4 Install guide](https://wazo-platform.org/use-cases/class-4). diff --git a/website/docs/contribute/codebase.md b/website/docs/contribute/codebase.md index 4d6bdd3a..eb4f1680 100644 --- a/website/docs/contribute/codebase.md +++ b/website/docs/contribute/codebase.md @@ -100,7 +100,7 @@ After writing your code and checking that it does not break any tests, you should try it. The "easiest" way to do so is to use a virtual machine with a working engine. You should avoid testing in a production environment to avoid outage for you and your users. To install your test -engine follow the [installation](/uc-doc/installation/install-system) documentation. +engine follow the [installation](/uc-doc/installation) documentation. Now that you have a test engine, you want to try your code on it. Before starting, I suggest you take a snapshot of your virtual machine to be diff --git a/website/docs/contribute/description.md b/website/docs/contribute/description.md index a75cf52e..4ce67623 100644 --- a/website/docs/contribute/description.md +++ b/website/docs/contribute/description.md @@ -13,7 +13,7 @@ your skills and wills: - you can add new features by following [the code contribution guide](/contribute/code) and [the REST API contribution guidelines](/contribute/rest). - you can provide feedback on the currently developed features by reviewing [active Pull Requests](https://github.com/pulls?utf8=%E2%9C%93&q=is%3Aopen+is%3Apr++archived%3Afalse+user%3Awazo-platform). -- you can test the system following [the installation guide](/uc-doc/installation/install-system) and play with [the API](/documentation). Report any issue in [the ticketing system](https://wazo-dev.atlassian.net/). +- you can test the system following [the installation guide](/uc-doc/installation) and play with [the API](/documentation). Report any issue in [the ticketing system](https://wazo-dev.atlassian.net/). - you can add support for [new physical phones](/uc-doc/contributors/provisioning/developing_plugins). - you can contribute to this documentation by adding pages or correcting anything in [the wazo-platform.org git repository](https://github.com/wazo-platform/wazo-platform.org). diff --git a/website/release-notes/sprint-review-1704.md b/website/release-notes/sprint-review-1704.md index eb80444b..ac1a183c 100644 --- a/website/release-notes/sprint-review-1704.md +++ b/website/release-notes/sprint-review-1704.md @@ -30,7 +30,7 @@ Hello Wazo community! Here comes the release of Wazo 17.04! --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) or [upgrading Wazo](/uc-doc/upgrade/introduction) are available in the documentation. +The instructions for [installing Wazo](/uc-doc/installation) or [upgrading Wazo](/uc-doc/upgrade) are available in the documentation. See you at the next sprint review! diff --git a/website/release-notes/sprint-review-1705.md b/website/release-notes/sprint-review-1705.md index b6163551..aecf7fea 100644 --- a/website/release-notes/sprint-review-1705.md +++ b/website/release-notes/sprint-review-1705.md @@ -42,7 +42,7 @@ Hello Wazo community! Here comes the release of Wazo 17.05! --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) or [upgrading Wazo](/uc-doc/upgrade/introduction) are available in the documentation. +The instructions for [installing Wazo](/uc-doc/installation) or [upgrading Wazo](/uc-doc/upgrade) are available in the documentation. For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1706.md b/website/release-notes/sprint-review-1706.md index 8f918175..732bd1bc 100644 --- a/website/release-notes/sprint-review-1706.md +++ b/website/release-notes/sprint-review-1706.md @@ -32,7 +32,7 @@ Hello Wazo community! Here comes the release of Wazo 17.06! --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) or [upgrading Wazo](/uc-doc/upgrade/introduction) are available in the documentation. +The instructions for [installing Wazo](/uc-doc/installation) or [upgrading Wazo](/uc-doc/upgrade) are available in the documentation. For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1707.md b/website/release-notes/sprint-review-1707.md index 27cf3f94..de3d3737 100644 --- a/website/release-notes/sprint-review-1707.md +++ b/website/release-notes/sprint-review-1707.md @@ -38,7 +38,7 @@ Hello Wazo community! Here comes the release of Wazo 17.07! --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) or [upgrading Wazo](/uc-doc/upgrade/introduction) are available in the documentation. +The instructions for [installing Wazo](/uc-doc/installation) or [upgrading Wazo](/uc-doc/upgrade) are available in the documentation. For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1708.md b/website/release-notes/sprint-review-1708.md index 9e629623..2c5bff26 100644 --- a/website/release-notes/sprint-review-1708.md +++ b/website/release-notes/sprint-review-1708.md @@ -26,7 +26,7 @@ Hello Wazo community! Here comes the release of Wazo 17.08! --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) or [upgrading Wazo](/uc-doc/upgrade/introduction) are available in the documentation. +The instructions for [installing Wazo](/uc-doc/installation) or [upgrading Wazo](/uc-doc/upgrade) are available in the documentation. For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1709.md b/website/release-notes/sprint-review-1709.md index 5dc5c3a7..671a5955 100644 --- a/website/release-notes/sprint-review-1709.md +++ b/website/release-notes/sprint-review-1709.md @@ -34,7 +34,7 @@ Hello Wazo community! Here comes the release of Wazo 17.09! --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) or [upgrading Wazo](/uc-doc/upgrade/introduction) are available in the documentation. +The instructions for [installing Wazo](/uc-doc/installation) or [upgrading Wazo](/uc-doc/upgrade) are available in the documentation. For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1710.md b/website/release-notes/sprint-review-1710.md index 660764ee..454414c6 100644 --- a/website/release-notes/sprint-review-1710.md +++ b/website/release-notes/sprint-review-1710.md @@ -26,7 +26,7 @@ Hello Wazo community! Here comes the release of Wazo 17.10! --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) or [upgrading Wazo](/uc-doc/upgrade/introduction) are available in the documentation. +The instructions for [installing Wazo](/uc-doc/installation) or [upgrading Wazo](/uc-doc/upgrade) are available in the documentation. For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1711.md b/website/release-notes/sprint-review-1711.md index c6c3276b..c0df63fe 100644 --- a/website/release-notes/sprint-review-1711.md +++ b/website/release-notes/sprint-review-1711.md @@ -30,7 +30,7 @@ Hello Wazo community! Here comes the release of Wazo 17.11! --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) or [upgrading Wazo](/uc-doc/upgrade/introduction) are available in the documentation. +The instructions for [installing Wazo](/uc-doc/installation) or [upgrading Wazo](/uc-doc/upgrade) are available in the documentation. For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1712.md b/website/release-notes/sprint-review-1712.md index 1a7f40e2..e98c356e 100644 --- a/website/release-notes/sprint-review-1712.md +++ b/website/release-notes/sprint-review-1712.md @@ -32,7 +32,7 @@ Hello Wazo community! Here comes the release of Wazo 17.12! --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) or [upgrading Wazo](/uc-doc/upgrade/introduction) are available in the documentation. +The instructions for [installing Wazo](/uc-doc/installation) or [upgrading Wazo](/uc-doc/upgrade) are available in the documentation. For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1713.md b/website/release-notes/sprint-review-1713.md index eef23fa4..096ba411 100644 --- a/website/release-notes/sprint-review-1713.md +++ b/website/release-notes/sprint-review-1713.md @@ -28,7 +28,7 @@ Hello Wazo community! Here comes the release of Wazo 17.13! --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) or [upgrading Wazo](/uc-doc/upgrade/introduction) are available in the documentation. +The instructions for [installing Wazo](/uc-doc/installation) or [upgrading Wazo](/uc-doc/upgrade) are available in the documentation. For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1714.md b/website/release-notes/sprint-review-1714.md index b2d74841..334778a1 100644 --- a/website/release-notes/sprint-review-1714.md +++ b/website/release-notes/sprint-review-1714.md @@ -32,7 +32,7 @@ We are looking for beta testers for the Wazo Zapier plugin. --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) or [upgrading Wazo](/uc-doc/upgrade/introduction) are available in the documentation. +The instructions for [installing Wazo](/uc-doc/installation) or [upgrading Wazo](/uc-doc/upgrade) are available in the documentation. For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1715.md b/website/release-notes/sprint-review-1715.md index bac56704..b35bc568 100644 --- a/website/release-notes/sprint-review-1715.md +++ b/website/release-notes/sprint-review-1715.md @@ -36,7 +36,7 @@ We are looking for beta testers for the Wazo Zapier plugin. You can click this [ --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) or [upgrading Wazo](/uc-doc/upgrade/introduction) are available in the documentation. +The instructions for [installing Wazo](/uc-doc/installation) or [upgrading Wazo](/uc-doc/upgrade) are available in the documentation. For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1716.md b/website/release-notes/sprint-review-1716.md index c405ebaa..a38ccf16 100644 --- a/website/release-notes/sprint-review-1716.md +++ b/website/release-notes/sprint-review-1716.md @@ -24,7 +24,7 @@ Hello Wazo community! Here comes the release of Wazo 17.16! --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) or [upgrading Wazo](/uc-doc/upgrade/introduction) are available in the documentation. +The instructions for [installing Wazo](/uc-doc/installation) or [upgrading Wazo](/uc-doc/upgrade) are available in the documentation. For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1717.md b/website/release-notes/sprint-review-1717.md index cf970db6..c3bead45 100644 --- a/website/release-notes/sprint-review-1717.md +++ b/website/release-notes/sprint-review-1717.md @@ -28,8 +28,8 @@ This release is our birthday release, since the fork! Thanks for following us th --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) are available in the documentation. -The instructions for [upgrading Wazo](/uc-doc/upgrade/introduction) as also available in the documentation. Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes). +The instructions for [installing Wazo](/uc-doc/installation) are available in the documentation. +The instructions for [upgrading Wazo](/uc-doc/upgrade) as also available in the documentation. Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes). For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1801.md b/website/release-notes/sprint-review-1801.md index 2ab4ba97..4532acfa 100644 --- a/website/release-notes/sprint-review-1801.md +++ b/website/release-notes/sprint-review-1801.md @@ -37,8 +37,8 @@ status: published --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) are available in the documentation. -The instructions for [upgrading Wazo](/uc-doc/upgrade/introduction) as also available in the documentation. Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-18.01/upgrade/upgrade_notes.html). +The instructions for [installing Wazo](/uc-doc/installation) are available in the documentation. +The instructions for [upgrading Wazo](/uc-doc/upgrade) as also available in the documentation. Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-18.01/upgrade/upgrade_notes.html). For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1802.md b/website/release-notes/sprint-review-1802.md index f0351444..6c00b608 100644 --- a/website/release-notes/sprint-review-1802.md +++ b/website/release-notes/sprint-review-1802.md @@ -24,8 +24,8 @@ status: published --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) are available in the documentation. -The instructions for [upgrading Wazo](/uc-doc/upgrade/introduction) as also available in the documentation. Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-18.02/upgrade/upgrade_notes.html). +The instructions for [installing Wazo](/uc-doc/installation) are available in the documentation. +The instructions for [upgrading Wazo](/uc-doc/upgrade) as also available in the documentation. Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-18.02/upgrade/upgrade_notes.html). For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1803.md b/website/release-notes/sprint-review-1803.md index 4b4818ba..eadbeebc 100644 --- a/website/release-notes/sprint-review-1803.md +++ b/website/release-notes/sprint-review-1803.md @@ -32,8 +32,8 @@ status: published --- -The instructions for [installing Wazo](/uc-doc/installation/install-system) are available in the documentation. -The instructions for [upgrading Wazo](/uc-doc/upgrade/introduction) as also available in the documentation. Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-18.03/upgrade/upgrade_notes.html). +The instructions for [installing Wazo](/uc-doc/installation) are available in the documentation. +The instructions for [upgrading Wazo](/uc-doc/upgrade) as also available in the documentation. Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-18.03/upgrade/upgrade_notes.html). For more details about the aforementioned topics, please see the roadmap linked below. diff --git a/website/release-notes/sprint-review-1915.md b/website/release-notes/sprint-review-1915.md index c13c782e..b38cf9a0 100644 --- a/website/release-notes/sprint-review-1915.md +++ b/website/release-notes/sprint-review-1915.md @@ -43,8 +43,8 @@ See you at the next sprint review! Resources: -- [Install Wazo Platform](/uc-doc/installation/install-system) -- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/introduction). Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-19.15/upgrade/upgrade_notes.html). +- [Install Wazo Platform](/uc-doc/installation) +- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade). Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-19.15/upgrade/upgrade_notes.html). Sources: diff --git a/website/release-notes/sprint-review-1916.md b/website/release-notes/sprint-review-1916.md index 2e77a15d..ade0a8b0 100644 --- a/website/release-notes/sprint-review-1916.md +++ b/website/release-notes/sprint-review-1916.md @@ -33,8 +33,8 @@ See you at the next sprint review! Resources: -- [Install Wazo Platform](/uc-doc/installation/install-system) -- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/introduction). Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-19.16/upgrade/upgrade_notes.html). +- [Install Wazo Platform](/uc-doc/installation) +- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade). Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-19.16/upgrade/upgrade_notes.html). Sources: diff --git a/website/release-notes/sprint-review-1917.md b/website/release-notes/sprint-review-1917.md index 86a5d524..c2aef4b4 100644 --- a/website/release-notes/sprint-review-1917.md +++ b/website/release-notes/sprint-review-1917.md @@ -48,8 +48,8 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/uc-doc/installation/install-system) -- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/introduction). Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-19.17/upgrade/upgrade_notes.html) +- [Install Wazo Platform](/uc-doc/installation) +- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade). Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-19.17/upgrade/upgrade_notes.html) Sources: diff --git a/website/release-notes/sprint-review-2001.md b/website/release-notes/sprint-review-2001.md index c037f502..7deb6b1e 100644 --- a/website/release-notes/sprint-review-2001.md +++ b/website/release-notes/sprint-review-2001.md @@ -17,7 +17,7 @@ Here is a short review of the Wazo Platform 20.01 release. - **Switchboard**: We have worked on improving the switchboard reactivity. In this version, the time to answer a call has been reduced by half. These changes may also impact positively the response time of other actions made on the calls in a switchboard. - **Monitoring**: We have added a new HTTP resource to retrieve the current status of user telephony lines in wazo-calld REST API. This allows an external application to know which phones are busy, available or disconnected. This feature is currently very similar to the wazo-chatd presence features, but it will be improved with more details irrelevant to wazo-chatd, like the round-trip time to a phone. - **Users**: We have improved the users REST API to add information related to user interception. When getting a user's details, you may now get the list of people that this user is allowed to intercept. -- **Class 4**: We are releasing a first version of the SBC and call routing features of Wazo Platform, featuring Kamailio. Here are the links to the [installation documentation](/use-cases/class-4) and [REST API documentation](/documentation/overview/router-confd.html). +- **Class 4**: We are releasing a first version of the SBC and call routing features of Wazo Platform, featuring Kamailio. Here are the links to the [installation documentation](https://wazo-platform.org/use-cases/class-4) and [REST API documentation](/documentation/overview/router-confd.html). ## Contributions @@ -41,8 +41,8 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/uc-doc/installation/install-system) -- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/introduction). Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-19.17/upgrade/upgrade_notes.html) +- [Install Wazo Platform](/uc-doc/installation) +- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade). Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-19.17/upgrade/upgrade_notes.html) Sources: diff --git a/website/release-notes/sprint-review-2002.md b/website/release-notes/sprint-review-2002.md index 33db24ab..7c4095c9 100644 --- a/website/release-notes/sprint-review-2002.md +++ b/website/release-notes/sprint-review-2002.md @@ -46,8 +46,8 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/uc-doc/installation/install-system) -- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/introduction). Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-20.02/upgrade/upgrade_notes.html) +- [Install Wazo Platform](/uc-doc/installation) +- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade). Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-20.02/upgrade/upgrade_notes.html) Sources: diff --git a/website/release-notes/sprint-review-2003.md b/website/release-notes/sprint-review-2003.md index 0c2961af..55a8abae 100644 --- a/website/release-notes/sprint-review-2003.md +++ b/website/release-notes/sprint-review-2003.md @@ -40,8 +40,8 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/uc-doc/installation/install-system) -- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/introduction). Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-20.03/upgrade/upgrade_notes.html) +- [Install Wazo Platform](/uc-doc/installation) +- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade). Be sure to read the [breaking changes](https://wazo.readthedocs.io/en/wazo-20.03/upgrade/upgrade_notes.html) Sources: diff --git a/website/release-notes/sprint-review-2004.md b/website/release-notes/sprint-review-2004.md index a6cbd2de..62538dc7 100644 --- a/website/release-notes/sprint-review-2004.md +++ b/website/release-notes/sprint-review-2004.md @@ -39,8 +39,8 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/uc-doc/installation/install-system) -- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/introduction). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-04) +- [Install Wazo Platform](/uc-doc/installation) +- [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-04) Sources: diff --git a/website/release-notes/sprint-review-2005.md b/website/release-notes/sprint-review-2005.md index 9eab0cd2..2eb24557 100644 --- a/website/release-notes/sprint-review-2005.md +++ b/website/release-notes/sprint-review-2005.md @@ -43,7 +43,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/uc-doc/installation/install-system) +- [Install Wazo Platform](/uc-doc/installation) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20.05) Sources: diff --git a/website/release-notes/sprint-review-2006.md b/website/release-notes/sprint-review-2006.md index 1df63bcf..c6eea92f 100644 --- a/website/release-notes/sprint-review-2006.md +++ b/website/release-notes/sprint-review-2006.md @@ -35,7 +35,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/uc-doc/installation/install-system) +- [Install Wazo Platform](/uc-doc/installation) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-06) Sources: diff --git a/website/release-notes/sprint-review-2007.md b/website/release-notes/sprint-review-2007.md index 025146ff..954abd92 100644 --- a/website/release-notes/sprint-review-2007.md +++ b/website/release-notes/sprint-review-2007.md @@ -37,7 +37,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/uc-doc/installation/install-system) +- [Install Wazo Platform](/uc-doc/installation) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-07) Sources: diff --git a/website/release-notes/sprint-review-2008.md b/website/release-notes/sprint-review-2008.md index 39bb049e..009ec9a9 100644 --- a/website/release-notes/sprint-review-2008.md +++ b/website/release-notes/sprint-review-2008.md @@ -37,7 +37,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/uc-doc/installation/install-system) +- [Install Wazo Platform](/uc-doc/installation) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-08) Sources: diff --git a/website/release-notes/sprint-review-2009.md b/website/release-notes/sprint-review-2009.md index ff191fd8..55fdfddb 100644 --- a/website/release-notes/sprint-review-2009.md +++ b/website/release-notes/sprint-review-2009.md @@ -34,7 +34,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/uc-doc/installation/install-system) +- [Install Wazo Platform](/uc-doc/installation) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-09) Sources: diff --git a/website/release-notes/sprint-review-2010.md b/website/release-notes/sprint-review-2010.md index 6c591366..b48aed58 100644 --- a/website/release-notes/sprint-review-2010.md +++ b/website/release-notes/sprint-review-2010.md @@ -29,7 +29,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-10) Sources: diff --git a/website/release-notes/sprint-review-2011.md b/website/release-notes/sprint-review-2011.md index c7e36f0b..e65627ef 100644 --- a/website/release-notes/sprint-review-2011.md +++ b/website/release-notes/sprint-review-2011.md @@ -36,7 +36,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-11) Sources: diff --git a/website/release-notes/sprint-review-2012.md b/website/release-notes/sprint-review-2012.md index 9a6a5d8c..f3768c16 100644 --- a/website/release-notes/sprint-review-2012.md +++ b/website/release-notes/sprint-review-2012.md @@ -34,7 +34,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-12) Sources: diff --git a/website/release-notes/sprint-review-2013.md b/website/release-notes/sprint-review-2013.md index 36bd4899..c06ebcef 100644 --- a/website/release-notes/sprint-review-2013.md +++ b/website/release-notes/sprint-review-2013.md @@ -60,7 +60,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/uc-doc/installation/install-system) +- [Install Wazo Platform](/uc-doc/installation) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-13) Sources: diff --git a/website/release-notes/sprint-review-2014.md b/website/release-notes/sprint-review-2014.md index a08b0c16..a27a9bfd 100644 --- a/website/release-notes/sprint-review-2014.md +++ b/website/release-notes/sprint-review-2014.md @@ -36,7 +36,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-14) Sources: diff --git a/website/release-notes/sprint-review-2015.md b/website/release-notes/sprint-review-2015.md index ab45d64d..7a58d7df 100644 --- a/website/release-notes/sprint-review-2015.md +++ b/website/release-notes/sprint-review-2015.md @@ -34,7 +34,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-15) Sources: diff --git a/website/release-notes/sprint-review-2016.md b/website/release-notes/sprint-review-2016.md index 45f0bac1..0ad38809 100644 --- a/website/release-notes/sprint-review-2016.md +++ b/website/release-notes/sprint-review-2016.md @@ -40,7 +40,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-16) Sources: diff --git a/website/release-notes/sprint-review-2017.md b/website/release-notes/sprint-review-2017.md index e2014a92..3db553d0 100644 --- a/website/release-notes/sprint-review-2017.md +++ b/website/release-notes/sprint-review-2017.md @@ -37,7 +37,7 @@ See you next year for the release of Wazo Platform 21.01! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#20-17) diff --git a/website/release-notes/sprint-review-2101.md b/website/release-notes/sprint-review-2101.md index 7be6ad8d..77bc37ac 100644 --- a/website/release-notes/sprint-review-2101.md +++ b/website/release-notes/sprint-review-2101.md @@ -34,7 +34,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-01) Sources: diff --git a/website/release-notes/sprint-review-2102.md b/website/release-notes/sprint-review-2102.md index 6667cf6d..35fd9789 100644 --- a/website/release-notes/sprint-review-2102.md +++ b/website/release-notes/sprint-review-2102.md @@ -43,7 +43,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-02) Sources: diff --git a/website/release-notes/sprint-review-2103.md b/website/release-notes/sprint-review-2103.md index f8ff97a3..e9e5dc6b 100644 --- a/website/release-notes/sprint-review-2103.md +++ b/website/release-notes/sprint-review-2103.md @@ -34,7 +34,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-03) Sources: diff --git a/website/release-notes/sprint-review-2104.md b/website/release-notes/sprint-review-2104.md index 376f494a..70494dc1 100644 --- a/website/release-notes/sprint-review-2104.md +++ b/website/release-notes/sprint-review-2104.md @@ -40,7 +40,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-04) Sources: diff --git a/website/release-notes/sprint-review-2105.md b/website/release-notes/sprint-review-2105.md index bee1a0e1..8c41f3f7 100644 --- a/website/release-notes/sprint-review-2105.md +++ b/website/release-notes/sprint-review-2105.md @@ -32,7 +32,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-05) Sources: diff --git a/website/release-notes/sprint-review-2106.md b/website/release-notes/sprint-review-2106.md index a0598ced..8847cf31 100644 --- a/website/release-notes/sprint-review-2106.md +++ b/website/release-notes/sprint-review-2106.md @@ -32,7 +32,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-06) Sources: diff --git a/website/release-notes/sprint-review-2107.md b/website/release-notes/sprint-review-2107.md index ecde8191..6fe911a1 100644 --- a/website/release-notes/sprint-review-2107.md +++ b/website/release-notes/sprint-review-2107.md @@ -36,7 +36,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-07) Sources: diff --git a/website/release-notes/sprint-review-2108.md b/website/release-notes/sprint-review-2108.md index 185ac71b..eab3b8f2 100644 --- a/website/release-notes/sprint-review-2108.md +++ b/website/release-notes/sprint-review-2108.md @@ -32,7 +32,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-08) Sources: diff --git a/website/release-notes/sprint-review-2109.md b/website/release-notes/sprint-review-2109.md index c222923c..91112187 100644 --- a/website/release-notes/sprint-review-2109.md +++ b/website/release-notes/sprint-review-2109.md @@ -48,7 +48,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-09) diff --git a/website/release-notes/sprint-review-2110.md b/website/release-notes/sprint-review-2110.md index 536fb792..e1d1f639 100644 --- a/website/release-notes/sprint-review-2110.md +++ b/website/release-notes/sprint-review-2110.md @@ -33,7 +33,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-10) diff --git a/website/release-notes/sprint-review-2111.md b/website/release-notes/sprint-review-2111.md index e01d52e7..cc4c4f1f 100644 --- a/website/release-notes/sprint-review-2111.md +++ b/website/release-notes/sprint-review-2111.md @@ -30,7 +30,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-11) diff --git a/website/release-notes/sprint-review-2112.md b/website/release-notes/sprint-review-2112.md index d8085a01..785c3565 100644 --- a/website/release-notes/sprint-review-2112.md +++ b/website/release-notes/sprint-review-2112.md @@ -34,7 +34,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-12) diff --git a/website/release-notes/sprint-review-2113.md b/website/release-notes/sprint-review-2113.md index 13b5521d..97a8574d 100644 --- a/website/release-notes/sprint-review-2113.md +++ b/website/release-notes/sprint-review-2113.md @@ -40,7 +40,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-13) diff --git a/website/release-notes/sprint-review-2114.md b/website/release-notes/sprint-review-2114.md index acf36459..201c5d92 100644 --- a/website/release-notes/sprint-review-2114.md +++ b/website/release-notes/sprint-review-2114.md @@ -33,7 +33,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-14) diff --git a/website/release-notes/sprint-review-2115.md b/website/release-notes/sprint-review-2115.md index 716ec073..ccc72406 100644 --- a/website/release-notes/sprint-review-2115.md +++ b/website/release-notes/sprint-review-2115.md @@ -35,7 +35,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-15) diff --git a/website/release-notes/sprint-review-2116.md b/website/release-notes/sprint-review-2116.md index 5173109f..453d13b8 100644 --- a/website/release-notes/sprint-review-2116.md +++ b/website/release-notes/sprint-review-2116.md @@ -46,7 +46,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#21-16) diff --git a/website/release-notes/sprint-review-2201.md b/website/release-notes/sprint-review-2201.md index c8c87dc3..113da8fc 100644 --- a/website/release-notes/sprint-review-2201.md +++ b/website/release-notes/sprint-review-2201.md @@ -28,7 +28,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-01) diff --git a/website/release-notes/sprint-review-2202.md b/website/release-notes/sprint-review-2202.md index 827353b4..9f5e689c 100644 --- a/website/release-notes/sprint-review-2202.md +++ b/website/release-notes/sprint-review-2202.md @@ -34,7 +34,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-02) diff --git a/website/release-notes/sprint-review-2203.md b/website/release-notes/sprint-review-2203.md index 9e550587..d82d23e5 100644 --- a/website/release-notes/sprint-review-2203.md +++ b/website/release-notes/sprint-review-2203.md @@ -40,7 +40,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-03) diff --git a/website/release-notes/sprint-review-2204.md b/website/release-notes/sprint-review-2204.md index 3d45d948..5431f352 100644 --- a/website/release-notes/sprint-review-2204.md +++ b/website/release-notes/sprint-review-2204.md @@ -40,7 +40,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-04) diff --git a/website/release-notes/sprint-review-2205.md b/website/release-notes/sprint-review-2205.md index 72f28eed..2f61749e 100644 --- a/website/release-notes/sprint-review-2205.md +++ b/website/release-notes/sprint-review-2205.md @@ -38,7 +38,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-05) diff --git a/website/release-notes/sprint-review-2206.md b/website/release-notes/sprint-review-2206.md index a5c52a09..871f92f6 100644 --- a/website/release-notes/sprint-review-2206.md +++ b/website/release-notes/sprint-review-2206.md @@ -38,7 +38,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-06) diff --git a/website/release-notes/sprint-review-2207.md b/website/release-notes/sprint-review-2207.md index 1955e159..7eddf49e 100644 --- a/website/release-notes/sprint-review-2207.md +++ b/website/release-notes/sprint-review-2207.md @@ -29,7 +29,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-07) diff --git a/website/release-notes/sprint-review-2208.md b/website/release-notes/sprint-review-2208.md index 6e0f2e28..b3ec64de 100644 --- a/website/release-notes/sprint-review-2208.md +++ b/website/release-notes/sprint-review-2208.md @@ -30,7 +30,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-08) diff --git a/website/release-notes/sprint-review-2209.md b/website/release-notes/sprint-review-2209.md index 57339d73..2d4a4e13 100644 --- a/website/release-notes/sprint-review-2209.md +++ b/website/release-notes/sprint-review-2209.md @@ -40,7 +40,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-09) diff --git a/website/release-notes/sprint-review-2210.md b/website/release-notes/sprint-review-2210.md index a91a37f0..0ab6f107 100644 --- a/website/release-notes/sprint-review-2210.md +++ b/website/release-notes/sprint-review-2210.md @@ -44,7 +44,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-10) diff --git a/website/release-notes/sprint-review-2211.md b/website/release-notes/sprint-review-2211.md index 70a7e027..f1bfe7c7 100644 --- a/website/release-notes/sprint-review-2211.md +++ b/website/release-notes/sprint-review-2211.md @@ -31,7 +31,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-11) diff --git a/website/release-notes/sprint-review-2212.md b/website/release-notes/sprint-review-2212.md index 7cf2eb3b..4b3891c1 100644 --- a/website/release-notes/sprint-review-2212.md +++ b/website/release-notes/sprint-review-2212.md @@ -35,7 +35,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-12) diff --git a/website/release-notes/sprint-review-2213.md b/website/release-notes/sprint-review-2213.md index 7218f49c..13bbdd44 100644 --- a/website/release-notes/sprint-review-2213.md +++ b/website/release-notes/sprint-review-2213.md @@ -31,7 +31,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-13) diff --git a/website/release-notes/sprint-review-2214.md b/website/release-notes/sprint-review-2214.md index 3b23927b..4fec8cea 100644 --- a/website/release-notes/sprint-review-2214.md +++ b/website/release-notes/sprint-review-2214.md @@ -38,7 +38,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-14) diff --git a/website/release-notes/sprint-review-2215.md b/website/release-notes/sprint-review-2215.md index c6f7cb4e..52c9c5c0 100644 --- a/website/release-notes/sprint-review-2215.md +++ b/website/release-notes/sprint-review-2215.md @@ -38,7 +38,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-15) diff --git a/website/release-notes/sprint-review-2216.md b/website/release-notes/sprint-review-2216.md index 0bb4491b..51e14608 100644 --- a/website/release-notes/sprint-review-2216.md +++ b/website/release-notes/sprint-review-2216.md @@ -41,7 +41,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-16) diff --git a/website/release-notes/sprint-review-2217.md b/website/release-notes/sprint-review-2217.md index 1a45935c..39c937d2 100644 --- a/website/release-notes/sprint-review-2217.md +++ b/website/release-notes/sprint-review-2217.md @@ -30,7 +30,7 @@ Note that the next release will be on mid-January. Happy Holidays! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#22-17) diff --git a/website/release-notes/sprint-review-2301.md b/website/release-notes/sprint-review-2301.md index 995e738b..9eaf0094 100644 --- a/website/release-notes/sprint-review-2301.md +++ b/website/release-notes/sprint-review-2301.md @@ -40,7 +40,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-01) diff --git a/website/release-notes/sprint-review-2302.md b/website/release-notes/sprint-review-2302.md index 3ea0d0fe..8cad3ec2 100644 --- a/website/release-notes/sprint-review-2302.md +++ b/website/release-notes/sprint-review-2302.md @@ -30,7 +30,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-02) diff --git a/website/release-notes/sprint-review-2303.md b/website/release-notes/sprint-review-2303.md index 9f5ace56..7c99a7d0 100644 --- a/website/release-notes/sprint-review-2303.md +++ b/website/release-notes/sprint-review-2303.md @@ -30,7 +30,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-03) diff --git a/website/release-notes/sprint-review-2304.md b/website/release-notes/sprint-review-2304.md index 58cd2613..e0642252 100644 --- a/website/release-notes/sprint-review-2304.md +++ b/website/release-notes/sprint-review-2304.md @@ -30,7 +30,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-04) diff --git a/website/release-notes/sprint-review-2305.md b/website/release-notes/sprint-review-2305.md index 8262a77b..a8d99e96 100644 --- a/website/release-notes/sprint-review-2305.md +++ b/website/release-notes/sprint-review-2305.md @@ -32,7 +32,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-05) diff --git a/website/release-notes/sprint-review-2306.md b/website/release-notes/sprint-review-2306.md index fa95ca15..e82b5b57 100644 --- a/website/release-notes/sprint-review-2306.md +++ b/website/release-notes/sprint-review-2306.md @@ -36,7 +36,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-06) - [Detailed upgrade notes](/uc-doc/upgrade/upgrade_notes_details/23-06/bullseye) diff --git a/website/release-notes/sprint-review-2307.md b/website/release-notes/sprint-review-2307.md index a52c7ea7..54affc35 100644 --- a/website/release-notes/sprint-review-2307.md +++ b/website/release-notes/sprint-review-2307.md @@ -29,7 +29,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-07) diff --git a/website/release-notes/sprint-review-2308.md b/website/release-notes/sprint-review-2308.md index 8b7433e6..b4df8fcb 100644 --- a/website/release-notes/sprint-review-2308.md +++ b/website/release-notes/sprint-review-2308.md @@ -28,7 +28,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-08) diff --git a/website/release-notes/sprint-review-2309.md b/website/release-notes/sprint-review-2309.md index 9613da60..147318de 100644 --- a/website/release-notes/sprint-review-2309.md +++ b/website/release-notes/sprint-review-2309.md @@ -28,7 +28,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-09) diff --git a/website/release-notes/sprint-review-2310.md b/website/release-notes/sprint-review-2310.md index 3632ef5b..2834ea79 100644 --- a/website/release-notes/sprint-review-2310.md +++ b/website/release-notes/sprint-review-2310.md @@ -33,7 +33,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-10) diff --git a/website/release-notes/sprint-review-2311.md b/website/release-notes/sprint-review-2311.md index 5eca11c2..f2183612 100644 --- a/website/release-notes/sprint-review-2311.md +++ b/website/release-notes/sprint-review-2311.md @@ -37,7 +37,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-11) diff --git a/website/release-notes/sprint-review-2312.md b/website/release-notes/sprint-review-2312.md index d56cdeaf..08165600 100644 --- a/website/release-notes/sprint-review-2312.md +++ b/website/release-notes/sprint-review-2312.md @@ -48,7 +48,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-12) diff --git a/website/release-notes/sprint-review-2313.md b/website/release-notes/sprint-review-2313.md index c579770d..92c53631 100644 --- a/website/release-notes/sprint-review-2313.md +++ b/website/release-notes/sprint-review-2313.md @@ -39,7 +39,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-13) diff --git a/website/release-notes/sprint-review-2314.md b/website/release-notes/sprint-review-2314.md index d10bff26..f97e8676 100644 --- a/website/release-notes/sprint-review-2314.md +++ b/website/release-notes/sprint-review-2314.md @@ -37,7 +37,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-14) diff --git a/website/release-notes/sprint-review-2315.md b/website/release-notes/sprint-review-2315.md index b240e3a0..1e48785e 100644 --- a/website/release-notes/sprint-review-2315.md +++ b/website/release-notes/sprint-review-2315.md @@ -34,7 +34,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-15) diff --git a/website/release-notes/sprint-review-2316.md b/website/release-notes/sprint-review-2316.md index fe672ecf..2dda957c 100644 --- a/website/release-notes/sprint-review-2316.md +++ b/website/release-notes/sprint-review-2316.md @@ -38,7 +38,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-16) diff --git a/website/release-notes/sprint-review-2317.md b/website/release-notes/sprint-review-2317.md index f857615d..565a4918 100644 --- a/website/release-notes/sprint-review-2317.md +++ b/website/release-notes/sprint-review-2317.md @@ -28,7 +28,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#23-17) diff --git a/website/release-notes/sprint-review-2401.md b/website/release-notes/sprint-review-2401.md index 0a19816c..66f95af9 100644 --- a/website/release-notes/sprint-review-2401.md +++ b/website/release-notes/sprint-review-2401.md @@ -34,7 +34,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-01) diff --git a/website/release-notes/sprint-review-2402.md b/website/release-notes/sprint-review-2402.md index 5cc2a788..4d5006a2 100644 --- a/website/release-notes/sprint-review-2402.md +++ b/website/release-notes/sprint-review-2402.md @@ -35,7 +35,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-02) diff --git a/website/release-notes/sprint-review-2403.md b/website/release-notes/sprint-review-2403.md index 3f04c14f..a4fc2df0 100644 --- a/website/release-notes/sprint-review-2403.md +++ b/website/release-notes/sprint-review-2403.md @@ -36,7 +36,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-03) diff --git a/website/release-notes/sprint-review-2404.md b/website/release-notes/sprint-review-2404.md index 982f6924..7fa7fc54 100644 --- a/website/release-notes/sprint-review-2404.md +++ b/website/release-notes/sprint-review-2404.md @@ -38,7 +38,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-04) diff --git a/website/release-notes/sprint-review-2405.md b/website/release-notes/sprint-review-2405.md index 7aced997..10414b36 100644 --- a/website/release-notes/sprint-review-2405.md +++ b/website/release-notes/sprint-review-2405.md @@ -44,7 +44,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-05) diff --git a/website/release-notes/sprint-review-2406.md b/website/release-notes/sprint-review-2406.md index 05deb055..2b98d37f 100644 --- a/website/release-notes/sprint-review-2406.md +++ b/website/release-notes/sprint-review-2406.md @@ -40,7 +40,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-06) diff --git a/website/release-notes/sprint-review-2407.md b/website/release-notes/sprint-review-2407.md index 761bf212..27039a82 100644 --- a/website/release-notes/sprint-review-2407.md +++ b/website/release-notes/sprint-review-2407.md @@ -39,7 +39,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-07) diff --git a/website/release-notes/sprint-review-2408.md b/website/release-notes/sprint-review-2408.md index a6c1f13a..795b4a96 100644 --- a/website/release-notes/sprint-review-2408.md +++ b/website/release-notes/sprint-review-2408.md @@ -38,7 +38,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-08) diff --git a/website/release-notes/sprint-review-2409.md b/website/release-notes/sprint-review-2409.md index e8cb7da4..2fff102e 100644 --- a/website/release-notes/sprint-review-2409.md +++ b/website/release-notes/sprint-review-2409.md @@ -30,7 +30,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-09) diff --git a/website/release-notes/sprint-review-2410.md b/website/release-notes/sprint-review-2410.md index 65fdb7d7..d834b229 100644 --- a/website/release-notes/sprint-review-2410.md +++ b/website/release-notes/sprint-review-2410.md @@ -37,7 +37,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-10) diff --git a/website/release-notes/sprint-review-2411.md b/website/release-notes/sprint-review-2411.md index 895c139c..ff77e37d 100644 --- a/website/release-notes/sprint-review-2411.md +++ b/website/release-notes/sprint-review-2411.md @@ -32,7 +32,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-11) diff --git a/website/release-notes/sprint-review-2412.md b/website/release-notes/sprint-review-2412.md index f578a72c..2e6e571f 100644 --- a/website/release-notes/sprint-review-2412.md +++ b/website/release-notes/sprint-review-2412.md @@ -27,7 +27,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-12) diff --git a/website/release-notes/sprint-review-2413.md b/website/release-notes/sprint-review-2413.md index fe16ff01..e6a48082 100644 --- a/website/release-notes/sprint-review-2413.md +++ b/website/release-notes/sprint-review-2413.md @@ -33,7 +33,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-13) diff --git a/website/release-notes/sprint-review-2414.md b/website/release-notes/sprint-review-2414.md index 4abfe667..4b2fbd52 100644 --- a/website/release-notes/sprint-review-2414.md +++ b/website/release-notes/sprint-review-2414.md @@ -30,7 +30,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-14) diff --git a/website/release-notes/sprint-review-2415.md b/website/release-notes/sprint-review-2415.md index d5ae84ef..a8db2c18 100644 --- a/website/release-notes/sprint-review-2415.md +++ b/website/release-notes/sprint-review-2415.md @@ -24,7 +24,7 @@ See you at the next sprint review! ## Resources -- [Install Wazo Platform](/use-cases) +- [Install Wazo Platform](https://wazo-platform.org/use-cases) - [Upgrade Wazo and Wazo Platform](/uc-doc/upgrade/). Be sure to read the [breaking changes](/uc-doc/upgrade/upgrade_notes#24-15) diff --git a/website/uc-doc/contributors/contributing_to_wazo.md b/website/uc-doc/contributors/contributing_to_wazo.md index 0f2afcea..aac48351 100644 --- a/website/uc-doc/contributors/contributing_to_wazo.md +++ b/website/uc-doc/contributors/contributing_to_wazo.md @@ -78,7 +78,7 @@ executed manually at the end of each sprint. After writing your code and checking that it does not break any tests, you should try it. The "easiest" way to do so is to use a virtual machine with a working engine. You should avoid testing in a production environment to avoid outage for you and your users. To install your test engine -follow the [Installing the System](/uc-doc/installation/install-system) documentation. +follow the [Installing the System](/uc-doc/installation) documentation. Now that you have a test engine, you want to try your code on it. Before starting I suggest you make a snapshot of your virtual machine to be able to come back to a clean install whenever needed. Then diff --git a/website/uc-doc/index.md b/website/uc-doc/index.md index c8d3a934..950b8db8 100644 --- a/website/uc-doc/index.md +++ b/website/uc-doc/index.md @@ -26,7 +26,9 @@ In November 2016, Proformatique Inc. was shut down and the development team [forked XiVO to create Wazo](/blog/introducing-wazo). Its first release, Wazo 16.16, was released in December 2016. -:::note[Attribution Notice] The major part of this documentation has been copied (2016-11-25) from the +:::note[Attribution Notice] +The major part of this documentation has been copied (2016-11-25) from the XiVO documentation (originally hosted at `http://documentation.xivo.io`). That documentation was licensed under the [Create Commons Attribution-ShareAlike 4.0 International License](https://creativecommons.org/licenses/by-sa/4.0/) -and was Copyright 2012-2016 Avencall ::: +and was Copyright 2012-2016 Avencall +::: diff --git a/website/uc-doc/upgrade/archives/migrate_i386_to_amd64.md b/website/uc-doc/upgrade/archives/migrate_i386_to_amd64.md index 61f315b2..78d6f0c5 100644 --- a/website/uc-doc/upgrade/archives/migrate_i386_to_amd64.md +++ b/website/uc-doc/upgrade/archives/migrate_i386_to_amd64.md @@ -6,7 +6,7 @@ There is no fully automated method to migrate Wazo from `i386` to `amd64`. The procedure is: -1. [Install](/uc-doc/installation/install-system) a Wazo `amd64` **using the same version as the +1. [Install](/uc-doc/installation) a Wazo `amd64` **using the same version as the upgraded Wazo i386** 2. Make a backup of your Wazo `i386` by following the [backup procedure](/uc-doc/system/backup_restore#manual-backup) diff --git a/website/uc-doc/upgrade/upgrade_notes.md b/website/uc-doc/upgrade/upgrade_notes.md index 8b99fae4..13166ca8 100644 --- a/website/uc-doc/upgrade/upgrade_notes.md +++ b/website/uc-doc/upgrade/upgrade_notes.md @@ -575,7 +575,7 @@ for more information. `/etc/nginx/sites-available/wazo.dpkg-old`. - If you installed Wazo Platform before 21.01, you will have an error about an invalid signature. - See the [troubleshooting](/uc-doc/upgrade/introduction#invalid-signature-before-2201-only) section + See the [troubleshooting](/uc-doc/upgrade#invalid-signature-before-2201-only) section for the fix. Consult the diff --git a/website/uc-doc/upgrade/upgrade_specific_version/index.md b/website/uc-doc/upgrade/upgrade_specific_version/index.md index 7fe0e625..69b9d020 100644 --- a/website/uc-doc/upgrade/upgrade_specific_version/index.md +++ b/website/uc-doc/upgrade/upgrade_specific_version/index.md @@ -11,7 +11,7 @@ upgrade to the latest (which is not recommended, but sometimes necessary). ## Prerequisites **Note**: These procedures are _complementary_ to the upgrade procedure listed in -[version specific upgrade](/uc-doc/upgrade/introduction#version-specific-upgrade). You must follow +[version specific upgrade](/uc-doc/upgrade#version-specific-upgrade). You must follow the version-specific procedure _before_ running the following procedures. - [Upgrade from Wazo \< 19.04](/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-stretch) From 38454aba36f9496401ab475ea27b3044b1fe5309 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Tue, 12 Nov 2024 15:56:44 -0500 Subject: [PATCH 20/22] style: lint new content --- .prettierignore | 2 +- website/uc-doc/upgrade/archives/migrate_i386_to_amd64.md | 4 ++-- website/uc-doc/upgrade/upgrade_notes.md | 3 +-- website/uc-doc/upgrade/upgrade_specific_version/index.md | 4 ++-- 4 files changed, 6 insertions(+), 7 deletions(-) diff --git a/.prettierignore b/.prettierignore index e65d525e..684f62ed 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,4 +1,4 @@ -# Files with docusaurus MDX +# @todo: when migration done... rewrite theses file to .mdx and remove website/uc-doc/system/index.md website/uc-doc/ecosystem/index.md website/uc-doc/contributors/provisioning/index.md diff --git a/website/uc-doc/upgrade/archives/migrate_i386_to_amd64.md b/website/uc-doc/upgrade/archives/migrate_i386_to_amd64.md index 78d6f0c5..8577fca5 100644 --- a/website/uc-doc/upgrade/archives/migrate_i386_to_amd64.md +++ b/website/uc-doc/upgrade/archives/migrate_i386_to_amd64.md @@ -6,8 +6,8 @@ There is no fully automated method to migrate Wazo from `i386` to `amd64`. The procedure is: -1. [Install](/uc-doc/installation) a Wazo `amd64` **using the same version as the - upgraded Wazo i386** +1. [Install](/uc-doc/installation) a Wazo `amd64` **using the same version as the upgraded Wazo + i386** 2. Make a backup of your Wazo `i386` by following the [backup procedure](/uc-doc/system/backup_restore#manual-backup) 3. Copy the backup tarballs to the Wazo `amd64` diff --git a/website/uc-doc/upgrade/upgrade_notes.md b/website/uc-doc/upgrade/upgrade_notes.md index 13166ca8..96ff615f 100644 --- a/website/uc-doc/upgrade/upgrade_notes.md +++ b/website/uc-doc/upgrade/upgrade_notes.md @@ -575,8 +575,7 @@ for more information. `/etc/nginx/sites-available/wazo.dpkg-old`. - If you installed Wazo Platform before 21.01, you will have an error about an invalid signature. - See the [troubleshooting](/uc-doc/upgrade#invalid-signature-before-2201-only) section - for the fix. + See the [troubleshooting](/uc-doc/upgrade#invalid-signature-before-2201-only) section for the fix. Consult the [21.16 Tickets](https://wazo-dev.atlassian.net/issues/?jql=project%3DWAZO%20AND%20fixVersion%3D21.16) diff --git a/website/uc-doc/upgrade/upgrade_specific_version/index.md b/website/uc-doc/upgrade/upgrade_specific_version/index.md index 69b9d020..c0b05e52 100644 --- a/website/uc-doc/upgrade/upgrade_specific_version/index.md +++ b/website/uc-doc/upgrade/upgrade_specific_version/index.md @@ -11,8 +11,8 @@ upgrade to the latest (which is not recommended, but sometimes necessary). ## Prerequisites **Note**: These procedures are _complementary_ to the upgrade procedure listed in -[version specific upgrade](/uc-doc/upgrade#version-specific-upgrade). You must follow -the version-specific procedure _before_ running the following procedures. +[version specific upgrade](/uc-doc/upgrade#version-specific-upgrade). You must follow the +version-specific procedure _before_ running the following procedures. - [Upgrade from Wazo \< 19.04](/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-stretch) - [Upgrade from Wazo \> 19.12](/uc-doc/upgrade/upgrade_specific_version/archives-from-wazo-buster) From 1addab38fd5b4c264338b50e955d7f57c5f3a58f Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Tue, 12 Nov 2024 16:12:37 -0500 Subject: [PATCH 21/22] build: run node 18.18.2 and rollback gatsby-node.ts to js --- Dockerfile | 2 +- gatsby-node.ts => gatsby-node.js | 31 +++++++++++++++++++++---------- 2 files changed, 22 insertions(+), 11 deletions(-) rename gatsby-node.ts => gatsby-node.js (90%) diff --git a/Dockerfile b/Dockerfile index dd3378d1..d11f0aa1 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,5 @@ # From https://github.com/docker-library/docs/blob/master/eclipse-temurin/README.md#using-a-different-base-image -FROM node:18.5.0-bullseye-slim AS build-node +FROM node:18.18.2-bullseye-slim AS build-node ENV LANG=en_US.UTF-8 ENV JAVA_HOME=/opt/java/openjdk COPY --from=eclipse-temurin:11 $JAVA_HOME $JAVA_HOME diff --git a/gatsby-node.ts b/gatsby-node.js similarity index 90% rename from gatsby-node.ts rename to gatsby-node.js index 47493032..6d100d64 100644 --- a/gatsby-node.ts +++ b/gatsby-node.js @@ -7,7 +7,6 @@ const algoliasearch = require('algoliasearch'); const striptags = require('striptags'); const RSS = require('rss'); -const redirects = require('./website/redirects') const config = require('./config'); const constants = require('./src/contants'); @@ -563,15 +562,27 @@ exports.createPages = async ({ graphql, actions: { createPage, createRedirect } }); } - redirects.default.forEach(redirect => { - if(Array.isArray(redirect.from)) { - redirect.from.forEach(from => { - generate301(from, redirect.to) - }) - }else{ - generate301(redirect.from, redirect.to) - } - }) + generate301('/uc-doc/administration/contact_directories/general', '/uc-doc/administration/contact_directories'); + generate301('/uc-doc/administration/interconnections/introduction', '/uc-doc/administration/interconnections'); + generate301('/uc-doc/administration/provisioning/introduction', '/uc-doc/administration/provisioning'); + generate301('/uc-doc/administration/users', '/uc-doc/administration'); + generate301('/uc-doc/api_sdk/mobile/push_notification', '/uc-doc/api_sdk/mobile_push_notification'); + generate301('/uc-doc/api_sdk/mobile', '/uc-doc/api_sdk/mobile_push_notification'); + generate301('/uc-doc/contact_center/introduction', '/uc-doc/contact_center'); + generate301('/uc-doc/high_availability/introduction', '/uc-doc/high_availability'); + generate301('/uc-doc/installation/install-system', '/uc-doc/installation'); + generate301('/uc-doc/upgrade/introduction', '/uc-doc/upgrade'); + generate301('/uc-doc/upgrade/upgrade_specific_version/introduction', '/uc-doc/upgrade/upgrade_specific_version'); + generate301('/uc-doc/system/wazo-auth/introduction', '/uc-doc/system/wazo-auth'); + generate301('/uc-doc/system/wazo-confd/introduction', '/uc-doc/system/wazo-confd'); + generate301('/uc-doc/system/wazo-confgend/introduction', '/uc-doc/system/wazo-confgend'); + generate301('/uc-doc/system/wazo-dird/introduction', '/uc-doc/system/wazo-dird'); + generate301('/uc-doc/introduction', '/uc-doc'); + generate301('/uc-doc/attribution', '/uc-doc'); + generate301('/uc-doc/changelog', '/uc-doc'); + generate301('/uc-doc/upgrade/old_upgrade_notes', '/uc-doc/upgrade/archives/upgrade_notes'); + generate301('/uc-doc/upgrade/upgrade_from_wazo_18_03', '/uc-doc/upgrade/archives/upgrade_from_wazo_18_03'); + generate301('/uc-doc/upgrade/migrate_i386_to_amd64', '/uc-doc/upgrade/archives/migrate_i386_to_amd64'); }; exports.onCreateWebpackConfig = ({ actions }) => { From 9fc183759cdfeecec1f90294c93e159b5bba5d68 Mon Sep 17 00:00:00 2001 From: Francis Chartrand Date: Tue, 12 Nov 2024 16:34:17 -0500 Subject: [PATCH 22/22] build(docker): mount prettierignore --- .prettierignore | 1 + docker-compose.yml | 1 + website/uc-doc/administration/index.md | 63 ++++++++++++++------------ 3 files changed, 36 insertions(+), 29 deletions(-) diff --git a/.prettierignore b/.prettierignore index 684f62ed..6d8101d1 100644 --- a/.prettierignore +++ b/.prettierignore @@ -1,4 +1,5 @@ # @todo: when migration done... rewrite theses file to .mdx and remove +website/uc-doc/administration/index.md website/uc-doc/system/index.md website/uc-doc/ecosystem/index.md website/uc-doc/contributors/provisioning/index.md diff --git a/docker-compose.yml b/docker-compose.yml index 0e18842f..a46e29da 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -12,6 +12,7 @@ services: - ./website/blog:/app/website/blog:ro - ./website/uc-doc:/app/website/uc-doc:ro - ./.prettierrc:/app/.prettierrc:ro + - ./.prettierignore:/app/.prettierignore:ro - ./static:/app/static:ro - ./gatsby-node.js:/app/gatsby-node.js:ro - ./gatsby-config.js:/app/gatsby-config.js:ro diff --git a/website/uc-doc/administration/index.md b/website/uc-doc/administration/index.md index 02a6b267..94741c75 100644 --- a/website/uc-doc/administration/index.md +++ b/website/uc-doc/administration/index.md @@ -2,35 +2,40 @@ title: Administration --- +import CardList from '@site/src/components/Card/CardList'; + All configurations are done via the [`wazo-confd` REST API](/documentation/api/configuration.html). -# Table of contents + -- [Boss Secretary Filter](/uc-doc/administration/boss_secretary_filter) -- [Call Permissions](/uc-doc/administration/call_permissions) -- [Call Recording](/uc-doc/administration/call_recording) -- [Call Logs CallerID](/uc-doc/administration/call_logs) -- [Caller ID](/uc-doc/administration/callerid) -- [CLI Tools](/uc-doc/administration/cli_tools) -- [Directed Pickup](/uc-doc/administration/directed_pickup) -- [Direct media](/uc-doc/administration/direct_media) -- [Fax](/uc-doc/administration/fax) -- [Graphics](/uc-doc/administration/graphics) -- [Group Pickup](/uc-doc/administration/group_pickup) -- [Import Export](/uc-doc/administration/import_export) -- [Incall](/uc-doc/administration/incall) -- [Interconnections](/uc-doc/administration/interconnections) -- [IVR](/uc-doc/administration/ivr) -- [Music On Hold](/uc-doc/administration/music_on_hold) -- [NAT](/uc-doc/administration/nat) -- [Paging](/uc-doc/administration/paging) -- [Parking](/uc-doc/administration/parking) -- [Provisioning](/uc-doc/administration/provisioning) -- [Security](/uc-doc/administration/security) -- [SCCP](/uc-doc/administration/sccp) -- [Schedules](/uc-doc/administration/schedules) -- [Sound Files](/uc-doc/administration/sound_files) -- [Users](/uc-doc/administration/users) -- [Voicemails](/uc-doc/administration/voicemails) -- [SIP Templates](/uc-doc/administration/sip_templates) -- [Call Policy](/uc-doc/administration/call_policy)