refactor(help): update mqtt page header links #1254
Conversation
ysfscream
added
enhancement
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| ja: 'MQTT 5 を探る', | ||
| tr: 'MQTT 5 Keşfedin', | ||
| hu: 'Fedezze fel az MQTT 5-öt', | ||
| }, | ||
| guideTitle: { | ||
| zh: 'MQTT 入门', | ||
| en: 'MQTT Beginner’s Guide', |
There was a problem hiding this comment.
the code review:
- The code looks well formatted and it is easy to read.
- It looks like the code is being used to add language support for a public MQTT broker and MQTT 5 Explore.
- The code is adding new keys and values to the existing object, which is a valid way of adding language support.
- The code is using proper indentation and spacing which is good.
- The code does not contain any syntax errors and should run without any issues.
| @@ -32,6 +32,8 @@ export default (lang: Language) => { | |||
| docs: `${MQTTXSite}/docs${utm}mqttx-help-to-docs`, | |||
| forum: `${forumSite}${utm}mqttx-help-to-forum`, | |||
| learnMQTT: `${EMQSite}/mqtt${utm}mqttx-help-to-learn-mqtt`, | |||
| publicMqttBroker: `${EMQSite}/mqtt/public-mqtt5-broker`, | |||
| mqtt5: `${EMQSite}/mqtt/mqtt5`, | |||
| blogUtm: `${utm}mqttx-help-to-blog`, | |||
| } | |||
|
|
|||
There was a problem hiding this comment.
the code review:
- The code patch looks correct. It adds two additional lines to the existing code, which link to EMQ's website for public MQTT brokers and MQTT5.
- The code is well indented and follows a consistent style.
- The new lines of code are consistent with the existing code, and the variable names are descriptive and easy to understand.
- All the links are properly formatted and appear to be valid.
- There are no unnecessary variables or functions.
- There are no potential security risks associated with the code.
| link: learnMQTT, | ||
| icon: 'icon-mqtt5', | ||
| title: this.$tc('help.mqtt5Explore'), | ||
| link: mqtt5, | ||
| }, | ||
| ] | ||
| } |
There was a problem hiding this comment.
our code review by looking at the changes made on line 62 and 63.
In the original code, the "helpTop" method was retrieving the "docs" and "forum" links from the gaCustomLinks() method. In the updated code, the "learnMQTT", "publicMqttBroker" and "mqtt5" links are being retrieved instead. This change looks to be valid as it is more reflective of the current state of the application.
Next, we can look at the changes made on lines 64-69. In the original code, the "helpTop" method was setting the "icon", "title" and "link" keys in the array for the "docs" and "forum" links. However, in the updated code, these keys have been updated to match the new links being retrieved in the "helpTop" method, namely "learnMQTT", "publicMqttBroker" and "mqtt5". This change looks to be valid as it is necessary in order to reflect the new links being retrieved.
Finally, we can look at the changes made on lines 70-75. In the original code, the "helpTop" method was setting the "icon", "title" and "link" keys in the array for the "learnMQTT" link. However, in the updated code, these keys have been updated to match the new link being retrieved in the "helpTop" method, namely "mqtt5". This change looks to be valid as it is necessary in order to reflect the new link being retrieved.
Overall, the changes made to the code look to be valid and necessary in order to reflect the new links being retrieved in the "helpTop" method.
| ja: 'MQTT 5 を探る', | ||
| tr: 'MQTT 5 Keşfedin', | ||
| hu: 'Fedezze fel az MQTT 5-öt', | ||
| }, | ||
| guideTitle: { | ||
| zh: 'MQTT 入门', | ||
| en: 'MQTT Beginner’s Guide', |
There was a problem hiding this comment.
the code review.
-
The patch adds additional translations for the strings 'publicMqttBroker', 'mqtt5Explore' and 'guideTitle' for Chinese, English, Japanese, Turkish and Hungarian languages. This looks good and the syntax used is correct.
-
The patch also adds new lines at the end of the file. This is not necessary and should be removed.
-
It is also recommended to add comments to explain why these changes are being made. This helps other developers understand the code better.
Overall, the patch looks good.
| @@ -17,6 +17,8 @@ export default (lang: Language) => { | |||
| docs: `${MQTTXSite}/docs${utm}mqttx-web-help-to-docs`, | |||
| forum: `${forumSite}${utm}mqttx-web-help-to-forum`, | |||
| learnMQTT: `${EMQSite}/mqtt${utm}mqttx-web-help-to-learn-mqtt`, | |||
| publicMqttBroker: `${EMQSite}/mqtt/public-mqtt5-broker`, | |||
| mqtt5: `${EMQSite}/mqtt/mqtt5`, | |||
| blogUtm: `${utm}mqttx-web-help-to-blog`, | |||
| } | |||
|
|
|||
There was a problem hiding this comment.
with the code review.
The code patch adds two new lines of code to the existing code. The first line adds a link to a public MQTT broker. The second line adds a link to an MQTT5 page.
The added lines of code appear to be well-formatted and do not introduce any syntax errors. Furthermore, they add useful information that can help users access additional resources.
Overall, this code patch looks good and should be accepted.
| link: learnMQTT, | ||
| icon: 'icon-mqtt5', | ||
| title: this.$tc('help.mqtt5Explore'), | ||
| link: mqtt5, | ||
| }, | ||
| ] | ||
| } |
There was a problem hiding this comment.
the code review:
-
The original code uses "docs" and "forum" as two properties of the gaCustomLinks method, while the patch replaces them with "learnMQTT", "publicMqttBroker" and "mqtt5". This is a good change because it provides more options for users to learn about MQTT.
-
The original code uses "icon-docs" and "icon-forum" as icons for the links, while the patch replaces them with "icon-learn-mqtt", "icon-public-mqtt-broker" and "icon-mqtt5". This is a good change because it makes the icons more relevant to the type of link they are linking to.
-
The original code uses "this.$tc('help.docs')" and "this.$tc('help.forum')" as titles for the links, while the patch replaces them with "this.$tc('help.learn')", "this.$tc('help.publicMqttBroker')" and "this.$tc('help.mqtt5Explore')". This is a good change because it gives more descriptive titles for the links.
Overall, this code patch looks good and should be approved.
PR Checklist
If you have any questions, you can refer to the Contributing Guide
What is the current behavior?
Please describe the current behavior and link to a relevant issue.
Issue Number
Example: #123
What is the new behavior?
Please describe the new behavior or provide screenshots.
Does this PR introduce a breaking change?
Specific Instructions
Are there any specific instructions or things that should be known prior to review?
Other information