GEODE-2498 Revise published 1.1.0 manual, so it has no references to 1.0.0-incubating
Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/7f0f4d5f Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/7f0f4d5f Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/7f0f4d5f Branch: refs/heads/master Commit: 7f0f4d5f92ea04ff48c5dae823848636c910e06b Parents: 0513276 Author: Karen Miller <kmil...@pivotal.io> Authored: Thu Feb 16 15:37:16 2017 -0800 Committer: Karen Miller <kmil...@pivotal.io> Committed: Thu Feb 16 15:37:16 2017 -0800 ---------------------------------------------------------------------- geode-docs/about_geode.html.md.erb | 2 +- geode-docs/prereq_and_install.html.md.erb | 2 +- .../website/content/docs/guide/11/CONTRIBUTE | 54 + .../content/docs/guide/11/about_geode.html | 3221 ++++++++ .../docs/guide/11/basic_config/book_intro.html | 3234 ++++++++ .../config_concepts/chapter_overview.html | 3234 ++++++++ ...distributed_system_member_configuration.html | 3250 ++++++++ .../config_concepts/local_vs_remote.html | 3224 ++++++++ .../chapter_overview.html | 3228 ++++++++ .../managing_data_entries.html | 3327 ++++++++ .../using_custom_classes.html | 3253 ++++++++ .../data_regions/chapter_overview.html | 3244 ++++++++ .../data_regions/create_a_region_with_gfsh.html | 3239 ++++++++ .../creating_custom_attributes.html | 3262 ++++++++ .../data_regions/managing_data_regions.html | 3501 +++++++++ .../managing_region_attributes.html | 3297 ++++++++ .../data_regions/new_region_existing_data.html | 3223 ++++++++ .../data_regions/region_naming.html | 3229 ++++++++ .../data_regions/region_shortcuts.html | 3328 ++++++++ .../store_retrieve_region_shortcuts.html | 3270 ++++++++ .../setting_distributed_properties.html | 3272 ++++++++ .../the_cache/chapter_overview.html | 3240 ++++++++ .../the_cache/intro_cache_management.html | 3293 ++++++++ .../the_cache/managing_a_client_cache.html | 3268 ++++++++ .../the_cache/managing_a_multiuser_cache.html | 3262 ++++++++ .../the_cache/managing_a_peer_server_cache.html | 3270 ++++++++ .../the_cache/managing_a_secure_cache.html | 3256 ++++++++ .../the_cache/setting_cache_initializer.html | 3262 ++++++++ .../the_cache/setting_cache_properties.html | 3237 ++++++++ .../guide/11/configuring/chapter_overview.html | 3269 ++++++++ .../deploying_application_jars.html | 3298 ++++++++ .../cluster_config/export-import.html | 3245 ++++++++ .../gfsh_config_troubleshooting.html | 3272 ++++++++ .../gfsh_load_from_shared_dir.html | 3240 ++++++++ .../cluster_config/gfsh_persist.html | 3337 ++++++++ .../configuring/cluster_config/gfsh_remote.html | 3275 ++++++++ .../persisting_configurations.html | 3478 +++++++++ .../cluster_config/using_member_groups.html | 3241 ++++++++ .../configuring/running/change_file_spec.html | 3245 ++++++++ .../configuring/running/default_file_specs.html | 3275 ++++++++ .../running/deploy_config_files_intro.html | 3235 ++++++++ .../running/deploying_config_files.html | 3239 ++++++++ .../running/deploying_config_jar_files.html | 3248 ++++++++ .../running/firewall_ports_config.html | 3228 ++++++++ .../running/firewalls_connections.html | 3232 ++++++++ .../running/firewalls_multisite.html | 3282 ++++++++ .../11/configuring/running/firewalls_ports.html | 3441 ++++++++ .../running/managing_output_files.html | 3228 ++++++++ .../running/running_the_cacheserver.html | 3354 ++++++++ .../running/running_the_locator.html | 3410 ++++++++ .../running/starting_up_shutting_down.html | 3327 ++++++++ .../docs/guide/11/developing/book_intro.html | 3260 ++++++++ .../continuous_querying/chapter_overview.html | 3233 ++++++++ .../continuous_querying_whats_next.html | 3343 ++++++++ .../how_continuous_querying_works.html | 3309 ++++++++ .../implementing_continuous_querying.html | 3394 ++++++++ .../PDX_Serialization_Features.html | 3237 ++++++++ .../data_serialization/auto_serialization.html | 3328 ++++++++ ...erialization_with_class_pattern_strings.html | 3264 ++++++++ .../data_serialization/chapter_overview.html | 3234 ++++++++ .../data_serialization_options.html | 3301 ++++++++ .../extending_the_autoserializer.html | 3321 ++++++++ .../gemfire_data_serialization.html | 3246 ++++++++ .../gemfire_pdx_serialization.html | 3252 ++++++++ .../data_serialization/java_serialization.html | 3224 ++++++++ .../jsonformatter_pdxinstances.html | 3258 ++++++++ .../persist_pdx_metadata_to_disk.html | 3248 ++++++++ .../program_application_for_pdx.html | 3300 ++++++++ .../use_pdx_high_level_steps.html | 3244 ++++++++ .../use_pdx_serializable.html | 3306 ++++++++ .../data_serialization/use_pdx_serializer.html | 3331 ++++++++ .../using_PdxInstanceFactory.html | 3243 ++++++++ .../using_pdx_region_entry_keys.html | 3226 ++++++++ .../delta_propagation/chapter_overview.html | 3240 ++++++++ .../delta_propagation_example.html | 3326 ++++++++ .../delta_propagation_properties.html | 3288 ++++++++ .../errors_in_delta_propagation.html | 3238 ++++++++ .../how_delta_propagation_works.html | 3277 ++++++++ .../implementing_delta_propagation.html | 3241 ++++++++ .../when_to_use_delta_prop.html | 3231 ++++++++ .../distributed_regions/chapter_overview.html | 3237 ++++++++ .../choosing_level_of_dist.html | 3232 ++++++++ .../how_distribution_works.html | 3245 ++++++++ .../how_region_versioning_works.html | 3324 ++++++++ .../how_region_versioning_works_wan.html | 3239 ++++++++ .../how_replication_works.html | 3249 ++++++++ .../locking_in_global_regions.html | 3296 ++++++++ .../managing_distributed_regions.html | 3250 ++++++++ .../region_entry_versions.html | 3242 ++++++++ .../events/cache_event_handler_examples.html | 3331 ++++++++ .../11/developing/events/chapter_overview.html | 3237 ++++++++ ...configure_client_server_event_messaging.html | 3276 ++++++++ .../configure_multisite_event_messaging.html | 3234 ++++++++ .../events/configure_p2p_event_messaging.html | 3245 ++++++++ .../configuring_gateway_concurrency_levels.html | 3346 ++++++++ ...iguring_highly_available_gateway_queues.html | 3302 ++++++++ .../configuring_highly_available_servers.html | 3260 ++++++++ .../conflate_multisite_gateway_queue.html | 3311 ++++++++ .../conflate_server_subscription_queue.html | 3242 ++++++++ .../events/event_handler_overview.html | 3234 ++++++++ .../events/filtering_multisite_events.html | 3306 ++++++++ .../events/ha_event_messaging_whats_next.html | 3285 ++++++++ .../events/how_cache_events_work.html | 3278 ++++++++ .../how_client_server_distribution_works.html | 3358 ++++++++ .../11/developing/events/how_events_work.html | 3314 ++++++++ .../how_multisite_distribution_works.html | 3272 ++++++++ .../implementing_cache_event_handlers.html | 3337 ++++++++ ...menting_durable_client_server_messaging.html | 3397 ++++++++ ...implementing_write_behind_event_handler.html | 3417 ++++++++ .../limit_server_subscription_queue_size.html | 3261 ++++++++ .../list_of_event_handlers_and_events.html | 3376 ++++++++ .../events/resolving_multisite_conflicts.html | 3271 ++++++++ .../tune_client_message_tracking_timeout.html | 3242 ++++++++ .../tune_client_server_event_messaging.html | 3232 ++++++++ ...writing_callbacks_that_modify_the_cache.html | 3261 ++++++++ .../developing/eviction/chapter_overview.html | 3230 ++++++++ .../eviction/configuring_data_eviction.html | 3277 ++++++++ .../developing/eviction/how_eviction_works.html | 3235 ++++++++ .../developing/expiration/chapter_overview.html | 3228 ++++++++ .../expiration/configuring_data_expiration.html | 3274 ++++++++ .../expiration/how_expiration_works.html | 3271 ++++++++ .../function_exec/chapter_overview.html | 3231 ++++++++ .../function_exec/function_execution.html | 3454 +++++++++ .../how_function_execution_works.html | 3336 ++++++++ .../chapter_overview.html | 3234 ++++++++ .../outside_data_sources/chapter_overview.html | 3234 ++++++++ .../how_data_loaders_work.html | 3249 ++++++++ .../implementing_data_loaders.html | 3282 ++++++++ .../outside_data_sources/sync_outside_data.html | 3231 ++++++++ .../automated_rebalance.html | 3264 ++++++++ .../partitioned_regions/chapter_overview.html | 3253 ++++++++ .../checking_region_redundancy.html | 3244 ++++++++ .../colocating_partitioned_region_data.html | 3327 ++++++++ .../configure_pr_single_hop.html | 3228 ++++++++ .../configuring_bucket_for_pr.html | 3262 ++++++++ .../configuring_ha_for_pr.html | 3255 ++++++++ ...custom_partitioning_and_data_colocation.html | 3259 ++++++++ .../how_partitioning_works.html | 3256 ++++++++ .../partitioned_regions/how_pr_ha_works.html | 3263 ++++++++ .../how_pr_single_hop_works.html | 3247 ++++++++ .../join_query_partitioned_regions.html | 3283 ++++++++ .../managing_partitioned_regions.html | 3241 ++++++++ .../moving_partitioned_data.html | 3265 ++++++++ ...custom_partitioning_and_data_colocation.html | 3231 ++++++++ .../overview_how_pr_ha_works.html | 3228 ++++++++ .../overview_how_pr_single_hop_works.html | 3228 ++++++++ .../rebalancing_pr_data.html | 3297 ++++++++ .../set_crash_redundancy_recovery.html | 3260 ++++++++ .../set_enforce_unique_host.html | 3226 ++++++++ .../set_join_redundancy_recovery.html | 3266 ++++++++ .../partitioned_regions/set_pr_redundancy.html | 3240 ++++++++ .../set_redundancy_zones.html | 3235 ++++++++ .../using_custom_partition_resolvers.html | 3416 ++++++++ .../query_additional/advanced_querying.html | 3240 ++++++++ .../query_additional/case_sensitivity.html | 3225 ++++++++ .../developing/query_additional/literals.html | 3284 ++++++++ .../developing/query_additional/operators.html | 3271 ++++++++ .../order_by_on_partitioned_regions.html | 3227 ++++++++ .../partitioned_region_key_or_field_value.html | 3278 ++++++++ .../partitioned_region_query_restrictions.html | 3241 ++++++++ .../query_additional/query_debugging.html | 3274 ++++++++ .../query_language_features.html | 3231 ++++++++ .../query_on_a_single_node.html | 3357 ++++++++ .../query_additional/supported_keywords.html | 3341 ++++++++ .../using_query_bind_parameters.html | 3256 ++++++++ .../query_index/create_multiple_indexes.html | 3258 ++++++++ .../query_index/creating_an_index.html | 3289 ++++++++ .../query_index/creating_hash_indexes.html | 3258 ++++++++ .../query_index/creating_key_indexes.html | 3254 ++++++++ .../query_index/creating_map_indexes.html | 3244 ++++++++ .../developing/query_index/index_samples.html | 3269 ++++++++ .../indexes_on_single_region_queries.html | 3238 ++++++++ .../indexes_with_overflow_regions.html | 3246 ++++++++ .../query_index/indexing_guidelines.html | 3241 ++++++++ .../query_index/maintaining_indexes.html | 3262 ++++++++ .../11/developing/query_index/query_index.html | 3264 ++++++++ .../query_index/query_index_hints.html | 3229 ++++++++ .../using_indexes_with_equijoin_queries.html | 3281 ++++++++ ..._with_equijoin_queries_multiple_regions.html | 3323 ++++++++ .../11/developing/query_select/aggregates.html | 3300 ++++++++ .../query_select/the_from_clause.html | 3278 ++++++++ .../query_select/the_import_statement.html | 3223 ++++++++ .../query_select/the_select_statement.html | 3372 ++++++++ .../query_select/the_where_clause.html | 3498 +++++++++ .../querying_basics/chapter_overview.html | 3233 ++++++++ .../comments_in_query_strings.html | 3222 ++++++++ .../monitor_queries_for_low_memory.html | 3235 ++++++++ .../querying_basics/oql_compared_to_sql.html | 3228 ++++++++ .../performance_considerations.html | 3230 ++++++++ .../querying_basics/query_basics.html | 3244 ++++++++ .../query_grammar_and_reserved_words.html | 3352 ++++++++ .../querying_partitioned_regions.html | 3233 ++++++++ .../querying_basics/reserved_words.html | 3318 ++++++++ .../restrictions_and_unsupported_features.html | 3230 ++++++++ .../querying_basics/running_a_query.html | 3278 ++++++++ .../supported_character_sets.html | 3219 ++++++++ .../querying_basics/what_is_a_query_string.html | 3246 ++++++++ .../region_options/chapter_overview.html | 3234 ++++++++ .../data_hosts_and_accessors.html | 3228 ++++++++ .../region_options/dynamic_region_creation.html | 3386 ++++++++ .../developing/region_options/region_types.html | 3351 ++++++++ .../storage_distribution_options.html | 3238 ++++++++ .../storing_data_on_disk/chapter_overview.html | 3236 ++++++++ .../how_persist_overflow_work.html | 3261 ++++++++ .../overflow_config_examples.html | 3244 ++++++++ .../storing_data_on_disk.html | 3281 ++++++++ .../transactions/JTA_transactions.html | 3416 ++++++++ .../transactions/about_transactions.html | 3243 ++++++++ .../transactions/cache_plugins_with_jta.html | 3223 ++++++++ .../cache_transaction_performance.html | 3226 ++++++++ .../transactions/cache_transactions.html | 3242 ++++++++ .../cache_transactions_by_region_type.html | 3358 ++++++++ .../transactions/chapter_overview.html | 3239 ++++++++ .../client_server_transactions.html | 3248 ++++++++ .../configuring_db_connections_using_JNDI.html | 3502 +++++++++ .../data_location_cache_transactions.html | 3242 ++++++++ .../how_cache_transactions_work.html | 3271 ++++++++ .../transactions/jca_adapter_example.html | 3243 ++++++++ .../monitor_troubleshoot_transactions.html | 3256 ++++++++ .../transactions/run_a_cache_transaction.html | 3310 ++++++++ ...un_a_cache_transaction_with_external_db.html | 3247 ++++++++ .../transaction_coding_examples.html | 3237 ++++++++ .../transaction_event_management.html | 3245 ++++++++ .../transaction_jta_gemfire_example.html | 3240 ++++++++ .../transactions/transaction_semantics.html | 3251 ++++++++ .../transaction_suspend_resume_example.html | 3230 ++++++++ .../transactional_and_nontransactional_ops.html | 3436 ++++++++ .../transactional_function_example.html | 3264 ++++++++ .../transactions/transactions_overview.html | 3259 ++++++++ .../transactions/turning_off_jta.html | 3232 ++++++++ .../transactions/working_with_transactions.html | 3401 ++++++++ .../15_minute_quickstart_gfsh.html | 3630 +++++++++ .../guide/11/getting_started/book_intro.html | 3234 ++++++++ .../11/getting_started/geode_overview.html | 3234 ++++++++ .../installation/install_standalone.html | 3294 ++++++++ .../guide/11/getting_started/product_intro.html | 3300 ++++++++ .../querying_quick_reference.html | 3684 +++++++++ .../11/getting_started/setup_classpath.html | 3296 ++++++++ .../system_requirements/host_machine.html | 3250 ++++++++ .../11/getting_started/uninstall_geode.html | 3221 ++++++++ .../11/images/ClientServerAdvancedTopics-5.gif | Bin 0 -> 10798 bytes .../11/images/ClientServerAdvancedTopics-6.gif | Bin 0 -> 12056 bytes .../11/images/ClientServerAdvancedTopics-7.gif | Bin 0 -> 5000 bytes .../guide/11/images/ContinuousQuerying-1.gif | Bin 0 -> 6955 bytes .../guide/11/images/ContinuousQuerying-3.gif | Bin 0 -> 9141 bytes .../docs/guide/11/images/DataManagement-9.png | Bin 0 -> 48188 bytes .../docs/guide/11/images/DeltaPropagation-1.gif | Bin 0 -> 7593 bytes .../docs/guide/11/images/DeltaPropagation-3.gif | Bin 0 -> 6843 bytes .../content/docs/guide/11/images/Events-2.gif | Bin 0 -> 8793 bytes .../content/docs/guide/11/images/Events-3.gif | Bin 0 -> 6432 bytes .../docs/guide/11/images/FuncExecOnMembers.png | Bin 0 -> 64959 bytes .../11/images/FuncExecOnRegionHAWithFilter.png | Bin 0 -> 80141 bytes .../11/images/FuncExecOnRegionNoMetadata.png | Bin 0 -> 70177 bytes .../images/FuncExecOnRegionPeersWithFilter.png | Bin 0 -> 86576 bytes .../11/images/FuncExecOnRegionWithFilter.png | Bin 0 -> 60773 bytes .../11/images/FuncExecOnRegionWithMetadata.png | Bin 0 -> 59576 bytes .../docs/guide/11/images/FuncExecOnServers.png | Bin 0 -> 57470 bytes .../content/docs/guide/11/images/Gemcached.png | Bin 0 -> 87366 bytes .../content/docs/guide/11/images/JConsole.png | Bin 0 -> 64272 bytes .../docs/guide/11/images/MultiSite-4.gif | Bin 0 -> 4991 bytes .../images/MultisiteConcurrency_WAN_Gateway.png | Bin 0 -> 103701 bytes .../guide/11/images/SQLite_Persistence_Mgr.png | Bin 0 -> 58388 bytes .../11/images/Statistics-implementation.png | Bin 0 -> 28057 bytes .../guide/11/images/Statistics-interfaces.png | Bin 0 -> 28312 bytes .../docs/guide/11/images/Transaction-simple.png | Bin 0 -> 119831 bytes .../guide/11/images/consistent_multisite.png | Bin 0 -> 39442 bytes .../docs/guide/11/images/diskStores-1.gif | Bin 0 -> 7292 bytes .../docs/guide/11/images/diskStores-3.gif | Bin 0 -> 5898 bytes .../docs/guide/11/images/jconsole_mbeans.png | Bin 0 -> 211394 bytes .../content/docs/guide/11/images/jvisualvm.png | Bin 0 -> 90153 bytes .../content/docs/guide/11/images/logging-1.gif | Bin 0 -> 2778 bytes .../docs/guide/11/images/member_view_list.png | Bin 0 -> 107811 bytes .../11/images/multisite-topology-avoid-3.png | Bin 0 -> 9794 bytes .../11/images/multisite-topology-hybrid-1.png | Bin 0 -> 7627 bytes .../11/images/multisite-topology-hybrid-2.png | Bin 0 -> 7631 bytes .../11/images/multisite-topology-parallel.png | Bin 0 -> 7838 bytes .../11/images/multisite-topology-serial.png | Bin 0 -> 6886 bytes .../docs/guide/11/images/parallel_sender.png | Bin 0 -> 36089 bytes .../docs/guide/11/images/pulse-data-browser.png | Bin 0 -> 99987 bytes .../guide/11/images/pulse-region-detail.png | Bin 0 -> 61149 bytes .../guide/11/images/pulse_alerts_widget.png | Bin 0 -> 137883 bytes .../docs/guide/11/images/pulse_cluster_view.png | Bin 0 -> 154531 bytes .../docs/guide/11/images/pulse_data_view.png | Bin 0 -> 138140 bytes .../docs/guide/11/images/pulse_locator.png | Bin 0 -> 228513 bytes .../docs/guide/11/images/pulse_member_view.png | Bin 0 -> 132309 bytes .../11/images/rest_example_java_packages.png | Bin 0 -> 30206 bytes .../content/docs/guide/11/images/security-1.gif | Bin 0 -> 8343 bytes .../content/docs/guide/11/images/security-3.gif | Bin 0 -> 8287 bytes .../content/docs/guide/11/images/security-4.gif | Bin 0 -> 7028 bytes .../content/docs/guide/11/images/security-5.gif | Bin 0 -> 7408 bytes .../docs/guide/11/images/serial_sender.png | Bin 0 -> 32385 bytes .../docs/guide/11/images/swagger_home.png | Bin 0 -> 187378 bytes .../guide/11/images/swagger_post_region.png | Bin 0 -> 170963 bytes .../11/images/swagger_post_region_response.png | Bin 0 -> 176783 bytes .../content/docs/guide/11/images/swagger_v1.png | Bin 0 -> 149806 bytes .../guide/11/images/swagger_v1_response.png | Bin 0 -> 143134 bytes .../guide/11/images/transactions-client-1.png | Bin 0 -> 113816 bytes .../11/images/transactions_jca_adapter.png | Bin 0 -> 104775 bytes .../docs/guide/11/images/transactions_jta.png | Bin 0 -> 104780 bytes .../11/images/transactions_jta_app_server.png | Bin 0 -> 91885 bytes .../guide/11/images_svg/JMX_Architecture.svg | 3 + .../content/docs/guide/11/images_svg/MBeans.svg | 3 + .../async_system_queue_conflation.svg | 3 + .../guide/11/images_svg/cache_data_loader.svg | 3 + .../guide/11/images_svg/cache_data_loader_2.svg | 3 + .../11/images_svg/client_server_deployment.svg | 3 + .../11/images_svg/client_server_event_dist.svg | 3 + .../client_server_message_tracking.svg | 3 + .../11/images_svg/cluster-group-config.svg | 3 + .../11/images_svg/cluster_config_overview.svg | 3 + .../colocated_partitioned_regions.svg | 3 + .../guide/11/images_svg/cs_connection_pool.svg | 3 + .../11/images_svg/cs_locator_discovery.svg | 3 + .../guide/11/images_svg/cs_subscriptions.svg | 3 + .../docs/guide/11/images_svg/cs_topology.svg | 3 + .../guide/11/images_svg/custom_partitioned.svg | 3 + .../guide/11/images_svg/developing_overflow.svg | 3 + .../11/images_svg/developing_persistence.svg | 3 + .../developing_persistence_and_overflow.svg | 3 + .../guide/11/images_svg/distributed_how_1.svg | 3 + .../guide/11/images_svg/distributed_how_2.svg | 3 + .../guide/11/images_svg/distributed_how_3.svg | 3 + .../guide/11/images_svg/distributed_preload.svg | 3 + .../guide/11/images_svg/distributed_replica.svg | 3 + .../images_svg/distributed_replica_preload.svg | 3 + .../docs/guide/11/images_svg/expiration.svg | 3 + .../11/images_svg/how_partitioning_works_1.svg | 3 + .../11/images_svg/how_partitioning_works_2.svg | 3 + .../images_svg/http_module_cs_with_locator.svg | 3 + .../images_svg/http_module_p2p_with_locator.svg | 3 + .../guide/11/images_svg/locator_discovery.svg | 3 + .../guide/11/images_svg/member_severe_alert.svg | 3 + .../images_svg/network_partition_scenario.svg | 3 + .../docs/guide/11/images_svg/p2p_topology.svg | 3 + .../guide/11/images_svg/partitioned_data_HA.svg | 3 + .../images_svg/partitioned_data_buckets_1.svg | 3 + .../images_svg/partitioned_data_buckets_2.svg | 3 + .../11/images_svg/region_entry_versions_1.svg | 3 + .../11/images_svg/region_entry_versions_2.svg | 3 + .../11/images_svg/region_entry_versions_3.svg | 3 + .../11/images_svg/server_client_event_dist.svg | 3 + .../guide/11/images_svg/server_discovery.svg | 3 + .../guide/11/images_svg/server_grouping.svg | 3 + .../images_svg/transactions_partitioned_1.svg | 3 + .../images_svg/transactions_partitioned_2.svg | 3 + .../11/images_svg/transactions_replicate_1.svg | 3 + .../11/images_svg/transactions_replicate_2.svg | 3 + .../11/images_svg/transactions_replicate_3.svg | 3 + .../11/images_svg/transactions_replicate_4.svg | 3 + .../transactions_replicate_local_1.svg | 3 + .../transactions_replicate_no_ack_1.svg | 3 + .../transactions_replicate_no_ack_2.svg | 3 + .../11/images_svg/tune_cs_event_messaging.svg | 3 + .../unbalanced_network_capacity_probs.svg | 3 + .../autoreconnect/member-reconnect.html | 3274 ++++++++ .../docs/guide/11/managing/book_intro.html | 3256 ++++++++ .../cache_snapshots/chapter_overview.html | 3244 ++++++++ .../cache_snapshots/exporting_a_snapshot.html | 3259 ++++++++ .../filtering_snapshot_entries.html | 3238 ++++++++ .../cache_snapshots/importing_a_snapshot.html | 3268 ++++++++ .../read_snapshots_programmatically.html | 3235 ++++++++ .../using_cache_and_region_snapshots.html | 3238 ++++++++ .../disk_storage/backup_restore_disk_store.html | 3378 ++++++++ .../managing/disk_storage/chapter_overview.html | 3246 ++++++++ .../disk_storage/compacting_disk_stores.html | 3328 ++++++++ .../disk_free_space_monitoring.html | 3250 ++++++++ .../disk_store_configuration_params.html | 3329 ++++++++ .../disk_storage/file_names_and_extensions.html | 3355 ++++++++ .../handling_missing_disk_stores.html | 3267 ++++++++ .../disk_storage/how_disk_stores_work.html | 3262 ++++++++ .../keeping_offline_disk_store_in_sync.html | 3256 ++++++++ .../managing_disk_buffer_flushes.html | 3235 ++++++++ .../disk_storage/managing_disk_stores.html | 3233 ++++++++ .../disk_storage/managing_disk_stores_cmds.html | 3295 ++++++++ .../managing/disk_storage/operation_logs.html | 3257 ++++++++ .../optimize_availability_and_performance.html | 3229 ++++++++ .../overview_using_disk_stores.html | 3231 ++++++++ .../starting_system_with_disk_stores.html | 3328 ++++++++ .../disk_storage/using_disk_stores.html | 3393 ++++++++ .../using_the_default_disk_store.html | 3257 ++++++++ .../disk_storage/validating_disk_store.html | 3231 ++++++++ .../11/managing/heap_use/heap_management.html | 3420 ++++++++ .../guide/11/managing/heap_use/lock_memory.html | 3239 ++++++++ .../managing/heap_use/off_heap_management.html | 3397 ++++++++ .../11/managing/logging/configuring_log4j2.html | 3261 ++++++++ .../11/managing/logging/how_logging_works.html | 3234 ++++++++ .../docs/guide/11/managing/logging/logging.html | 3237 ++++++++ .../11/managing/logging/logging_categories.html | 3413 ++++++++ .../11/managing/logging/logging_whats_next.html | 3246 ++++++++ .../11/managing/logging/setting_up_logging.html | 3263 ++++++++ .../management/configuring_rmi_connector.html | 3231 ++++++++ .../management/gfsh_and_management_api.html | 3255 ++++++++ .../managing/management/jmx_manager_node.html | 3232 ++++++++ .../management/jmx_manager_operations.html | 3391 ++++++++ .../management/list_of_mbean_notifications.html | 3404 ++++++++ .../11/managing/management/list_of_mbeans.html | 3234 ++++++++ .../management/list_of_mbeans_full.html | 3615 +++++++++ .../management/management_and_monitoring.html | 3243 ++++++++ .../management_and_monitoring_features.html | 3241 ++++++++ .../management/management_system_overview.html | 3315 ++++++++ .../managing/management/mbean_architecture.html | 3267 ++++++++ .../management/mbean_notifications.html | 3230 ++++++++ .../11/managing/management/mbeans_jconsole.html | 3240 ++++++++ .../11/managing/management/mm_overview.html | 3293 ++++++++ .../notification_federation_and_alerts.html | 3252 ++++++++ .../management/programming_example.html | 3426 ++++++++ .../monitor_tune/cache_consistency.html | 3279 ++++++++ .../managing/monitor_tune/chapter_overview.html | 3249 ++++++++ .../monitor_tune/multicast_communication.html | 3239 ++++++++ ..._communication_configuring_speed_limits.html | 3240 ++++++++ ...st_communication_provisioning_bandwidth.html | 3255 ++++++++ ...st_communication_runtime_considerations.html | 3239 ++++++++ ...nication_testing_multicast_speed_limits.html | 3335 ++++++++ ...multicast_communication_troubleshooting.html | 3233 ++++++++ .../monitor_tune/performance_controls.html | 3239 ++++++++ ...ormance_controls_controlling_socket_use.html | 3245 ++++++++ ...performance_controls_data_serialization.html | 3221 ++++++++ ...formance_controls_increasing_cache_hits.html | 3223 ++++++++ ...rmance_controls_managing_slow_receivers.html | 3267 ++++++++ ...ormance_controls_setting_cache_timeouts.html | 3232 ++++++++ .../monitor_tune/performance_on_vsphere.html | 3341 ++++++++ .../11/managing/monitor_tune/slow_messages.html | 3240 ++++++++ .../managing/monitor_tune/slow_receivers.html | 3230 ++++++++ .../monitor_tune/slow_receivers_managing.html | 3315 ++++++++ .../slow_receivers_preventing_problems.html | 3240 ++++++++ .../monitor_tune/socket_communication.html | 3241 ++++++++ ...communication_ephemeral_tcp_port_limits.html | 3246 ++++++++ ...ocket_communication_have_enough_sockets.html | 3391 ++++++++ ...mmunication_setting_socket_buffer_sizes.html | 3333 ++++++++ ...munication_tcpip_p2p_handshake_timeouts.html | 3227 ++++++++ .../monitor_tune/socket_tcp_keepalive.html | 3226 ++++++++ .../monitor_tune/sockets_and_gateways.html | 3319 ++++++++ .../monitor_tune/system_member_performance.html | 3236 ++++++++ ..._performance_connection_thread_settings.html | 3224 ++++++++ ...r_performance_distributed_system_member.html | 3225 ++++++++ .../system_member_performance_garbage.html | 3244 ++++++++ ...tem_member_performance_jvm_mem_settings.html | 3250 ++++++++ .../monitor_tune/udp_communication.html | 3249 ++++++++ .../network_partitioning/chapter_overview.html | 3240 ++++++++ .../network_partitioning/failure_detection.html | 3260 ++++++++ .../handling_network_partitioning.html | 3253 ++++++++ ...w_network_partitioning_management_works.html | 3258 ++++++++ ...coordinators_lead_members_and_weighting.html | 3282 ++++++++ .../network_partitioning_scenarios.html | 3247 ++++++++ .../preventing_network_partitions.html | 3227 ++++++++ .../region_compression/region_compression.html | 3402 ++++++++ .../security/authentication_examples.html | 3264 ++++++++ .../security/authentication_overview.html | 3237 ++++++++ .../security/authorization_example.html | 3264 ++++++++ .../security/authorization_overview.html | 3230 ++++++++ .../11/managing/security/chapter_overview.html | 3239 ++++++++ .../11/managing/security/enable_security.html | 3265 ++++++++ .../managing/security/encrypting_passwords.html | 3235 ++++++++ .../security/encrypting_with_diffie_helman.html | 3273 ++++++++ .../security/implementing_authentication.html | 3360 ++++++++ .../security/implementing_authorization.html | 3921 ++++++++++ .../security/implementing_security.html | 3277 ++++++++ .../11/managing/security/implementing_ssl.html | 3484 +++++++++ .../11/managing/security/post_processing.html | 3270 ++++++++ .../11/managing/security/properties_file.html | 3231 ++++++++ .../11/managing/security/security-audit.html | 3265 ++++++++ .../security/security_audit_overview.html | 3234 ++++++++ .../11/managing/security/security_intro.html | 3236 ++++++++ .../guide/11/managing/security/ssl_example.html | 3283 ++++++++ .../11/managing/security/ssl_overview.html | 3243 ++++++++ .../application_defined_statistics.html | 3260 ++++++++ .../managing/statistics/chapter_overview.html | 3235 ++++++++ .../statistics/how_statistics_work.html | 3229 ++++++++ .../statistics/setting_up_statistics.html | 3324 ++++++++ .../transient_region_and_entry_statistics.html | 3239 ++++++++ .../managing/statistics/viewing_statistics.html | 3219 ++++++++ .../troubleshooting/chapter_overview.html | 3249 ++++++++ .../diagnosing_system_probs.html | 3628 +++++++++ .../prevent_and_recover_disk_full_errors.html | 3244 ++++++++ .../producing_troubleshooting_artifacts.html | 3274 ++++++++ .../recovering_conflicting_data_exceptions.html | 3266 ++++++++ .../recovering_from_app_crashes.html | 3228 ++++++++ .../recovering_from_cs_crashes.html | 3255 ++++++++ .../recovering_from_machine_crashes.html | 3260 ++++++++ .../recovering_from_network_outages.html | 3265 ++++++++ .../recovering_from_p2p_crashes.html | 3394 ++++++++ .../system_failure_and_recovery.html | 3439 ++++++++ .../docs/guide/11/prereq_and_install.html | 3234 ++++++++ .../docs/guide/11/reference/book_intro.html | 3240 ++++++++ .../reference/statistics/statistics_list.html | 7337 ++++++++++++++++++ .../reference/topics/cache-elements-list.html | 3377 ++++++++ .../guide/11/reference/topics/cache_xml.html | 6340 +++++++++++++++ .../topics/chapter_overview_cache_xml.html | 3240 ++++++++ .../chapter_overview_regionshortcuts.html | 3272 ++++++++ .../topics/client-cache-elements-list.html | 3331 ++++++++ .../guide/11/reference/topics/client-cache.html | 5881 ++++++++++++++ .../guide/11/reference/topics/elements_ref.html | 3315 ++++++++ .../11/reference/topics/gemfire_properties.html | 3853 +++++++++ .../11/reference/topics/gfe_cache_xml.html | 6633 ++++++++++++++++ .../guide/11/reference/topics/glossary.html | 3813 +++++++++ .../handling_exceptions_and_failures.html | 3229 ++++++++ .../memory_requirements_for_cache_data.html | 3542 +++++++++ .../non-ascii_strings_in_config_files.html | 3232 ++++++++ .../topics/region_shortcuts_reference.html | 4814 ++++++++++++ .../topics/region_shortcuts_table.html | 3715 +++++++++ .../docs/guide/11/rest_apps/book_intro.html | 3249 ++++++++ .../guide/11/rest_apps/chapter_overview.html | 3227 ++++++++ .../guide/11/rest_apps/delete_all_data.html | 3253 ++++++++ .../guide/11/rest_apps/delete_data_for_key.html | 3253 ++++++++ .../delete_data_for_multiple_keys.html | 3253 ++++++++ .../guide/11/rest_apps/delete_named_query.html | 3275 ++++++++ .../guide/11/rest_apps/develop_rest_apps.html | 3755 +++++++++ .../11/rest_apps/get_execute_adhoc_query.html | 3318 ++++++++ .../docs/guide/11/rest_apps/get_functions.html | 3264 ++++++++ .../docs/guide/11/rest_apps/get_queries.html | 3281 ++++++++ .../guide/11/rest_apps/get_region_data.html | 3334 ++++++++ .../get_region_data_for_multiple_keys.html | 3434 ++++++++ .../guide/11/rest_apps/get_region_key_data.html | 3289 ++++++++ .../guide/11/rest_apps/get_region_keys.html | 3267 ++++++++ .../docs/guide/11/rest_apps/get_regions.html | 3292 ++++++++ .../docs/guide/11/rest_apps/get_servers.html | 3258 ++++++++ .../guide/11/rest_apps/head_region_size.html | 3262 ++++++++ .../docs/guide/11/rest_apps/ping_service.html | 3251 ++++++++ .../guide/11/rest_apps/post_create_query.html | 3304 ++++++++ .../11/rest_apps/post_execute_functions.html | 3321 ++++++++ .../guide/11/rest_apps/post_execute_query.html | 3370 ++++++++ .../guide/11/rest_apps/post_if_absent_data.html | 3346 ++++++++ .../rest_apps/put_multiple_values_for_keys.html | 3305 ++++++++ .../guide/11/rest_apps/put_replace_data.html | 3299 ++++++++ .../guide/11/rest_apps/put_update_cas_data.html | 3417 ++++++++ .../guide/11/rest_apps/put_update_data.html | 3284 ++++++++ .../guide/11/rest_apps/put_update_query.html | 3297 ++++++++ .../docs/guide/11/rest_apps/rest_admin.html | 3228 ++++++++ .../guide/11/rest_apps/rest_api_reference.html | 3237 ++++++++ .../docs/guide/11/rest_apps/rest_examples.html | 3882 +++++++++ .../docs/guide/11/rest_apps/rest_functions.html | 3228 ++++++++ .../docs/guide/11/rest_apps/rest_prereqs.html | 3237 ++++++++ .../docs/guide/11/rest_apps/rest_queries.html | 3240 ++++++++ .../docs/guide/11/rest_apps/rest_regions.html | 3266 ++++++++ .../docs/guide/11/rest_apps/setup_config.html | 3342 ++++++++ .../guide/11/rest_apps/troubleshooting.html | 3340 ++++++++ .../docs/guide/11/rest_apps/using_swagger.html | 3254 ++++++++ .../docs/guide/11/tools_modules/book_intro.html | 3242 ++++++++ .../gemcached/about_gemcached.html | 3244 ++++++++ .../11/tools_modules/gemcached/advantages.html | 3231 ++++++++ .../gemcached/chapter_overview.html | 3235 ++++++++ .../gemcached/deploying_gemcached.html | 3286 ++++++++ .../guide/11/tools_modules/gfsh/about_gfsh.html | 3239 ++++++++ .../11/tools_modules/gfsh/cache_xml_2_gfsh.html | 3300 ++++++++ .../11/tools_modules/gfsh/chapter_overview.html | 3253 ++++++++ .../tools_modules/gfsh/command-pages/alter.html | 3694 +++++++++ .../gfsh/command-pages/backup.html | 3273 ++++++++ .../gfsh/command-pages/change.html | 3287 ++++++++ .../tools_modules/gfsh/command-pages/clear.html | 3236 ++++++++ .../tools_modules/gfsh/command-pages/close.html | 3344 ++++++++ .../gfsh/command-pages/compact.html | 3328 ++++++++ .../gfsh/command-pages/configure.html | 3293 ++++++++ .../gfsh/command-pages/connect.html | 3359 ++++++++ .../gfsh/command-pages/create.html | 4126 ++++++++++ .../tools_modules/gfsh/command-pages/debug.html | 3250 ++++++++ .../gfsh/command-pages/define.html | 3276 ++++++++ .../gfsh/command-pages/deploy.html | 3278 ++++++++ .../gfsh/command-pages/describe.html | 3605 +++++++++ .../gfsh/command-pages/destroy.html | 3392 ++++++++ .../gfsh/command-pages/disconnect.html | 3236 ++++++++ .../tools_modules/gfsh/command-pages/echo.html | 3257 ++++++++ .../gfsh/command-pages/encrypt.html | 3251 ++++++++ .../gfsh/command-pages/execute.html | 3274 ++++++++ .../tools_modules/gfsh/command-pages/exit.html | 3229 ++++++++ .../gfsh/command-pages/export.html | 3522 +++++++++ .../11/tools_modules/gfsh/command-pages/gc.html | 3255 ++++++++ .../tools_modules/gfsh/command-pages/get.html | 3279 ++++++++ .../tools_modules/gfsh/command-pages/help.html | 3263 ++++++++ .../tools_modules/gfsh/command-pages/hint.html | 3264 ++++++++ .../gfsh/command-pages/history.html | 3261 ++++++++ .../gfsh/command-pages/import.html | 3303 ++++++++ .../tools_modules/gfsh/command-pages/list.html | 3643 +++++++++ .../gfsh/command-pages/load-balance.html | 3258 ++++++++ .../gfsh/command-pages/locate.html | 3284 ++++++++ .../gfsh/command-pages/netstat.html | 3347 ++++++++ .../tools_modules/gfsh/command-pages/pause.html | 3254 ++++++++ .../tools_modules/gfsh/command-pages/pdx.html | 3281 ++++++++ .../tools_modules/gfsh/command-pages/put.html | 3291 ++++++++ .../tools_modules/gfsh/command-pages/query.html | 3269 ++++++++ .../gfsh/command-pages/rebalance.html | 3281 ++++++++ .../gfsh/command-pages/remove.html | 3271 ++++++++ .../gfsh/command-pages/resume.html | 3254 ++++++++ .../gfsh/command-pages/revoke.html | 3256 ++++++++ .../tools_modules/gfsh/command-pages/run.html | 3291 ++++++++ .../tools_modules/gfsh/command-pages/set.html | 3264 ++++++++ .../11/tools_modules/gfsh/command-pages/sh.html | 3262 ++++++++ .../tools_modules/gfsh/command-pages/show.html | 3490 +++++++++ .../gfsh/command-pages/shutdown.html | 3262 ++++++++ .../tools_modules/gfsh/command-pages/sleep.html | 3253 ++++++++ .../tools_modules/gfsh/command-pages/start.html | 4010 ++++++++++ .../gfsh/command-pages/status.html | 3519 +++++++++ .../tools_modules/gfsh/command-pages/stop.html | 3446 ++++++++ .../gfsh/command-pages/undeploy.html | 3274 ++++++++ .../gfsh/command-pages/validate.html | 3248 ++++++++ .../gfsh/command-pages/version.html | 3258 ++++++++ .../tools_modules/gfsh/command_scripting.html | 3231 ++++++++ .../11/tools_modules/gfsh/configuring_gfsh.html | 3322 ++++++++ .../gfsh/getting_started_gfsh.html | 3327 ++++++++ .../tools_modules/gfsh/gfsh_command_index.html | 3372 ++++++++ .../gfsh/gfsh_quick_reference.html | 3241 ++++++++ .../gfsh/os_command_line_execution.html | 3236 ++++++++ .../gfsh/quick_ref_commands_by_area.html | 3983 ++++++++++ .../11/tools_modules/gfsh/starting_gfsh.html | 3255 ++++++++ .../11/tools_modules/gfsh/tour_of_gfsh.html | 3566 +++++++++ .../gfsh/useful_gfsh_shell_variables.html | 3322 ++++++++ .../http_session_mgmt/chapter_overview.html | 3250 ++++++++ .../common_gemfire_topologies.html | 3233 ++++++++ .../http_session_mgmt/http_why_use_gemfire.html | 3253 ++++++++ .../http_session_mgmt/interactive_mode_ref.html | 3295 ++++++++ .../http_session_mgmt/quick_start.html | 3334 ++++++++ .../session_mgmt_tcserver.html | 3233 ++++++++ .../http_session_mgmt/session_mgmt_tomcat.html | 3233 ++++++++ .../session_mgmt_weblogic.html | 3230 ++++++++ .../session_state_log_files.html | 3290 ++++++++ .../http_session_mgmt/tc_additional_info.html | 3251 ++++++++ .../tc_changing_gf_default_cfg.html | 3282 ++++++++ .../tc_installing_the_module.html | 3225 ++++++++ .../tc_setting_up_the_module.html | 3320 ++++++++ .../tomcat_changing_gf_default_cfg.html | 3384 ++++++++ .../tomcat_installing_the_module.html | 3237 ++++++++ .../tomcat_setting_up_the_module.html | 3298 ++++++++ .../weblogic_changing_gf_default_cfg.html | 3406 ++++++++ .../weblogic_common_configuration_changes.html | 3238 ++++++++ .../weblogic_setting_up_the_module.html | 3397 ++++++++ .../11/tools_modules/lucene_integration.html | 3324 ++++++++ .../tools_modules/pulse/chapter_overview.html | 3241 ++++++++ .../11/tools_modules/pulse/quickstart.html | 3989 ++++++++++ .../pulse/system_requirements.html | 3232 ++++++++ .../guide/11/tools_modules/redis_adapter.html | 3293 ++++++++ .../11/topologies_and_comm/book_intro.html | 3236 ++++++++ .../cs_configuration/chapter_overview.html | 3243 ++++++++ .../client_server_example_configurations.html | 3333 ++++++++ .../client_server_whats_next.html | 3252 ++++++++ .../configure_servers_into_logical_groups.html | 3243 ++++++++ .../setting_up_a_client_server_system.html | 3272 ++++++++ .../standard_client_server_deployment.html | 3232 ++++++++ .../chapter_overview.html | 3237 ++++++++ .../multisite_topologies.html | 3306 ++++++++ .../setting_up_a_multisite_system.html | 3525 +++++++++ .../p2p_configuration/chapter_overview.html | 3231 ++++++++ .../configuring_peer_member_groups.html | 3246 ++++++++ .../setting_up_a_p2p_system.html | 3231 ++++++++ .../setting_up_peer_communication.html | 3251 ++++++++ .../topology_concepts/IPv4_and_IPv6.html | 3243 ++++++++ .../topology_concepts/chapter_overview.html | 3240 ++++++++ .../how_communication_works.html | 3256 ++++++++ .../how_member_discovery_works.html | 3259 ++++++++ .../how_multisite_systems_work.html | 3237 ++++++++ .../how_server_discovery_works.html | 3259 ++++++++ .../how_the_pool_manages_connections.html | 3287 ++++++++ .../topology_concepts/member_communication.html | 3249 ++++++++ .../topology_concepts/multisite_overview.html | 3312 ++++++++ .../topology_concepts/topology_types.html | 3249 ++++++++ .../topology_concepts/using_bind_addresses.html | 3369 ++++++++ 654 files changed, 1783820 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/7f0f4d5f/geode-docs/about_geode.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/about_geode.html.md.erb b/geode-docs/about_geode.html.md.erb index b3bdfd8..3176352 100644 --- a/geode-docs/about_geode.html.md.erb +++ b/geode-docs/about_geode.html.md.erb @@ -19,6 +19,6 @@ See the License for the specific language governing permissions and limitations under the License. --> -This documentation describes product concepts and provides complete setup instructions for Apache Geode 1.0.0-incubating. Source files are available at [https://github.com/apache/geode/tree/develop/geode-docs](https://github.com/apache/geode/tree/develop/geode-docs) and instructions on how to build this documentation is available at [https://github.com/apache/geode/blob/develop/geode-book/README.md](https://github.com/apache/geode/blob/develop/geode-book/README.md). +This documentation describes product concepts and provides complete setup instructions for Apache Geode. Source files are available at [https://github.com/apache/geode/tree/develop/geode-docs](https://github.com/apache/geode/tree/develop/geode-docs) and instructions on how to build this documentation is available at [https://github.com/apache/geode/blob/develop/geode-book/README.md](https://github.com/apache/geode/blob/develop/geode-book/README.md). You can also find additional documentation about Geode on the **Apache Geode Wiki**: [https://cwiki.apache.org/confluence/display/GEODE/Index](https://cwiki.apache.org/confluence/display/GEODE/Index). http://git-wip-us.apache.org/repos/asf/geode/blob/7f0f4d5f/geode-docs/prereq_and_install.html.md.erb ---------------------------------------------------------------------- diff --git a/geode-docs/prereq_and_install.html.md.erb b/geode-docs/prereq_and_install.html.md.erb index 2b6bf63..c487f64 100644 --- a/geode-docs/prereq_and_install.html.md.erb +++ b/geode-docs/prereq_and_install.html.md.erb @@ -19,7 +19,7 @@ See the License for the specific language governing permissions and limitations under the License. --> -Each host of Apache Geode 1.0.0-incubating that meets a small set of prerequisites may follow the provided installation instructions. +Each host of Apache Geode that meets a small set of prerequisites may follow the provided installation instructions. - **[Host Machine Requirements](getting_started/system_requirements/host_machine.html)** http://git-wip-us.apache.org/repos/asf/geode/blob/7f0f4d5f/geode-site/website/content/docs/guide/11/CONTRIBUTE ---------------------------------------------------------------------- diff --git a/geode-site/website/content/docs/guide/11/CONTRIBUTE b/geode-site/website/content/docs/guide/11/CONTRIBUTE new file mode 100644 index 0000000..6d006a7 --- /dev/null +++ b/geode-site/website/content/docs/guide/11/CONTRIBUTE @@ -0,0 +1,54 @@ +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> + +<h1>Contributing to the Apache Geode Documentation</h1> + +<p>Apache Geode welcomes your contributions to the community’s documentation efforts. You can participate by writing new content, reviewing and editing existing content, or fixing bugs. This document covers the following topics:</p> + +<ul> +<li><a href="#working-with-markdown-files">Working with Markdown Files</a></li> +<li><a href="#working-with-images-and-graphics">Working with Images and Graphics</a></li> +<li><a href="#writing-guidelines">Writing Guidelines</a></li> +</ul> + +<p>For instructions on building the documentation locally, see <code>../geode-book/README.md</code>.</p> + +<h2>Working with Markdown Files</h2> + +<p>You can edit markdown files in any text editor. For more, read <a href="https://daringfireball.net/projects/markdown/syntax">Daring Fireball’s Markdown Syntax page</a>.</p> + +<h2>Working with Images and Graphics</h2> + +<p>Image files in .gif or .png format are in the <code>docs/images</code> directory in the Apache Geode docs repo. Images in .svg format are in the <code>docs/images_svg</code> directory.</p> + +<p>Most of the Apache Geode image files have been converted to the open source SVG format. You can insert SVG images directly into an XML topic and modify images using a SVG editor.</p> + +<p>The Wikipedia page <a href="http://en.wikipedia.org/wiki/Comparison_of_vector_graphics_editors">Comparison of Vector Graphics Editors</a> provides a list and comparison of commercial and free vector graphics editors. Note, however, that not all of these programs support the SVG format.</p> + +<h2>Writing Guidelines</h2> + +<p>The most important advice we can provide for working with the Apache Geode docs is to spend some time becoming familiar with the existing source files and the structure of the project directory. In particular, note the following conventions and tips:</p> + +<ul> +<li>Top-level subdirectories organize topics into “books”: basic_config, configuring, developing, etc.</li> +<li>Use lowercase characters for all file and directory names. Separate words in filenames with an underscore (<code>_</code>) character.</li> +<li>Use the <code>.md</code> file extension for topic files.</li> +<li>Add new topics to the existing directories by subject type. Only create a new directory if you are starting a new subject or a new book.</li> +<li>To start a new topic, you can make a copy of an existing file with similar content and edit it.</li> +<li>Use the appropriate document type for the content you are writing. Create multiple topics if you are writing overview, procedural, and reference content.</li> +<li>To edit elements in the navigation pane (the “subnav”) that appears on the left side of the documentation, navigate to <code>../geode-book/master_middleman/source/subnavs/geode-subnav.md</code>.</li> +</ul>