Fix documentation links to point to correct version instead of current #4301

Desvelao · 2022-06-30T14:12:15Z

Description

This PR changes the web documentation URLs to point using the plugin short version instead of current.

Closes #4294 #4296.

Changes

Created service to generate the web documentation URLs
Added tests for the service
Fixed not found URLs
Changed some link texts
Refactored some prompts to match other similar elements
Updated the script to generate the API info that creates the URLs for the
endpoints

Screenshots

Test

Manual tests

Test each web documentation link work as expected and points to the plugin short version

Automatic tests

3 tests are added related to the new service. Run them with:
yarn test:jest common/services/web_documentation.test.ts

Expected result:

$ node scripts/jest common/services/web_documentation.test.ts
 PASS  common/services/web_documentation.test.ts
  ✓ Generate a web documentation URL using to the plugin short version (2 ms)
  ✓ Generate a web documentation URL to the base URL using to the plugin short version
  ✓ Generate a web documentation URL using a specific version


=============================== Coverage summary ===============================
Statements   : 0.28% ( 101/36348 )
Branches     : 0% ( 1/28223 )
Functions    : 0.01% ( 1/8890 )
Lines        : 0.29% ( 101/34765 )
================================================================================
Test Suites: 1 passed, 1 total
Tests:       3 passed, 3 total
Snapshots:   0 total
Time:        14.986 s
Ran all test suites matching /common\/services\/web_documentation.test.ts/i.
Done in 17.22s.

Created service to generate the web documentation URLs Fixed not found URLs Changed some link texts Refactored some prompts to match other similar elements Updated the script to generate the API info that create the URLs for the endpoints

yenienserrano

CR: ✔️
Test: ✔️

Solves the title overflow

Solves title overflow

Some of the documenatation links titles were outdated or too long, causing the title to overflow. These titles have been updated to the titltes on their Wazuh documentation page. Also, a new link has been aded to the Docker Listener section.

AlexRuiz7

Review

Code: ✔️
Test: ✔️

common/services/web_documentation.ts

AlexRuiz7 · 2022-07-01T15:29:40Z

public/components/wz-search-bar/wz-search-format-selector.tsx

