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] Release highlights have broken heading links & no code highlighting #89441

Closed
debadair opened this issue Aug 17, 2022 · 4 comments · Fixed by #89463
Closed

[DOCS] Release highlights have broken heading links & no code highlighting #89441

debadair opened this issue Aug 17, 2022 · 4 comments · Fixed by #89463
Assignees
Labels
>bug :Delivery/Build Build or test infrastructure >docs General docs changes Team:Delivery Meta label for Delivery team Team:Docs Meta label for docs team v8.4.0

Comments

@debadair
Copy link
Contributor

debadair commented Aug 17, 2022

The generated release highlights have PR links in the headings. These links conflict with the anchor links added by the doc build and don't work as intended. In addition, the code snippets use Markdown-style code blocks instead of Asciidoc, so there's no code highlighting.

To fix the link issue, let's move the PR links to the end of the descriptions, similar to the way we handle the GH links in the Release notes. For example:

[discrete]
[[ingest_performance_improvement]]
=== Ingest performance improvement
We have improved the pipeline execution logic for pipelines with processors that are synchronous
by avoiding (deep) recursion.
On our nightly benchmark that simulates a Logging use-case, this resulted in a 10% reduction of
CPU time spent on ingest pipelines and a 3% overall ingestion speedup. 

{es-pull}84250[#84250]

To add code highlighting to the snippets, they need to be formatted as Asciidoc code blocks. For example:

[source,yaml]
----
{
  "metrics.time" : 10,
  "metrics.time.min" : 1,
  "metrics.time.max" : 500
}
----
@debadair debadair added >bug >docs General docs changes :Delivery/Build Build or test infrastructure Team:Delivery Meta label for Delivery team v8.4.0 labels Aug 17, 2022
@elasticsearchmachine
Copy link
Collaborator

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

@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Aug 17, 2022
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-delivery (Team:Delivery)

@debadair
Copy link
Contributor Author

Updated to recommend that the link be on a new line, as there are some multi-paragraph highlights.

1 similar comment
@debadair
Copy link
Contributor Author

Updated to recommend that the link be on a new line, as there are some multi-paragraph highlights.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>bug :Delivery/Build Build or test infrastructure >docs General docs changes Team:Delivery Meta label for Delivery team Team:Docs Meta label for docs team v8.4.0
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants