Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

The documentation link for WQL is not working #5867

Closed
Tracked by #5862
AlexRuiz7 opened this issue Sep 8, 2023 · 1 comment · Fixed by #5889 or wazuh/wazuh-documentation#6500
Closed
Tracked by #5862

The documentation link for WQL is not working #5867

AlexRuiz7 opened this issue Sep 8, 2023 · 1 comment · Fixed by #5889 or wazuh/wazuh-documentation#6500
Assignees
@Desvelao
Labels
level/task Task issue type/bug Bug issue

Comments

@AlexRuiz7
Copy link
Member

AlexRuiz7 commented Sep 8, 2023 •
edited
Loading

Wazuh Rev Browser
4.6.0-alpha1 01 All

Description

The documentation link for the WQL language in the search bar component is broken.

It points to the tag v4.6.0, but we use a two term tag, composed by Wazuh's and OpenSearch's version: v4.6.0-2.6.0

image

Options

  • Change the tag pattern to a single term.
  • Change the link to the correct tag
  • Move the documentation to the documentation page (preferred)
@AlexRuiz7 AlexRuiz7 added type/bug Bug issue level/task Task issue labels Sep 8, 2023
@AlexRuiz7 AlexRuiz7 mentioned this issue Sep 8, 2023
Closed
8 tasks
@wazuhci wazuhci moved this to Triage in Release 4.6.0 Sep 8, 2023
@wazuhci wazuhci moved this from Triage to Backlog in Release 4.6.0 Sep 11, 2023
@AlexRuiz7 AlexRuiz7 changed the title The documentation link for WQL is not working. The documentation link for WQL is not working Sep 12, 2023
@Desvelao Desvelao self-assigned this Sep 12, 2023
@wazuhci wazuhci moved this from Backlog to In progress in Release 4.6.0 Sep 12, 2023
@Desvelao Desvelao mentioned this issue Sep 13, 2023
Merged
6 tasks
This was linked to pull requests Sep 13, 2023
Fix WQL documentation link #5889
Merged
Add Wazuh dashboard queries documentation wazuh/wazuh-documentation#6500
Merged
@Desvelao
Copy link
Member

I created a new page in the documentation on this pull request: wazuh/wazuh-documentation#6500

@wazuhci wazuhci moved this from In progress to Pending review in Release 4.6.0 Sep 13, 2023
Tostti added a commit that referenced this issue Sep 13, 2023
@Tostti
Fix WQL documentation link (#5889)
d24e037 
### Description
This pull request fixes the link to the WQL documentation. It redirects
to the official documentation instead of repository documenation.
 
### Issues Resolved
#5867

### Evidence

![image](https://github.com/wazuh/wazuh-kibana-app/assets/34042064/110e678e-a443-434d-b917-e0bc8be68bac)

### Test

Legend:
:black_circle:: none
:green_circle:: pass
:yellow_circle:: warning
:red_circle:: fail
:white_circle:: not applicable

## UI

| Test | Chrome | Firefox | Safari |
| --- |  --- | --- | --- |
| Ensure the WQL documentation link is pointing to the official
documentation and the link would be valid. | :black_circle: |
:black_circle: | :black_circle: |

**Details**
<details>
<summary>:black_circle: Ensure the WQL documentation link is pointing to
the official documentation and the link would be valid.</summary>

Chrome - :black_circle:

Firefox - :black_circle:

Safari - :black_circle:

</details>

### Check List
- [ ] All tests pass
  - [ ] `yarn test:jest`
- [ ] New functionality includes testing.
- [ ] New functionality has been documented.
- [ ] Update [CHANGELOG.md](./../CHANGELOG.md)
- [x] Commits are signed per the DCO using --signoff
@wazuhci wazuhci moved this from Pending review to In review in Release 4.6.0 Sep 14, 2023
@wazuhci wazuhci moved this from In review to Done in Release 4.6.0 Sep 14, 2023
@asteriscos asteriscos mentioned this issue Sep 27, 2023
Closed
2 tasks
@Tostti Tostti mentioned this issue Oct 10, 2023
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Desvelao Desvelao

Labels
level/task Task issue type/bug Bug issue
Projects
No open projects
Release 4.6.0
Status: Done
Milestone
No milestone
2 participants
@AlexRuiz7 @Desvelao