Skip to content

Conversation

@jrodewig
Copy link
Contributor

@jrodewig jrodewig commented Apr 29, 2019

AsciiDoc and Asciidoctor use two separate conventions to autogenerate anchor IDs. When we migrate to Asciidoctor, this means several anchor links will break.

This explicitly sets anchor IDs for several sections and tables, which will create a stable anchor link during Asciidoctor migration.

Replaced IDs

List of IDs replaced
  • _literal_tokenizer_literal_and_literal_ignore_case_literal_are_deprecated_2
  • _literal_tokenizer_literal_and_literal_ignore_case_literal_are_deprecated
  • _literal_java_sql_literal
  • _literal_javax_sql_literal
  • _the_literal_ngram_literal_and_literal_edgengram_literal_token_filter_names_have_been_removed
  • _the_literal_accept_default_password_literal_setting_has_been_removed
  • _the_literal_roles_index_cache_literal_settings_have_been_removed
  • _sysv_literal_init_literal_vs_literal_systemd_literal
  • dissect-processor.html# id-1.17.8.24.17.3
  • _append_modifier_literal_literal
  • _append_with_order_modifier_literal_literal_and_literal_n_literal
  • _named_skip_key_literal_literal
  • _reference_keys_literal_literal_and_literal_amp_literal
  • _d_override_the_image_8217_s_default_ulink_url_https_docs_docker_com_engine_reference_run_cmd_default_command_or_options_cmd_ulink
  • _literal_refresh_wait_for_literal_can_force_a_refresh
  • _literal_scripted_upsert_literal
  • _literal_doc_as_upsert_literal
  • _literal_text_literal_only_mappings_for_strings
  • _fielddata_is_disabled_on_literal_text_literal_fields_by_default
  • _enabling_fielddata_on_literal_text_literal_fields
  • _ulink_url_http_geojson_org_geojson_spec_html_id3_linestring_ulink
  • _ulink_url_http_www_geojson_org_geojson_spec_html_id4_polygon_ulink
  • _ulink_url_http_www_geojson_org_geojson_spec_html_id5_multipoint_ulink
  • _ulink_url_http_www_geojson_org_geojson_spec_html_id6_multilinestring_ulink
  • _ulink_url_http_www_geojson_org_geojson_spec_html_id7_multipolygon_ulink
  • _ulink_url_http_geojson_org_geojson_spec_html_geometrycollection_geometry_collection_ulink
  • _indexing_replacing_documents
  • _phrase_role_xpack_x_pack_index_settings_phrase
  • _why_doesn_8217_t_elasticsearch_support_incremental_resharding
  • _querying_literal_ip_literal_fields
  • _disabling_literal__field_names_literal
  • _disabling_the_literal__source_literal_field
  • _literal_geo_point_literal_field_api
  • _monitoring_snapshot_restore_progress
  • _literal_fixed_literal
  • _literal_fixed_auto_queue_size_literal
  • _literal_scaling_literal
  • _using_literal_nested_literal_fields_for_arrays_of_objects
  • _limiting_the_number_of_literal_nested_literal_fields
  • _limiting_the_number_of_literal_nested_literal_json_objects
  • _parent_child
  • _scoring_with_literal_bool_filter_literal
  • _literal_null_value_literal_mapping
  • _literal_missing_literal_query
  • _min_max_children
  • _top_level_parameters_for_literal_ids_literal
  • _literal_fields_literal_and_per_field_boosting
  • _literal_cross_field_literal_and_analysis
  • _literal_tie_breaker_literal
  • _literal_script_score_literal
  • _literal_weight_literal
  • _literal_random_score_literal
  • _literal_field_value_factor_literal
  • _literal_decay_functions_literal
  • _parent_child_without_mapping_types
  • _can_only_aggregate_what_8217_s_been_stored
  • _sysv_literal_init_literal_vs_literal_systemd_literal_2
  • _cannot_be_nested_under_literal_breadth_first_literal_aggregations
  • _no_specialized_syntax_for_geo_date_fields
  • _literal_other_literal_bucket
  • _cannot_be_nested_under_literal_breadth_first_literal_aggregations_2
  • _size_amp_shard_size
  • _dealing_with_noisy_data_using_literal_filter_duplicate_text_literal
  • _size_amp_shard_size_2
  • search-aggregations-pipeline-avg-bucket-aggregation.html# id-1.8.5.40.3.5
  • search-aggregations-pipeline-bucket-script-aggregation.html# id-1.8.5.51.3.6
  • search-aggregations-pipeline-bucket-selector-aggregation.html# id-1.8.5.52.4.6
  • search-aggregations-pipeline-bucket-sort-aggregation.html# id-1.8.5.53.4.6
  • id-1.8.5.50.3.5
  • id-1.8.5.41.3.5
  • id-1.8.5.46.4.5
  • id-1.8.5.42.3.5
  • id-1.8.5.43.3.5
  • id-1.8.5.49.4.5
  • id-1.8.5.49.6.5.3
  • id-1.8.5.49.6.6.3
  • id-1.8.5.49.6.7.3
  • id-1.8.5.49.6.8.3
  • id-1.8.5.49.6.9.4
  • id-1.8.5.49.7.4
  • id-1.8.5.49.8.4
  • id-1.8.5.49.9.6
  • id-1.8.5.49.10.6
  • id-1.8.5.47.3.5
  • id-1.8.5.54.10.5
  • id-1.8.5.45.3.5
  • id-1.8.5.44.3.5
  • _literal_aggregations_literal_section
  • _literal_query_literal_section
  • _literal_collectors_literal_section
  • _literal_rewrite_literal_section
  • _precision_at_k_ulink_url_mailto_p_k_p_k_ulink
  • _nested_fields_in_literal_sys_columns_literal_and_literal_describe_table_literal
  • _normalized_literal_keyword_literal_fields
  • _using_link_linkend_sql_functions_aggs_first_literal_first_literal_link_link_linkend_sql_functions_aggs_last_literal_last_literal_link_aggregation_functions_in_literal_having_literal_clause
  • _using_time_data_type_in_group_by_or_xref_linkend_sql_functions_grouping_histogram
  • _ssl_tls_configuration
  • _running_elasticsearch_with_sysv_literal_init_literal
  • _running_elasticsearch_with_literal_systemd_literal
  • _running_elasticsearch_with_sysv_literal_init_literal_2
  • _running_elasticsearch_with_literal_systemd_literal_2
  • id-1.18.10.11
  • _don_8217_t_use_default_dynamic_string_mappings
  • _disable_literal__source_literal
  • _use_literal_best_compression_literal
  • _use_multiple_workers_threads_to_send_data_to_elasticsearch
  • _consider_mapping_identifiers_as_literal_keyword_literal
  • _use_literal_preference_literal_to_optimize_cache_utilization

Remaining Autogenerated IDs

The ssl-settings.asciidoc file is included in several other files:

For each included file, separate IDs are created for ssl-settings.asciidoc heading. I couldn't figure out a way to explicitly set IDs for these sections without:

A. Breaking AsciiDoc
OR
B. Separating ssl-settings.asciidoc into multiple files for each heading

Option B didn't seem worth it due to increased complexity for maintaining the docs.

List of remaining autogenerated IDs
  • _pkcs_11_tokens
  • _pkcs_11_tokens_2
  • _pkcs_11_tokens_3
  • _pkcs_11_tokens_4
  • _pkcs_12_files
  • _pkcs_12_files_2
  • _pkcs_12_files_3
  • _pkcs_12_files_4
  • _http_tls_ssl_key_and_trusted_certificate_settings
  • _transport_tls_ssl_key_and_trusted_certificate_settings
  • _watcher_tls_ssl_key_and_trusted_certificate_settings
  • _x_pack_monitoring_tls_ssl_key_and_trusted_certificate_settings

Backporting

I plan to backport as many changes as possible as far back as possible.

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs

@nik9000
Copy link
Member

nik9000 commented Apr 30, 2019

I plan to backport as many changes as possible as far back as possible.

+1. I expect there are very few links to these anchors and those that exist will bounce to the page's heading instead which is OK. Not great, but ok.

Copy link
Member

@nik9000 nik9000 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jrodewig jrodewig merged commit adf6705 into elastic:master Apr 30, 2019
@jrodewig jrodewig deleted the asciidoctor-fix-ids branch April 30, 2019 14:19
akhil10x5 pushed a commit to akhil10x5/elasticsearch that referenced this pull request May 2, 2019
gurkankaymak pushed a commit to gurkankaymak/elasticsearch that referenced this pull request May 27, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants