Add user guide doc to website
Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/f717e513 Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/f717e513 Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/f717e513 Branch: refs/heads/asf-site Commit: f717e5138bfc2ee9bedf942c986ad498102e6f8d Parents: 9aebc11 Author: Joey McAllister <[email protected]> Authored: Thu Oct 20 13:09:09 2016 -0700 Committer: Joey McAllister <[email protected]> Committed: Thu Oct 20 13:09:09 2016 -0700 ---------------------------------------------------------------------- docs/guide/CONTRIBUTE | 37 + docs/guide/about_geode.html | 3241 ++++++++ docs/guide/basic_config/book_intro.html | 3254 ++++++++ .../config_concepts/chapter_overview.html | 3254 ++++++++ ...distributed_system_member_configuration.html | 3270 ++++++++ .../config_concepts/local_vs_remote.html | 3244 ++++++++ .../chapter_overview.html | 3248 ++++++++ .../managing_data_entries.html | 3347 ++++++++ .../using_custom_classes.html | 3273 ++++++++ .../data_regions/chapter_overview.html | 3273 ++++++++ .../data_regions/create_a_region_with_API.html | 3280 ++++++++ .../create_a_region_with_cacheXML.html | 3281 ++++++++ .../data_regions/create_a_region_with_gfsh.html | 3259 ++++++++ .../creating_custom_attributes.html | 3282 ++++++++ .../data_regions/managing_data_regions.html | 3438 ++++++++ .../managing_region_attributes.html | 3317 ++++++++ .../data_regions/new_region_existing_data.html | 3243 ++++++++ .../data_regions/region_naming.html | 3249 ++++++++ .../data_regions/region_shortcuts.html | 3348 ++++++++ .../store_retrieve_region_shortcuts.html | 3290 ++++++++ .../setting_distributed_properties.html | 3291 ++++++++ .../the_cache/chapter_overview.html | 3260 ++++++++ .../the_cache/intro_cache_management.html | 3311 ++++++++ .../the_cache/managing_a_client_cache.html | 3288 ++++++++ .../the_cache/managing_a_multiuser_cache.html | 3282 ++++++++ .../the_cache/managing_a_peer_server_cache.html | 3290 ++++++++ .../the_cache/managing_a_secure_cache.html | 3276 ++++++++ .../the_cache/setting_cache_initializer.html | 3282 ++++++++ .../the_cache/setting_cache_properties.html | 3257 ++++++++ docs/guide/configuring/chapter_overview.html | 3288 ++++++++ .../deploying_application_jars.html | 3318 ++++++++ .../cluster_config/export-import.html | 3265 ++++++++ .../gfsh_config_troubleshooting.html | 3292 ++++++++ .../gfsh_load_from_shared_dir.html | 3260 ++++++++ .../cluster_config/gfsh_persist.html | 3357 ++++++++ .../configuring/cluster_config/gfsh_remote.html | 3295 ++++++++ .../persisting_configurations.html | 3494 +++++++++ .../cluster_config/using_member_groups.html | 3261 ++++++++ .../configuring/running/change_file_spec.html | 3265 ++++++++ .../configuring/running/default_file_specs.html | 3295 ++++++++ .../running/deploy_config_files_intro.html | 3253 ++++++++ .../running/deploying_config_files.html | 3259 ++++++++ .../running/deploying_config_jar_files.html | 3268 ++++++++ .../running/firewall_ports_config.html | 3248 ++++++++ .../running/firewalls_connections.html | 3252 ++++++++ .../running/firewalls_multisite.html | 3302 ++++++++ .../configuring/running/firewalls_ports.html | 3461 ++++++++ .../running/managing_output_files.html | 3248 ++++++++ .../running/running_the_cacheserver.html | 3374 ++++++++ .../running/running_the_locator.html | 3430 ++++++++ .../running/starting_up_shutting_down.html | 3337 ++++++++ docs/guide/developing/book_intro.html | 3280 ++++++++ .../continuous_querying/chapter_overview.html | 3253 ++++++++ .../continuous_querying_whats_next.html | 3363 ++++++++ .../how_continuous_querying_works.html | 3329 ++++++++ .../implementing_continuous_querying.html | 3414 ++++++++ .../PDX_Serialization_Features.html | 3257 ++++++++ .../data_serialization/auto_serialization.html | 3348 ++++++++ ...erialization_with_class_pattern_strings.html | 3284 ++++++++ .../data_serialization/chapter_overview.html | 3254 ++++++++ .../data_serialization_options.html | 3321 ++++++++ .../extending_the_autoserializer.html | 3341 ++++++++ .../gemfire_data_serialization.html | 3266 ++++++++ .../gemfire_pdx_serialization.html | 3272 ++++++++ .../data_serialization/java_serialization.html | 3244 ++++++++ .../jsonformatter_pdxinstances.html | 3267 ++++++++ .../persist_pdx_metadata_to_disk.html | 3268 ++++++++ .../program_application_for_pdx.html | 3320 ++++++++ .../use_pdx_high_level_steps.html | 3264 ++++++++ .../use_pdx_serializable.html | 3326 ++++++++ .../data_serialization/use_pdx_serializer.html | 3351 ++++++++ .../using_PdxInstanceFactory.html | 3263 ++++++++ .../using_pdx_region_entry_keys.html | 3246 ++++++++ .../delta_propagation/chapter_overview.html | 3260 ++++++++ .../delta_propagation_example.html | 3346 ++++++++ .../delta_propagation_properties.html | 3308 ++++++++ .../errors_in_delta_propagation.html | 3258 ++++++++ .../how_delta_propagation_works.html | 3297 ++++++++ .../implementing_delta_propagation.html | 3261 ++++++++ .../when_to_use_delta_prop.html | 3251 ++++++++ .../distributed_regions/chapter_overview.html | 3257 ++++++++ .../choosing_level_of_dist.html | 3252 ++++++++ .../how_distribution_works.html | 3265 ++++++++ .../how_region_versioning_works.html | 3344 ++++++++ .../how_region_versioning_works_wan.html | 3259 ++++++++ .../how_replication_works.html | 3269 ++++++++ .../locking_in_global_regions.html | 3316 ++++++++ .../managing_distributed_regions.html | 3270 ++++++++ .../region_entry_versions.html | 3262 ++++++++ .../events/cache_event_handler_examples.html | 3351 ++++++++ .../developing/events/chapter_overview.html | 3257 ++++++++ ...configure_client_server_event_messaging.html | 3296 ++++++++ .../configure_multisite_event_messaging.html | 3254 ++++++++ .../events/configure_p2p_event_messaging.html | 3265 ++++++++ .../configuring_gateway_concurrency_levels.html | 3366 ++++++++ ...iguring_highly_available_gateway_queues.html | 3322 ++++++++ .../configuring_highly_available_servers.html | 3280 ++++++++ .../conflate_multisite_gateway_queue.html | 3331 ++++++++ .../conflate_server_subscription_queue.html | 3262 ++++++++ .../events/event_handler_overview.html | 3254 ++++++++ .../events/filtering_multisite_events.html | 3326 ++++++++ .../events/ha_event_messaging_whats_next.html | 3305 ++++++++ .../events/how_cache_events_work.html | 3298 ++++++++ .../how_client_server_distribution_works.html | 3378 ++++++++ .../developing/events/how_events_work.html | 3334 ++++++++ .../how_multisite_distribution_works.html | 3292 ++++++++ .../implementing_cache_event_handlers.html | 3357 ++++++++ ...menting_durable_client_server_messaging.html | 3417 ++++++++ ...implementing_write_behind_event_handler.html | 3437 ++++++++ .../limit_server_subscription_queue_size.html | 3281 ++++++++ .../list_of_event_handlers_and_events.html | 3396 ++++++++ .../events/resolving_multisite_conflicts.html | 3291 ++++++++ .../tune_client_message_tracking_timeout.html | 3262 ++++++++ .../tune_client_server_event_messaging.html | 3252 ++++++++ ...writing_callbacks_that_modify_the_cache.html | 3281 ++++++++ .../developing/eviction/chapter_overview.html | 3250 ++++++++ .../eviction/configuring_data_eviction.html | 3297 ++++++++ .../developing/eviction/how_eviction_works.html | 3255 ++++++++ .../developing/expiration/chapter_overview.html | 3248 ++++++++ .../expiration/configuring_data_expiration.html | 3294 ++++++++ .../expiration/how_expiration_works.html | 3291 ++++++++ .../function_exec/chapter_overview.html | 3251 ++++++++ .../function_exec/function_execution.html | 3474 ++++++++ .../how_function_execution_works.html | 3356 ++++++++ .../chapter_overview.html | 3254 ++++++++ .../outside_data_sources/chapter_overview.html | 3254 ++++++++ .../how_data_loaders_work.html | 3269 ++++++++ .../implementing_data_loaders.html | 3302 ++++++++ .../outside_data_sources/sync_outside_data.html | 3251 ++++++++ .../partitioned_regions/chapter_overview.html | 3269 ++++++++ .../checking_region_redundancy.html | 3264 ++++++++ .../colocating_partitioned_region_data.html | 3347 ++++++++ .../configure_pr_single_hop.html | 3248 ++++++++ .../configuring_bucket_for_pr.html | 3282 ++++++++ .../configuring_ha_for_pr.html | 3275 ++++++++ ...custom_partitioning_and_data_colocation.html | 3279 ++++++++ .../how_partitioning_works.html | 3276 ++++++++ .../partitioned_regions/how_pr_ha_works.html | 3283 ++++++++ .../how_pr_single_hop_works.html | 3267 ++++++++ .../join_query_partitioned_regions.html | 3303 ++++++++ .../managing_partitioned_regions.html | 3261 ++++++++ .../moving_partitioned_data.html | 3285 ++++++++ ...custom_partitioning_and_data_colocation.html | 3251 ++++++++ .../overview_how_pr_ha_works.html | 3248 ++++++++ .../overview_how_pr_single_hop_works.html | 3248 ++++++++ .../rebalancing_pr_data.html | 3317 ++++++++ .../set_crash_redundancy_recovery.html | 3280 ++++++++ .../set_enforce_unique_host.html | 3246 ++++++++ .../set_join_redundancy_recovery.html | 3286 ++++++++ .../partitioned_regions/set_pr_redundancy.html | 3260 ++++++++ .../set_redundancy_zones.html | 3255 ++++++++ .../using_custom_partition_resolvers.html | 3436 ++++++++ .../query_additional/advanced_querying.html | 3260 ++++++++ .../query_additional/case_sensitivity.html | 3245 ++++++++ .../developing/query_additional/literals.html | 3304 ++++++++ .../developing/query_additional/operators.html | 3291 ++++++++ .../order_by_on_partitioned_regions.html | 3247 ++++++++ .../partitioned_region_key_or_field_value.html | 3298 ++++++++ .../partitioned_region_query_restrictions.html | 3261 ++++++++ .../query_additional/query_debugging.html | 3294 ++++++++ .../query_language_features.html | 3251 ++++++++ .../query_on_a_single_node.html | 3377 ++++++++ .../query_additional/supported_keywords.html | 3361 ++++++++ .../using_query_bind_parameters.html | 3276 ++++++++ .../query_index/create_multiple_indexes.html | 3278 ++++++++ .../query_index/creating_an_index.html | 3309 ++++++++ .../query_index/creating_hash_indexes.html | 3278 ++++++++ .../query_index/creating_key_indexes.html | 3274 ++++++++ .../query_index/creating_map_indexes.html | 3264 ++++++++ .../developing/query_index/index_samples.html | 3289 ++++++++ .../indexes_on_single_region_queries.html | 3258 ++++++++ .../indexes_with_overflow_regions.html | 3266 ++++++++ .../query_index/indexing_guidelines.html | 3261 ++++++++ .../query_index/maintaining_indexes.html | 3282 ++++++++ .../developing/query_index/query_index.html | 3284 ++++++++ .../query_index/query_index_hints.html | 3249 ++++++++ .../using_indexes_with_equijoin_queries.html | 3301 ++++++++ ..._with_equijoin_queries_multiple_regions.html | 3343 ++++++++ .../developing/query_select/aggregates.html | 3320 ++++++++ .../query_select/the_from_clause.html | 3298 ++++++++ .../query_select/the_import_statement.html | 3243 ++++++++ .../query_select/the_select_statement.html | 3392 ++++++++ .../query_select/the_where_clause.html | 3518 +++++++++ .../querying_basics/chapter_overview.html | 3253 ++++++++ .../comments_in_query_strings.html | 3242 ++++++++ .../monitor_queries_for_low_memory.html | 3255 ++++++++ .../querying_basics/oql_compared_to_sql.html | 3248 ++++++++ .../performance_considerations.html | 3250 ++++++++ .../querying_basics/query_basics.html | 3264 ++++++++ .../query_grammar_and_reserved_words.html | 3372 ++++++++ .../querying_partitioned_regions.html | 3253 ++++++++ .../querying_basics/reserved_words.html | 3338 ++++++++ .../restrictions_and_unsupported_features.html | 3250 ++++++++ .../querying_basics/running_a_query.html | 3298 ++++++++ .../supported_character_sets.html | 3239 ++++++++ .../querying_basics/what_is_a_query_string.html | 3266 ++++++++ .../region_options/chapter_overview.html | 3254 ++++++++ .../data_hosts_and_accessors.html | 3248 ++++++++ .../region_options/dynamic_region_creation.html | 3406 ++++++++ .../developing/region_options/region_types.html | 3371 ++++++++ .../storage_distribution_options.html | 3258 ++++++++ .../storing_data_on_disk/chapter_overview.html | 3256 ++++++++ .../how_persist_overflow_work.html | 3281 ++++++++ .../overflow_config_examples.html | 3264 ++++++++ .../storing_data_on_disk.html | 3301 ++++++++ .../transactions/JTA_transactions.html | 3436 ++++++++ .../transactions/about_transactions.html | 3263 ++++++++ .../transactions/cache_plugins_with_jta.html | 3243 ++++++++ .../cache_transaction_performance.html | 3246 ++++++++ .../transactions/cache_transactions.html | 3262 ++++++++ .../cache_transactions_by_region_type.html | 3384 ++++++++ .../transactions/chapter_overview.html | 3260 ++++++++ .../client_server_transactions.html | 3268 ++++++++ .../configuring_db_connections_using_JNDI.html | 3522 +++++++++ .../data_location_cache_transactions.html | 3249 ++++++++ .../how_cache_transactions_work.html | 3291 ++++++++ .../transactions/jca_adapter_example.html | 3263 ++++++++ .../monitor_troubleshoot_transactions.html | 3276 ++++++++ .../transactions/run_a_cache_transaction.html | 3330 ++++++++ ...un_a_cache_transaction_with_external_db.html | 3267 ++++++++ .../transaction_coding_examples.html | 3257 ++++++++ .../transaction_event_management.html | 3265 ++++++++ .../transaction_jta_gemfire_example.html | 3260 ++++++++ .../transactions/transaction_semantics.html | 3271 ++++++++ .../transaction_suspend_resume_example.html | 3250 ++++++++ .../transactional_and_nontransactional_ops.html | 3456 ++++++++ .../transactional_function_example.html | 3284 ++++++++ .../transactions/transactions_overview.html | 3279 ++++++++ .../transactions/turning_off_jta.html | 3252 ++++++++ .../transactions/working_with_transactions.html | 3421 ++++++++ .../15_minute_quickstart_gfsh.html | 3646 +++++++++ docs/guide/getting_started/book_intro.html | 3254 ++++++++ docs/guide/getting_started/geode_overview.html | 3254 ++++++++ .../installation/install_standalone.html | 3314 ++++++++ docs/guide/getting_started/product_intro.html | 3320 ++++++++ .../querying_quick_reference.html | 3706 +++++++++ docs/guide/getting_started/setup_classpath.html | 3316 ++++++++ .../system_requirements/host_machine.html | 3270 ++++++++ .../getting_started/uninstall_gemfire.html | 3241 ++++++++ .../images/ClientServerAdvancedTopics-5.gif | Bin 0 -> 10798 bytes .../images/ClientServerAdvancedTopics-6.gif | Bin 0 -> 12056 bytes .../images/ClientServerAdvancedTopics-7.gif | Bin 0 -> 5000 bytes docs/guide/images/ContinuousQuerying-1.gif | Bin 0 -> 6955 bytes docs/guide/images/ContinuousQuerying-3.gif | Bin 0 -> 9141 bytes docs/guide/images/DataManagement-9.png | Bin 0 -> 48188 bytes docs/guide/images/DeltaPropagation-1.gif | Bin 0 -> 7593 bytes docs/guide/images/DeltaPropagation-3.gif | Bin 0 -> 6843 bytes docs/guide/images/Events-2.gif | Bin 0 -> 8793 bytes docs/guide/images/Events-3.gif | Bin 0 -> 6432 bytes docs/guide/images/FuncExecOnMembers.png | Bin 0 -> 64959 bytes .../images/FuncExecOnRegionHAWithFilter.png | Bin 0 -> 80141 bytes .../guide/images/FuncExecOnRegionNoMetadata.png | Bin 0 -> 70177 bytes .../images/FuncExecOnRegionPeersWithFilter.png | Bin 0 -> 86576 bytes .../guide/images/FuncExecOnRegionWithFilter.png | Bin 0 -> 60773 bytes .../images/FuncExecOnRegionWithMetadata.png | Bin 0 -> 59576 bytes docs/guide/images/FuncExecOnServers.png | Bin 0 -> 57470 bytes docs/guide/images/Gemcached.png | Bin 0 -> 87366 bytes docs/guide/images/JConsole.png | Bin 0 -> 64272 bytes docs/guide/images/MultiSite-4.gif | Bin 0 -> 4991 bytes .../images/MultisiteConcurrency_WAN_Gateway.png | Bin 0 -> 103701 bytes docs/guide/images/SQLite_Persistence_Mgr.png | Bin 0 -> 58388 bytes docs/guide/images/Transaction-simple.png | Bin 0 -> 119831 bytes docs/guide/images/consistent_multisite.png | Bin 0 -> 39442 bytes docs/guide/images/diskStores-1.gif | Bin 0 -> 7292 bytes docs/guide/images/diskStores-3.gif | Bin 0 -> 5898 bytes docs/guide/images/jconsole_mbeans.png | Bin 0 -> 211394 bytes docs/guide/images/jvisualvm.png | Bin 0 -> 90153 bytes docs/guide/images/logging-1.gif | Bin 0 -> 2778 bytes docs/guide/images/member_view_list.png | Bin 0 -> 107811 bytes .../guide/images/multisite-topology-avoid-3.png | Bin 0 -> 9794 bytes .../images/multisite-topology-hybrid-1.png | Bin 0 -> 7627 bytes .../images/multisite-topology-hybrid-2.png | Bin 0 -> 7631 bytes .../images/multisite-topology-parallel.png | Bin 0 -> 7838 bytes docs/guide/images/multisite-topology-serial.png | Bin 0 -> 6886 bytes docs/guide/images/parallel_sender.png | Bin 0 -> 36089 bytes docs/guide/images/pulse-data-browser.png | Bin 0 -> 99987 bytes docs/guide/images/pulse-region-detail.png | Bin 0 -> 61149 bytes docs/guide/images/pulse_alerts_widget.png | Bin 0 -> 137883 bytes docs/guide/images/pulse_cluster_view.png | Bin 0 -> 154531 bytes docs/guide/images/pulse_data_view.png | Bin 0 -> 138140 bytes docs/guide/images/pulse_locator.png | Bin 0 -> 228513 bytes docs/guide/images/pulse_member_view.png | Bin 0 -> 132309 bytes .../guide/images/rest_example_java_packages.png | Bin 0 -> 30206 bytes docs/guide/images/security-1.gif | Bin 0 -> 8343 bytes docs/guide/images/security-3.gif | Bin 0 -> 8287 bytes docs/guide/images/security-4.gif | Bin 0 -> 7028 bytes docs/guide/images/security-5.gif | Bin 0 -> 7408 bytes docs/guide/images/serial_sender.png | Bin 0 -> 32385 bytes docs/guide/images/statistics-1.gif | Bin 0 -> 8644 bytes docs/guide/images/swagger_home.png | Bin 0 -> 187378 bytes docs/guide/images/swagger_post_region.png | Bin 0 -> 170963 bytes .../images/swagger_post_region_response.png | Bin 0 -> 176783 bytes docs/guide/images/swagger_v1.png | Bin 0 -> 149806 bytes docs/guide/images/swagger_v1_response.png | Bin 0 -> 143134 bytes docs/guide/images/transactions-client-1.png | Bin 0 -> 113816 bytes docs/guide/images/transactions_jca_adapter.png | Bin 0 -> 104775 bytes docs/guide/images/transactions_jta.png | Bin 0 -> 104780 bytes .../images/transactions_jta_app_server.png | Bin 0 -> 91885 bytes docs/guide/images_svg/JMX_Architecture.svg | 3 + docs/guide/images_svg/MBeans.svg | 3 + .../async_system_queue_conflation.svg | 3 + docs/guide/images_svg/cache_data_loader.svg | 3 + docs/guide/images_svg/cache_data_loader_2.svg | 3 + .../images_svg/client_server_deployment.svg | 3 + .../images_svg/client_server_event_dist.svg | 3 + .../client_server_message_tracking.svg | 3 + docs/guide/images_svg/cluster-group-config.svg | 3 + .../images_svg/cluster_config_overview.svg | 3 + .../colocated_partitioned_regions.svg | 3 + docs/guide/images_svg/cs_connection_pool.svg | 3 + docs/guide/images_svg/cs_locator_discovery.svg | 3 + docs/guide/images_svg/cs_subscriptions.svg | 3 + docs/guide/images_svg/cs_topology.svg | 3 + docs/guide/images_svg/custom_partitioned.svg | 3 + docs/guide/images_svg/developing_overflow.svg | 3 + .../guide/images_svg/developing_persistence.svg | 3 + .../developing_persistence_and_overflow.svg | 3 + docs/guide/images_svg/distributed_how_1.svg | 3 + docs/guide/images_svg/distributed_how_2.svg | 3 + docs/guide/images_svg/distributed_how_3.svg | 3 + docs/guide/images_svg/distributed_preload.svg | 3 + docs/guide/images_svg/distributed_replica.svg | 3 + .../images_svg/distributed_replica_preload.svg | 3 + docs/guide/images_svg/expiration.svg | 3 + .../images_svg/how_partitioning_works_1.svg | 3 + .../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 + docs/guide/images_svg/locator_discovery.svg | 3 + docs/guide/images_svg/member_severe_alert.svg | 3 + .../images_svg/network_partition_scenario.svg | 3 + docs/guide/images_svg/p2p_topology.svg | 3 + docs/guide/images_svg/partitioned_data_HA.svg | 3 + .../images_svg/partitioned_data_buckets_1.svg | 3 + .../images_svg/partitioned_data_buckets_2.svg | 3 + .../images_svg/region_entry_versions_1.svg | 3 + .../images_svg/region_entry_versions_2.svg | 3 + .../images_svg/region_entry_versions_3.svg | 3 + .../images_svg/server_client_event_dist.svg | 3 + docs/guide/images_svg/server_discovery.svg | 3 + docs/guide/images_svg/server_grouping.svg | 3 + .../images_svg/transactions_partitioned_1.svg | 3 + .../images_svg/transactions_partitioned_2.svg | 3 + .../images_svg/transactions_replicate_1.svg | 3 + .../images_svg/transactions_replicate_2.svg | 3 + .../images_svg/transactions_replicate_3.svg | 3 + .../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 + .../images_svg/tune_cs_event_messaging.svg | 3 + .../unbalanced_network_capacity_probs.svg | 3 + .../autoreconnect/member-reconnect.html | 3276 ++++++++ docs/guide/managing/book_intro.html | 3276 ++++++++ .../cache_snapshots/chapter_overview.html | 3264 ++++++++ .../cache_snapshots/exporting_a_snapshot.html | 3279 ++++++++ .../filtering_snapshot_entries.html | 3258 ++++++++ .../cache_snapshots/importing_a_snapshot.html | 3288 ++++++++ .../read_snapshots_programmatically.html | 3255 ++++++++ .../using_cache_and_region_snapshots.html | 3258 ++++++++ .../disk_storage/backup_restore_disk_store.html | 3398 ++++++++ .../managing/disk_storage/chapter_overview.html | 3266 ++++++++ .../disk_storage/compacting_disk_stores.html | 3348 ++++++++ .../disk_free_space_monitoring.html | 3270 ++++++++ .../disk_store_configuration_params.html | 3349 ++++++++ .../disk_storage/file_names_and_extensions.html | 3375 ++++++++ .../handling_missing_disk_stores.html | 3287 ++++++++ .../disk_storage/how_disk_stores_work.html | 3282 ++++++++ .../keeping_offline_disk_store_in_sync.html | 3276 ++++++++ .../managing_disk_buffer_flushes.html | 3255 ++++++++ .../disk_storage/managing_disk_stores.html | 3253 ++++++++ .../disk_storage/managing_disk_stores_cmds.html | 3315 ++++++++ .../managing/disk_storage/operation_logs.html | 3277 ++++++++ .../optimize_availability_and_performance.html | 3249 ++++++++ .../overview_using_disk_stores.html | 3251 ++++++++ .../starting_system_with_disk_stores.html | 3348 ++++++++ .../disk_storage/using_disk_stores.html | 3413 ++++++++ .../using_the_default_disk_store.html | 3277 ++++++++ .../disk_storage/validating_disk_store.html | 3251 ++++++++ .../managing/heap_use/heap_management.html | 3440 ++++++++ docs/guide/managing/heap_use/lock_memory.html | 3259 ++++++++ .../managing/heap_use/off_heap_management.html | 3417 ++++++++ .../managing/logging/configuring_log4j2.html | 3281 ++++++++ .../managing/logging/how_logging_works.html | 3254 ++++++++ .../logging/log_collection_utility.html | 3285 ++++++++ docs/guide/managing/logging/logging.html | 3260 ++++++++ .../managing/logging/logging_categories.html | 3433 ++++++++ .../managing/logging/logging_whats_next.html | 3266 ++++++++ .../managing/logging/setting_up_logging.html | 3283 ++++++++ .../management/configuring_rmi_connector.html | 3251 ++++++++ .../management/gfsh_and_management_api.html | 3275 ++++++++ .../managing/management/jmx_manager_node.html | 3252 ++++++++ .../management/jmx_manager_operations.html | 3411 ++++++++ .../management/list_of_mbean_notifications.html | 3424 ++++++++ .../managing/management/list_of_mbeans.html | 3254 ++++++++ .../management/list_of_mbeans_full.html | 3635 +++++++++ .../management/management_and_monitoring.html | 3263 ++++++++ .../management_and_monitoring_features.html | 3261 ++++++++ .../management/management_system_overview.html | 3335 ++++++++ .../managing/management/mbean_architecture.html | 3287 ++++++++ .../management/mbean_notifications.html | 3250 ++++++++ .../managing/management/mbeans_jconsole.html | 3260 ++++++++ docs/guide/managing/management/mm_overview.html | 3313 ++++++++ .../notification_federation_and_alerts.html | 3272 ++++++++ .../management/programming_example.html | 3446 ++++++++ .../monitor_tune/cache_consistency.html | 3299 ++++++++ .../managing/monitor_tune/chapter_overview.html | 3269 ++++++++ .../gemfire_performance_on_vsphere.html | 3273 ++++++++ ...mfire_performance_on_vsphere_guidelines.html | 3361 ++++++++ .../monitor_tune/multicast_communication.html | 3259 ++++++++ ..._communication_configuring_speed_limits.html | 3260 ++++++++ ...st_communication_provisioning_bandwidth.html | 3275 ++++++++ ...st_communication_runtime_considerations.html | 3259 ++++++++ ...nication_testing_multicast_speed_limits.html | 3355 ++++++++ ...multicast_communication_troubleshooting.html | 3253 ++++++++ .../monitor_tune/performance_controls.html | 3259 ++++++++ ...ormance_controls_controlling_socket_use.html | 3265 ++++++++ ...performance_controls_data_serialization.html | 3241 ++++++++ ...formance_controls_increasing_cache_hits.html | 3243 ++++++++ ...rmance_controls_managing_slow_receivers.html | 3287 ++++++++ ...ormance_controls_setting_cache_timeouts.html | 3252 ++++++++ .../managing/monitor_tune/slow_messages.html | 3260 ++++++++ .../managing/monitor_tune/slow_receivers.html | 3250 ++++++++ .../monitor_tune/slow_receivers_managing.html | 3335 ++++++++ .../slow_receivers_preventing_problems.html | 3260 ++++++++ .../monitor_tune/socket_communication.html | 3261 ++++++++ ...communication_ephemeral_tcp_port_limits.html | 3266 ++++++++ ...ocket_communication_have_enough_sockets.html | 3411 ++++++++ ...mmunication_setting_socket_buffer_sizes.html | 3353 ++++++++ ...munication_tcpip_p2p_handshake_timeouts.html | 3247 ++++++++ .../monitor_tune/socket_tcp_keepalive.html | 3246 ++++++++ .../monitor_tune/sockets_and_gateways.html | 3339 ++++++++ .../monitor_tune/system_member_performance.html | 3256 ++++++++ ..._performance_connection_thread_settings.html | 3244 ++++++++ ...r_performance_distributed_system_member.html | 3245 ++++++++ .../system_member_performance_garbage.html | 3264 ++++++++ ...tem_member_performance_jvm_mem_settings.html | 3270 ++++++++ .../monitor_tune/udp_communication.html | 3269 ++++++++ .../network_partitioning/chapter_overview.html | 3260 ++++++++ .../network_partitioning/failure_detection.html | 3280 ++++++++ .../handling_network_partitioning.html | 3273 ++++++++ ...w_network_partitioning_management_works.html | 3279 ++++++++ ...coordinators_lead_members_and_weighting.html | 3302 ++++++++ .../network_partitioning_scenarios.html | 3267 ++++++++ .../preventing_network_partitions.html | 3247 ++++++++ .../region_compression/region_compression.html | 3422 ++++++++ .../security/authentication_examples.html | 3284 ++++++++ .../security/authentication_overview.html | 3257 ++++++++ .../security/authorization_example.html | 3284 ++++++++ .../security/authorization_overview.html | 3250 ++++++++ .../managing/security/chapter_overview.html | 3259 ++++++++ .../managing/security/enable_security.html | 3285 ++++++++ .../managing/security/encrypting_passwords.html | 3255 ++++++++ .../security/encrypting_with_diffie_helman.html | 3293 ++++++++ .../security/implementing_authentication.html | 3380 ++++++++ .../security/implementing_authorization.html | 3941 ++++++++++ .../security/implementing_security.html | 3297 ++++++++ .../managing/security/implementing_ssl.html | 3504 +++++++++ .../managing/security/post_processing.html | 3288 ++++++++ .../managing/security/properties_file.html | 3251 ++++++++ .../guide/managing/security/security-audit.html | 3285 ++++++++ .../security/security_audit_overview.html | 3254 ++++++++ .../guide/managing/security/security_intro.html | 3256 ++++++++ docs/guide/managing/security/ssl_example.html | 3303 ++++++++ docs/guide/managing/security/ssl_overview.html | 3263 ++++++++ .../application_defined_statistics.html | 3256 ++++++++ .../managing/statistics/chapter_overview.html | 3255 ++++++++ .../statistics/how_statistics_work.html | 3249 ++++++++ .../statistics/setting_up_statistics.html | 3344 ++++++++ .../transient_region_and_entry_statistics.html | 3259 ++++++++ .../managing/statistics/viewing_statistics.html | 3239 ++++++++ .../troubleshooting/chapter_overview.html | 3269 ++++++++ .../diagnosing_system_probs.html | 3648 +++++++++ .../prevent_and_recover_disk_full_errors.html | 3264 ++++++++ .../producing_troubleshooting_artifacts.html | 3294 ++++++++ .../recovering_conflicting_data_exceptions.html | 3286 ++++++++ .../recovering_from_app_crashes.html | 3248 ++++++++ .../recovering_from_cs_crashes.html | 3275 ++++++++ .../recovering_from_machine_crashes.html | 3280 ++++++++ .../recovering_from_network_outages.html | 3294 ++++++++ .../recovering_from_p2p_crashes.html | 3414 ++++++++ .../system_failure_and_recovery.html | 3459 ++++++++ docs/guide/prereq_and_install.html | 3254 ++++++++ docs/guide/reference/book_intro.html | 3260 ++++++++ .../reference/statistics/statistics_list.html | 7385 ++++++++++++++++++ .../reference/topics/cache-elements-list.html | 3397 ++++++++ docs/guide/reference/topics/cache_xml.html | 6360 +++++++++++++++ .../topics/chapter_overview_cache_xml.html | 3260 ++++++++ .../chapter_overview_regionshortcuts.html | 3292 ++++++++ .../topics/client-cache-elements-list.html | 3351 ++++++++ docs/guide/reference/topics/client-cache.html | 5901 ++++++++++++++ docs/guide/reference/topics/elements_ref.html | 3333 ++++++++ .../reference/topics/gemfire_properties.html | 3859 +++++++++ docs/guide/reference/topics/gfe_cache_xml.html | 6653 ++++++++++++++++ docs/guide/reference/topics/glossary.html | 3833 +++++++++ .../handling_exceptions_and_failures.html | 3249 ++++++++ .../memory_requirements_for_cache_data.html | 3562 +++++++++ .../non-ascii_strings_in_config_files.html | 3252 ++++++++ .../topics/region_shortcuts_reference.html | 5016 ++++++++++++ .../topics/region_shortcuts_table.html | 3735 +++++++++ docs/guide/rest_apps/book_intro.html | 3269 ++++++++ docs/guide/rest_apps/chapter_overview.html | 3247 ++++++++ docs/guide/rest_apps/delete_all_data.html | 3273 ++++++++ docs/guide/rest_apps/delete_data_for_key.html | 3273 ++++++++ .../delete_data_for_multiple_keys.html | 3273 ++++++++ docs/guide/rest_apps/delete_named_query.html | 3287 ++++++++ docs/guide/rest_apps/develop_rest_apps.html | 3775 +++++++++ .../rest_apps/get_execute_adhoc_query.html | 3326 ++++++++ docs/guide/rest_apps/get_functions.html | 3284 ++++++++ docs/guide/rest_apps/get_queries.html | 3286 ++++++++ docs/guide/rest_apps/get_region_data.html | 3354 ++++++++ .../get_region_data_for_multiple_keys.html | 3454 ++++++++ docs/guide/rest_apps/get_region_key_data.html | 3309 ++++++++ docs/guide/rest_apps/get_region_keys.html | 3287 ++++++++ docs/guide/rest_apps/get_regions.html | 3312 ++++++++ docs/guide/rest_apps/get_servers.html | 3278 ++++++++ docs/guide/rest_apps/head_region_size.html | 3282 ++++++++ docs/guide/rest_apps/ping_service.html | 3271 ++++++++ docs/guide/rest_apps/post_create_query.html | 3312 ++++++++ .../guide/rest_apps/post_execute_functions.html | 3341 ++++++++ docs/guide/rest_apps/post_execute_query.html | 3378 ++++++++ docs/guide/rest_apps/post_if_absent_data.html | 3366 ++++++++ .../rest_apps/put_multiple_values_for_keys.html | 3325 ++++++++ docs/guide/rest_apps/put_replace_data.html | 3319 ++++++++ docs/guide/rest_apps/put_update_cas_data.html | 3437 ++++++++ docs/guide/rest_apps/put_update_data.html | 3304 ++++++++ docs/guide/rest_apps/put_update_query.html | 3302 ++++++++ docs/guide/rest_apps/rest_admin.html | 3248 ++++++++ docs/guide/rest_apps/rest_api_reference.html | 3257 ++++++++ docs/guide/rest_apps/rest_examples.html | 3902 +++++++++ docs/guide/rest_apps/rest_functions.html | 3248 ++++++++ docs/guide/rest_apps/rest_prereqs.html | 3257 ++++++++ docs/guide/rest_apps/rest_queries.html | 3260 ++++++++ docs/guide/rest_apps/rest_regions.html | 3286 ++++++++ docs/guide/rest_apps/setup_config.html | 3362 ++++++++ docs/guide/rest_apps/troubleshooting.html | 3368 ++++++++ docs/guide/rest_apps/using_swagger.html | 3274 ++++++++ docs/guide/tools_modules/book_intro.html | 3259 ++++++++ .../gemcached/about_gemcached.html | 3264 ++++++++ .../tools_modules/gemcached/advantages.html | 3251 ++++++++ .../gemcached/chapter_overview.html | 3255 ++++++++ .../gemcached/deploying_gemcached.html | 3306 ++++++++ docs/guide/tools_modules/gfsh/about_gfsh.html | 3259 ++++++++ .../tools_modules/gfsh/cache_xml_2_gfsh.html | 3320 ++++++++ .../tools_modules/gfsh/chapter_overview.html | 3273 ++++++++ .../tools_modules/gfsh/command-pages/alter.html | 3714 +++++++++ .../gfsh/command-pages/backup.html | 3293 ++++++++ .../gfsh/command-pages/change.html | 3307 ++++++++ .../tools_modules/gfsh/command-pages/clear.html | 3256 ++++++++ .../tools_modules/gfsh/command-pages/close.html | 3364 ++++++++ .../gfsh/command-pages/compact.html | 3348 ++++++++ .../gfsh/command-pages/configure.html | 3313 ++++++++ .../gfsh/command-pages/connect.html | 3374 ++++++++ .../gfsh/command-pages/create.html | 4146 ++++++++++ .../tools_modules/gfsh/command-pages/debug.html | 3270 ++++++++ .../gfsh/command-pages/define.html | 3296 ++++++++ .../gfsh/command-pages/deploy.html | 3298 ++++++++ .../gfsh/command-pages/describe.html | 3625 +++++++++ .../gfsh/command-pages/destroy.html | 3412 ++++++++ .../gfsh/command-pages/disconnect.html | 3256 ++++++++ .../tools_modules/gfsh/command-pages/echo.html | 3277 ++++++++ .../gfsh/command-pages/encrypt.html | 3271 ++++++++ .../gfsh/command-pages/execute.html | 3294 ++++++++ .../tools_modules/gfsh/command-pages/exit.html | 3249 ++++++++ .../gfsh/command-pages/export.html | 3542 +++++++++ .../tools_modules/gfsh/command-pages/gc.html | 3275 ++++++++ .../tools_modules/gfsh/command-pages/get.html | 3299 ++++++++ .../tools_modules/gfsh/command-pages/help.html | 3283 ++++++++ .../tools_modules/gfsh/command-pages/hint.html | 3284 ++++++++ .../gfsh/command-pages/history.html | 3279 ++++++++ .../gfsh/command-pages/import.html | 3323 ++++++++ .../tools_modules/gfsh/command-pages/list.html | 3663 +++++++++ .../gfsh/command-pages/load-balance.html | 3278 ++++++++ .../gfsh/command-pages/locate.html | 3304 ++++++++ .../gfsh/command-pages/netstat.html | 3367 ++++++++ .../tools_modules/gfsh/command-pages/pause.html | 3274 ++++++++ .../tools_modules/gfsh/command-pages/pdx.html | 3301 ++++++++ .../tools_modules/gfsh/command-pages/put.html | 3311 ++++++++ .../tools_modules/gfsh/command-pages/query.html | 3289 ++++++++ .../gfsh/command-pages/rebalance.html | 3301 ++++++++ .../gfsh/command-pages/remove.html | 3291 ++++++++ .../gfsh/command-pages/resume.html | 3274 ++++++++ .../gfsh/command-pages/revoke.html | 3276 ++++++++ .../tools_modules/gfsh/command-pages/run.html | 3311 ++++++++ .../tools_modules/gfsh/command-pages/set.html | 3284 ++++++++ .../tools_modules/gfsh/command-pages/sh.html | 3282 ++++++++ .../tools_modules/gfsh/command-pages/show.html | 3507 +++++++++ .../gfsh/command-pages/shutdown.html | 3282 ++++++++ .../tools_modules/gfsh/command-pages/sleep.html | 3273 ++++++++ .../tools_modules/gfsh/command-pages/start.html | 3998 ++++++++++ .../gfsh/command-pages/status.html | 3539 +++++++++ .../tools_modules/gfsh/command-pages/stop.html | 3466 ++++++++ .../gfsh/command-pages/undeploy.html | 3294 ++++++++ .../gfsh/command-pages/validate.html | 3268 ++++++++ .../gfsh/command-pages/version.html | 3278 ++++++++ .../tools_modules/gfsh/command_scripting.html | 3249 ++++++++ .../tools_modules/gfsh/configuring_gfsh.html | 3342 ++++++++ .../gfsh/getting_started_gfsh.html | 3346 ++++++++ .../tools_modules/gfsh/gfsh_command_index.html | 3392 ++++++++ .../gfsh/gfsh_quick_reference.html | 3261 ++++++++ .../gfsh/os_command_line_execution.html | 3256 ++++++++ .../gfsh/quick_ref_commands_by_area.html | 4003 ++++++++++ .../guide/tools_modules/gfsh/starting_gfsh.html | 3275 ++++++++ docs/guide/tools_modules/gfsh/tour_of_gfsh.html | 3575 +++++++++ .../gfsh/useful_gfsh_shell_variables.html | 3342 ++++++++ .../http_session_mgmt/chapter_overview.html | 3270 ++++++++ .../common_gemfire_topologies.html | 3253 ++++++++ .../http_session_mgmt/http_why_use_gemfire.html | 3273 ++++++++ .../http_session_mgmt/interactive_mode_ref.html | 3315 ++++++++ .../http_session_mgmt/quick_start.html | 3403 ++++++++ .../session_mgmt_tcserver.html | 3253 ++++++++ .../http_session_mgmt/session_mgmt_tomcat.html | 3253 ++++++++ .../session_mgmt_weblogic.html | 3250 ++++++++ .../session_state_log_files.html | 3310 ++++++++ .../http_session_mgmt/tc_additional_info.html | 3266 ++++++++ .../tc_changing_gf_default_cfg.html | 3302 ++++++++ .../tc_installing_the_module.html | 3257 ++++++++ .../tc_setting_up_the_module.html | 3340 ++++++++ .../tomcat_changing_gf_default_cfg.html | 3404 ++++++++ .../tomcat_installing_the_module.html | 3257 ++++++++ .../tomcat_setting_up_the_module.html | 3310 ++++++++ .../weblogic_changing_gf_default_cfg.html | 3426 ++++++++ .../weblogic_common_configuration_changes.html | 3258 ++++++++ .../weblogic_setting_up_the_module.html | 3417 ++++++++ .../tools_modules/pulse/chapter_overview.html | 3261 ++++++++ docs/guide/tools_modules/pulse/quickstart.html | 4009 ++++++++++ .../pulse/system_requirements.html | 3252 ++++++++ docs/guide/tools_modules/redis_adapter.html | 3313 ++++++++ docs/guide/topologies_and_comm/book_intro.html | 3256 ++++++++ .../cs_configuration/chapter_overview.html | 3263 ++++++++ .../client_server_example_configurations.html | 3353 ++++++++ .../client_server_whats_next.html | 3272 ++++++++ .../configure_servers_into_logical_groups.html | 3263 ++++++++ .../setting_up_a_client_server_system.html | 3292 ++++++++ .../standard_client_server_deployment.html | 3252 ++++++++ .../chapter_overview.html | 3257 ++++++++ .../multisite_topologies.html | 3285 ++++++++ .../setting_up_a_multisite_system.html | 3545 +++++++++ .../p2p_configuration/chapter_overview.html | 3251 ++++++++ .../configuring_peer_member_groups.html | 3266 ++++++++ .../setting_up_a_p2p_system.html | 3251 ++++++++ .../setting_up_peer_communication.html | 3271 ++++++++ .../topology_concepts/IPv4_and_IPv6.html | 3263 ++++++++ .../topology_concepts/chapter_overview.html | 3260 ++++++++ .../how_communication_works.html | 3276 ++++++++ .../how_member_discovery_works.html | 3279 ++++++++ .../how_multisite_systems_work.html | 3257 ++++++++ .../how_server_discovery_works.html | 3279 ++++++++ .../how_the_pool_manages_connections.html | 3307 ++++++++ .../topology_concepts/member_communication.html | 3269 ++++++++ .../topology_concepts/multisite_overview.html | 3337 ++++++++ .../topology_concepts/topology_types.html | 3269 ++++++++ .../topology_concepts/using_bind_addresses.html | 3389 ++++++++ docs/index.html | 3 +- fonts/font-awesome/fontawesome-webfont.eot | Bin 0 -> 76204 bytes fonts/font-awesome/fontawesome-webfont.svg | 685 ++ fonts/font-awesome/fontawesome-webfont.ttf | Bin 0 -> 152364 bytes fonts/font-awesome/fontawesome-webfont.woff | Bin 0 -> 90144 bytes fonts/font-awesome/fontawesome-webfont.woff2 | Bin 0 -> 71760 bytes images/favicon.ico | Bin 0 -> 1317 bytes javascripts/all.js | 1085 +++ javascripts/book.js | 953 +++ javascripts/bookbinder.js | 130 + javascripts/waypoints/context.js | 316 + javascripts/waypoints/group.js | 121 + javascripts/waypoints/noframeworkAdapter.js | 229 + javascripts/waypoints/sticky.js | 79 + javascripts/waypoints/waypoint.js | 176 + stylesheets/all.css | 1590 ++++ stylesheets/base | 1869 +++++ stylesheets/book-styles | 3 + stylesheets/layout-styles | 0 stylesheets/print-book-styles | 0 stylesheets/print-layout-styles | 0 stylesheets/print.css | 38 + subnavs/geode-subnav | 3098 ++++++++ 676 files changed, 1811338 insertions(+), 2 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/f717e513/docs/guide/CONTRIBUTE ---------------------------------------------------------------------- diff --git a/docs/guide/CONTRIBUTE b/docs/guide/CONTRIBUTE new file mode 100644 index 0000000..804fdb3 --- /dev/null +++ b/docs/guide/CONTRIBUTE @@ -0,0 +1,37 @@ +<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>
