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] Fix Asciidoctor errors to prepare for migration #41128

Closed
jrodewig opened this issue Apr 11, 2019 · 5 comments
Closed

[DOCS] Fix Asciidoctor errors to prepare for migration #41128

jrodewig opened this issue Apr 11, 2019 · 5 comments
Assignees
Labels
>docs General docs changes Meta

Comments

@jrodewig
Copy link
Contributor

jrodewig commented Apr 11, 2019

To prepare the Elasticsearch Reference Guide for Asciidoctor migration, we need to find and fix any syntax that might cause errors.

You can view these errors using this build_docs command:
$GIT_HOME/docs/build_docs --asciidoctor --doc $GIT_HOME/elasticsearch/docs/reference/index.asciidoc --resource=$GIT_HOME/elasticsearch/x-pack/docs/ --chunk 1 --lenient

Below is a list of files containing errors. If you correct one of these errors, please check the appropriate box and reference this ticket in your PR.

Bad links

Asciidoc and Asciidoctor use different conventions to autogenerate IDs. In some cases, we've linked to sections using these autogenerated IDs.

To prevent those links from breaking, we'll need to explicitly set an ID for the target section, update the outgoing link, or both.

  • /tmp/docsbuild/target_repo/html/en/elasticsearch/client/java-rest/5.6/java-rest-high-search.html: ([DOCS] Fix Bad Links in Java High-Level Search API Docs for Asciidoctor Migration #41505)
    • en/elasticsearch/reference/5.6/_profiling_queries.html#_literal_collectors_literal_section
    • en/elasticsearch/reference/5.6/_profiling_queries.html#_literal_query_literal_section
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/client/java-rest/6.0/java-rest-high-search.html:
    • en/elasticsearch/reference/6.0/_profiling_queries.html#_literal_collectors_literal_section
    • en/elasticsearch/reference/6.0/_profiling_queries.html#_literal_query_literal_section
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/client/java-rest/6.1/java-rest-high-search.html: ([DOCS] Fix Bad Links in Java High-Level Search API Docs for Asciidoctor Migration #41505)
    • en/elasticsearch/reference/6.1/_profiling_queries.html#_literal_collectors_literal_section
    • en/elasticsearch/reference/6.1/_profiling_queries.html#_literal_query_literal_section
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/client/java-rest/6.2/java-rest-high-search.html: ([DOCS] Fix Bad Links in Java High-Level Search API Docs for Asciidoctor Migration #41505)
    • en/elasticsearch/reference/6.2/_profiling_queries.html#_literal_collectors_literal_section
    • en/elasticsearch/reference/6.2/_profiling_queries.html#_literal_query_literal_section
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/client/java-rest/6.3/java-rest-high-search.html: ([DOCS] Fix Bad Links in Java High-Level Search API Docs for Asciidoctor Migration #41505)
    • en/elasticsearch/reference/6.3/_profiling_queries.html#_literal_collectors_literal_section
    • en/elasticsearch/reference/6.3/_profiling_queries.html#_literal_query_literal_section
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/client/java-rest/6.4/java-rest-high-search.html: ([DOCS] Fix Bad Links in Java High-Level Search API Docs for Asciidoctor Migration #41505)
    • en/elasticsearch/reference/6.4/_profiling_queries.html#_literal_collectors_literal_section
    • en/elasticsearch/reference/6.4/_profiling_queries.html#_literal_query_literal_section
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/client/java-rest/6.5/java-rest-high-search.html: ([DOCS] Fix Bad Links in Java High-Level Search API Docs for Asciidoctor Migration #41505)
    • en/elasticsearch/reference/6.5/_profiling_queries.html#_literal_collectors_literal_section
    • en/elasticsearch/reference/6.5/_profiling_queries.html#_literal_query_literal_section
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/client/net-api/5.x/nest-breaking-changes.html:
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/5.6/migration-api-deprecation.html: ([DOCS] Specify ID to prepare for Asciidoctor migration #41512)
    • en/elasticsearch/reference/6.0/breaking_60_indices_changes.html#_index_templates_use_literal_index_patterns_literal_instead_of_literal_template_literal
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/6.0/migration-api-deprecation.html: ([DOCS] Specify ID to prepare for Asciidoctor migration #41512)
    • en/elasticsearch/reference/6.0/breaking_60_indices_changes.html#_index_templates_use_literal_index_patterns_literal_instead_of_literal_template_literal
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/6.1/migration-api-deprecation.html: ([DOCS] Specify ID to prepare for Asciidoctor migration #41512)
    • en/elasticsearch/reference/6.0/breaking_60_indices_changes.html#_index_templates_use_literal_index_patterns_literal_instead_of_literal_template_literal
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/6.2/migration-api-deprecation.html: ([DOCS] Specify ID to prepare for Asciidoctor migration #41512)
    • en/elasticsearch/reference/6.0/breaking_60_indices_changes.html#_index_templates_use_literal_index_patterns_literal_instead_of_literal_template_literal
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/6.3/migration-api-deprecation.html: ([DOCS] Specify ID to prepare for Asciidoctor migration #41512)
    • en/elasticsearch/reference/6.0/breaking_60_indices_changes.html#_index_templates_use_literal_index_patterns_literal_instead_of_literal_template_literal
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/6.4/migration-api-deprecation.html: ([DOCS] Specify ID to prepare for Asciidoctor migration #41512)
    • en/elasticsearch/reference/6.0/breaking_60_indices_changes.html#_index_templates_use_literal_index_patterns_literal_instead_of_literal_template_literal
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/6.5/migration-api-deprecation.html: ([DOCS] Specify ID to prepare for Asciidoctor migration #41512)
    • en/elasticsearch/reference/6.0/breaking_60_indices_changes.html#_index_templates_use_literal_index_patterns_literal_instead_of_literal_template_literal
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/6.6/migration-api-deprecation.html: (Docs: Specify two IDs in migration docs #41501)
    • en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_cluster_name
    • en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_index_name
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/6.7/migration-api-deprecation.html: (Docs: Specify two IDs in migration docs #41501)
    • en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_cluster_name
    • en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_index_name
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/7.0/migration-api-deprecation.html: (Docs: Specify two IDs in migration docs #41501)
    • en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_cluster_name
    • en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_index_name
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/current/migration-api-deprecation.html: (Docs: Specify two IDs in migration docs #41501)
    • en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_cluster_name
    • en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_index_name
  • /tmp/docsbuild/target_repo/html/en/elasticsearch/reference/master/migration-api-deprecation.html: (Docs: Specify two IDs in migration docs #41501)
    • en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_cluster_name
    • en/elasticsearch/reference/7.0/breaking-changes-7.0.html#_literal_literal_is_no_longer_allowed_in_index_name

IDs to clean up

Asciidoc and Asciidoctor use different conventions to autogenerate IDs. Some page URLs contain these autogenerated IDs.

To prevent those URLs from breaking, we'll need to explicitly set an ID for the target sections.

@jrodewig jrodewig added >docs General docs changes Meta :Docs labels Apr 11, 2019
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@jrodewig jrodewig self-assigned this Apr 11, 2019
nik9000 added a commit to nik9000/elasticsearch that referenced this issue Apr 15, 2019
Drops "inline callouts" from the docs for SQL conditionals because they
aren't supported by Asciidoctor.

Relates to elastic#41128
nik9000 added a commit that referenced this issue Apr 16, 2019
Drops "inline callouts" from the docs for SQL conditionals because they
aren't supported by Asciidoctor.

Relates to #41128
nik9000 added a commit that referenced this issue Apr 16, 2019
Drops "inline callouts" from the docs for SQL conditionals because they
aren't supported by Asciidoctor.

Relates to #41128
nik9000 added a commit that referenced this issue Apr 16, 2019
Drops "inline callouts" from the docs for SQL conditionals because they
aren't supported by Asciidoctor.

Relates to #41128
nik9000 added a commit that referenced this issue Apr 16, 2019
Drops "inline callouts" from the docs for SQL conditionals because they
aren't supported by Asciidoctor.

Relates to #41128
nik9000 added a commit that referenced this issue Apr 16, 2019
Drops "inline callouts" from the docs for SQL conditionals because they
aren't supported by Asciidoctor.

Relates to #41128
@jrodewig
Copy link
Contributor Author

jrodewig commented Apr 18, 2019

As of this writing, we have open or closed PRs to address the above errors. I plan to merge any of my open PRs once I get dedicated time to backport and monitor the builds.

Big thanks to @lcawl and @nik9000 for their work and guidance!

@jrodewig
Copy link
Contributor Author

jrodewig commented Apr 23, 2019

Spoke to @nik9000 and discovered two more errors in master branch:

@jrodewig
Copy link
Contributor Author

Added some bad links @nik9000 found in elastic/docs#827 (comment)

@jrodewig
Copy link
Contributor Author

@nik9000 and I are tracking any remaining work in elastic/docs#827. Closing this so we don't have to maintain two sources.

gurkankaymak pushed a commit to gurkankaymak/elasticsearch that referenced this issue May 27, 2019
Drops "inline callouts" from the docs for SQL conditionals because they
aren't supported by Asciidoctor.

Relates to elastic#41128
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
>docs General docs changes Meta
Projects
None yet
Development

No branches or pull requests

2 participants