Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

[Docs] Broken content in Kibana docs #98933

Closed
davemoore- opened this issue Apr 30, 2021 · 5 comments
Closed

[Docs] Broken content in Kibana docs #98933

davemoore- opened this issue Apr 30, 2021 · 5 comments
Assignees
Labels
bug Fixes for quality problems that affect the customer experience docs Team:Docs Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)

Comments

@davemoore-
Copy link

The content on "Alerting and action settings in Kibana" is broken toward the bottom of the page (see screenshot below):

URL: https://www.elastic.co/guide/en/kibana/current/alert-action-settings-kb.html

Screen Shot 2021-04-30 at 11 07 41 AM

@davemoore- davemoore- added bug Fixes for quality problems that affect the customer experience docs labels Apr 30, 2021
@botelastic botelastic bot added the needs-team Issues missing a team label label Apr 30, 2021
@wylieconlon wylieconlon added Team:Docs and removed needs-team Issues missing a team label labels Apr 30, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@pmuellr
Copy link
Member

pmuellr commented Apr 30, 2021

This has already been fixed in 7.x and master, and the problem doesn't exist in 7.11, so will need to be fixed in 7.12 and 7.13.

I fixed this in master, via this PR #96630 (comment) . I thought I looked at previous versions and they were ok, but ... I guess not. I do kind wonder if something changed after the text was originally added, and whether other doc in Kibana could be broken ...

@pmuellr pmuellr added the Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) label Apr 30, 2021
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

@pmuellr
Copy link
Member

pmuellr commented May 3, 2021

I believe the only change needed is this:

on line 88 (in the 7.13 version) is a line that includes the following:

The time is formatted as <count>[ms|s|m|h|d|w|M|Y], 

I ended up splitting the <count>[..] part out to a new code section, because it's so long that it wraps if left inline, and then looks confusing. And then changed the |'s to , - I think even with the code sectioning, it still did not deal with the vertical bars the way we wanted.

Here's what it looks like in master now ...

 | ... The time is formatted as: +
  +
  `<count>[ms,s,m,h,d,w,M,Y]` +
  +
  For example, `20m`, `24h`, `7d`, `1w`. Defaults to `60s`.

@pmuellr pmuellr self-assigned this May 3, 2021
pmuellr added a commit to pmuellr/kibana that referenced this issue May 4, 2021
resolves elastic#98933

Some vertical bars in text got interpreted as a table, but should have been a
code example.  Changed to use commas instead of vertical bars.
pmuellr added a commit that referenced this issue May 4, 2021
resolves #98933

Some vertical bars in text got interpreted as a table, but should have been a
code example.  Changed to use commas instead of vertical bars.
pmuellr added a commit to pmuellr/kibana that referenced this issue May 4, 2021
resolves elastic#98933

Some vertical bars in text got interpreted as a table, but should have been a
code example.  Changed to use commas instead of vertical bars.
pmuellr added a commit that referenced this issue May 4, 2021
resolves #98933

Some vertical bars in text got interpreted as a table, but should have been a
code example.  Changed to use commas instead of vertical bars.
@pmuellr
Copy link
Member

pmuellr commented May 6, 2021

fixed via #99146 in 7.13, and backported to 7.12

@pmuellr pmuellr closed this as completed May 6, 2021
@kobelb kobelb added the needs-team Issues missing a team label label Jan 31, 2022
@botelastic botelastic bot removed the needs-team Issues missing a team label label Jan 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Fixes for quality problems that affect the customer experience docs Team:Docs Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams)
Projects
None yet
Development

No branches or pull requests

5 participants