@@ -1,190 +0,0 @@
-/*


Why was this file deleted?

...ic/controllers/management/components/management/configuration/client-buffer/client-buffer.js

github-actions · 2022-07-04T12:36:39Z

Jest Test Coverage	%	values
Statements	5.5%	( 1999 / 36348 )
Branches	2.28%	( 643 / 28223 )
Functions	3.67%	( 326 / 8890 )
Lines	5.57%	( 1938 / 34765 )

* feat: web documentation URLs point to plugin short version Created service to generate the web documentation URLs Fixed broken links Changed some link texts Refactored some prompts to match other similar elements Updated the script to generate the API info that create the URLs for the endpoints * changelog: add PR entries * fix: replaced the title for agent enrollment link * feat: added tests to webDocumentationLink function * Change documentation title of Wazuh agent enrollment * Update documentation links titles Some documentation links titles were outdated or too long, causing the title to overflow. These titles have been updated to the titles on their Wazuh documentation page. Also, a new link has been added to the Docker Listener section. Co-authored-by: Alex Ruiz Becerra <alejandro.ruiz.becerra@wazuh.com> (cherry picked from commit 463665e)

github-actions · 2022-07-04T13:11:13Z

The backport to 4.3-1.2-wzd failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-4.3-1.2-wzd 4.3-1.2-wzd
# Navigate to the new working tree
cd .worktrees/backport-4.3-1.2-wzd
# Create a new branch
git switch --create backport-4301-to-4.3-1.2-wzd
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 463665ef2a01ace783162adea48952e6bfe3a54d
# Push it to GitHub
git push --set-upstream origin backport-4301-to-4.3-1.2-wzd
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-4.3-1.2-wzd

Then, create a pull request where the base branch is 4.3-1.2-wzd and the compare/head branch is backport-4301-to-4.3-1.2-wzd.

…ion (#4304) Web documentation URLs point to plugin short version (#4301) * feat: web documentation URLs point to plugin short version Created service to generate the web documentation URLs Fixed broken links Changed some link texts Refactored some prompts to match other similar elements Updated the script to generate the API info that create the URLs for the endpoints * changelog: add PR entries * fix: replaced the title for agent enrollment link * feat: added tests to webDocumentationLink function * Change documentation title of Wazuh agent enrollment * Update documentation links titles Some documentation links titles were outdated or too long, causing the title to overflow. These titles have been updated to the titles on their Wazuh documentation page. Also, a new link has been added to the Docker Listener section. Co-authored-by: Alex Ruiz Becerra <alejandro.ruiz.becerra@wazuh.com> (cherry picked from commit 463665e) Co-authored-by: Antonio <34042064+Desvelao@users.noreply.github.com>

* feat: web documentation URLs point to plugin short version Created service to generate the web documentation URLs Fixed broken links Changed some link texts Refactored some prompts to match other similar elements Updated the script to generate the API info that create the URLs for the endpoints * changelog: add PR entries * fix: replaced the title for agent enrollment link * feat: added tests to webDocumentationLink function * Change documentation title of Wazuh agent enrollment * Update documentation links titles Some documentation links titles were outdated or too long, causing the title to overflow. These titles have been updated to the titles on their Wazuh documentation page. Also, a new link has been added to the Docker Listener section. Co-authored-by: Alex Ruiz Becerra <alejandro.ruiz.becerra@wazuh.com> (cherry picked from commit 463665e)

…ersion (#4305) Web documentation URLs point to plugin short version (#4301) * feat: web documentation URLs point to plugin short version Created service to generate the web documentation URLs Fixed broken links Changed some link texts Refactored some prompts to match other similar elements Updated the script to generate the API info that create the URLs for the endpoints * changelog: add PR entries * fix: replaced the title for agent enrollment link * feat: added tests to webDocumentationLink function * Change documentation title of Wazuh agent enrollment * Update documentation links titles Some documentation links titles were outdated or too long, causing the title to overflow. These titles have been updated to the titles on their Wazuh documentation page. Also, a new link has been added to the Docker Listener section. Co-authored-by: Alex Ruiz Becerra <alejandro.ruiz.becerra@wazuh.com> (cherry picked from commit 463665e) Co-authored-by: Antonio <34042064+Desvelao@users.noreply.github.com>

Desvelao added backport 4.3-7.16 labels Jun 30, 2022

Desvelao self-assigned this Jun 30, 2022

Desvelao force-pushed the feat/4296-documentation-links-point-to-short-version branch from 9c23f6c to bbcf407 Compare June 30, 2022 14:12

Desvelao added 2 commits July 1, 2022 08:12

changelog: add PR entries

6eababf

fix: replaced the title for agent enrollment link

ab31e91

This was linked to issues Jul 1, 2022

Broken link to documentation #4294

Closed

Documentation links must redirect to the App version #4296

Closed

This was referenced Jul 1, 2022

Documentation links must redirect to the App version #4296

Closed

Broken link to documentation #4294

Closed

Desvelao and others added 3 commits July 1, 2022 08:38

feat: added tests to webDocumentationLink function

e9d0bd0

Change documentation title of Wazuh agent enrollment

3da6553

Update broken link

2593a79

yenienserrano approved these changes Jul 4, 2022

View reviewed changes

AlexRuiz7 added 4 commits July 4, 2022 12:38

Update link titles

821e310

Update link title

65a7381

Solves the title overflow

Update link title

4e4e3aa

Solves title overflow

Update documentation links titles

9c14905

Some of the documenatation links titles were outdated or too long, causing the title to overflow. These titles have been updated to the titltes on their Wazuh documentation page. Also, a new link has been aded to the Docker Listener section.

AlexRuiz7 approved these changes Jul 4, 2022

View reviewed changes

AlexRuiz7 merged commit 463665e into 4.3-7.10 Jul 4, 2022

AlexRuiz7 deleted the feat/4296-documentation-links-point-to-short-version branch July 4, 2022 13:10

github-actions bot mentioned this pull request Jul 4, 2022

[Backport 4.3-7.16] Web documentation URLs point to plugin short version #4304

Merged

AlexRuiz7 mentioned this pull request Jul 4, 2022

[Backport 4.3-1.2-wzd] Web documentation URLs point to plugin short version #4305

Merged

gdiazlo changed the title ~~Web documentation URLs point to plugin short version~~ Use app version instead of 'current' in documentation links Jul 15, 2022

gdiazlo changed the title ~~Use app version instead of 'current' in documentation links~~ Fix documentation links to point to correct version instead of current Jul 15, 2022

Mayons95 mentioned this pull request Jul 15, 2022

Release 4.3.6 RC1 - Wazuh UI Manual Testing #4334

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix documentation links to point to correct version instead of current #4301

Fix documentation links to point to correct version instead of current #4301

Desvelao commented Jun 30, 2022 •

edited

Loading

yenienserrano left a comment

AlexRuiz7 left a comment

AlexRuiz7 Jul 1, 2022

github-actions bot commented Jul 4, 2022

github-actions bot commented Jul 4, 2022

Fix documentation links to point to correct version instead of current #4301

Fix documentation links to point to correct version instead of current #4301

Conversation

Desvelao commented Jun 30, 2022 • edited Loading

Description

Changes

Screenshots

Test

Manual tests

Automatic tests

yenienserrano left a comment

Choose a reason for hiding this comment

AlexRuiz7 left a comment

Choose a reason for hiding this comment

Review

AlexRuiz7 Jul 1, 2022

Choose a reason for hiding this comment

github-actions bot commented Jul 4, 2022

github-actions bot commented Jul 4, 2022

Desvelao commented Jun 30, 2022 •

edited

Loading