GEODE-2031: Update Apache Geode website with versioned documentation
Project: http://git-wip-us.apache.org/repos/asf/geode/repo Commit: http://git-wip-us.apache.org/repos/asf/geode/commit/79c89cbd Tree: http://git-wip-us.apache.org/repos/asf/geode/tree/79c89cbd Diff: http://git-wip-us.apache.org/repos/asf/geode/diff/79c89cbd Branch: refs/heads/asf-site Commit: 79c89cbd58c574d61854fac4aa34821dc2340783 Parents: a08e92e Author: Karen Miller <[email protected]> Authored: Mon Jan 16 15:57:56 2017 -0800 Committer: Karen Miller <[email protected]> Committed: Mon Jan 16 15:57:56 2017 -0800 ---------------------------------------------------------------------- community/index.html | 54 +- docs/guide/10/CONTRIBUTE | 53 + docs/guide/10/about_geode.html | 3209 ++++++++ docs/guide/10/basic_config/book_intro.html | 3222 ++++++++ .../config_concepts/chapter_overview.html | 3222 ++++++++ ...distributed_system_member_configuration.html | 3238 ++++++++ .../config_concepts/local_vs_remote.html | 3212 ++++++++ .../chapter_overview.html | 3216 ++++++++ .../managing_data_entries.html | 3315 ++++++++ .../using_custom_classes.html | 3241 ++++++++ .../data_regions/chapter_overview.html | 3232 ++++++++ .../data_regions/create_a_region_with_gfsh.html | 3227 ++++++++ .../creating_custom_attributes.html | 3250 ++++++++ .../data_regions/managing_data_regions.html | 3489 +++++++++ .../managing_region_attributes.html | 3285 ++++++++ .../data_regions/new_region_existing_data.html | 3211 ++++++++ .../data_regions/region_naming.html | 3217 ++++++++ .../data_regions/region_shortcuts.html | 3316 ++++++++ .../store_retrieve_region_shortcuts.html | 3258 ++++++++ .../setting_distributed_properties.html | 3260 ++++++++ .../the_cache/chapter_overview.html | 3228 ++++++++ .../the_cache/intro_cache_management.html | 3281 ++++++++ .../the_cache/managing_a_client_cache.html | 3256 ++++++++ .../the_cache/managing_a_multiuser_cache.html | 3250 ++++++++ .../the_cache/managing_a_peer_server_cache.html | 3258 ++++++++ .../the_cache/managing_a_secure_cache.html | 3244 ++++++++ .../the_cache/setting_cache_initializer.html | 3250 ++++++++ .../the_cache/setting_cache_properties.html | 3225 ++++++++ docs/guide/10/configuring/chapter_overview.html | 3257 ++++++++ .../deploying_application_jars.html | 3286 ++++++++ .../cluster_config/export-import.html | 3233 ++++++++ .../gfsh_config_troubleshooting.html | 3260 ++++++++ .../gfsh_load_from_shared_dir.html | 3228 ++++++++ .../cluster_config/gfsh_persist.html | 3325 ++++++++ .../configuring/cluster_config/gfsh_remote.html | 3263 ++++++++ .../persisting_configurations.html | 3466 +++++++++ .../cluster_config/using_member_groups.html | 3229 ++++++++ .../configuring/running/change_file_spec.html | 3233 ++++++++ .../configuring/running/default_file_specs.html | 3263 ++++++++ .../running/deploy_config_files_intro.html | 3223 ++++++++ .../running/deploying_config_files.html | 3227 ++++++++ .../running/deploying_config_jar_files.html | 3236 ++++++++ .../running/firewall_ports_config.html | 3216 ++++++++ .../running/firewalls_connections.html | 3220 ++++++++ .../running/firewalls_multisite.html | 3270 ++++++++ .../10/configuring/running/firewalls_ports.html | 3429 ++++++++ .../running/managing_output_files.html | 3216 ++++++++ .../running/running_the_cacheserver.html | 3342 ++++++++ .../running/running_the_locator.html | 3398 ++++++++ .../running/starting_up_shutting_down.html | 3315 ++++++++ docs/guide/10/developing/book_intro.html | 3248 ++++++++ .../continuous_querying/chapter_overview.html | 3221 ++++++++ .../continuous_querying_whats_next.html | 3331 ++++++++ .../how_continuous_querying_works.html | 3297 ++++++++ .../implementing_continuous_querying.html | 3382 ++++++++ .../PDX_Serialization_Features.html | 3225 ++++++++ .../data_serialization/auto_serialization.html | 3316 ++++++++ ...erialization_with_class_pattern_strings.html | 3252 ++++++++ .../data_serialization/chapter_overview.html | 3222 ++++++++ .../data_serialization_options.html | 3289 ++++++++ .../extending_the_autoserializer.html | 3309 ++++++++ .../gemfire_data_serialization.html | 3234 ++++++++ .../gemfire_pdx_serialization.html | 3240 ++++++++ .../data_serialization/java_serialization.html | 3212 ++++++++ .../jsonformatter_pdxinstances.html | 3235 ++++++++ .../persist_pdx_metadata_to_disk.html | 3236 ++++++++ .../program_application_for_pdx.html | 3288 ++++++++ .../use_pdx_high_level_steps.html | 3232 ++++++++ .../use_pdx_serializable.html | 3294 ++++++++ .../data_serialization/use_pdx_serializer.html | 3319 ++++++++ .../using_PdxInstanceFactory.html | 3231 ++++++++ .../using_pdx_region_entry_keys.html | 3214 ++++++++ .../delta_propagation/chapter_overview.html | 3228 ++++++++ .../delta_propagation_example.html | 3314 ++++++++ .../delta_propagation_properties.html | 3276 ++++++++ .../errors_in_delta_propagation.html | 3226 ++++++++ .../how_delta_propagation_works.html | 3265 ++++++++ .../implementing_delta_propagation.html | 3229 ++++++++ .../when_to_use_delta_prop.html | 3219 ++++++++ .../distributed_regions/chapter_overview.html | 3225 ++++++++ .../choosing_level_of_dist.html | 3220 ++++++++ .../how_distribution_works.html | 3233 ++++++++ .../how_region_versioning_works.html | 3312 ++++++++ .../how_region_versioning_works_wan.html | 3227 ++++++++ .../how_replication_works.html | 3237 ++++++++ .../locking_in_global_regions.html | 3284 ++++++++ .../managing_distributed_regions.html | 3238 ++++++++ .../region_entry_versions.html | 3230 ++++++++ .../events/cache_event_handler_examples.html | 3319 ++++++++ .../10/developing/events/chapter_overview.html | 3225 ++++++++ ...configure_client_server_event_messaging.html | 3264 ++++++++ .../configure_multisite_event_messaging.html | 3222 ++++++++ .../events/configure_p2p_event_messaging.html | 3233 ++++++++ .../configuring_gateway_concurrency_levels.html | 3334 ++++++++ ...iguring_highly_available_gateway_queues.html | 3290 ++++++++ .../configuring_highly_available_servers.html | 3248 ++++++++ .../conflate_multisite_gateway_queue.html | 3299 ++++++++ .../conflate_server_subscription_queue.html | 3230 ++++++++ .../events/event_handler_overview.html | 3222 ++++++++ .../events/filtering_multisite_events.html | 3294 ++++++++ .../events/ha_event_messaging_whats_next.html | 3273 ++++++++ .../events/how_cache_events_work.html | 3266 ++++++++ .../how_client_server_distribution_works.html | 3346 ++++++++ .../10/developing/events/how_events_work.html | 3302 ++++++++ .../how_multisite_distribution_works.html | 3260 ++++++++ .../implementing_cache_event_handlers.html | 3325 ++++++++ ...menting_durable_client_server_messaging.html | 3385 ++++++++ ...implementing_write_behind_event_handler.html | 3405 ++++++++ .../limit_server_subscription_queue_size.html | 3249 ++++++++ .../list_of_event_handlers_and_events.html | 3364 ++++++++ .../events/resolving_multisite_conflicts.html | 3259 ++++++++ .../tune_client_message_tracking_timeout.html | 3230 ++++++++ .../tune_client_server_event_messaging.html | 3220 ++++++++ ...writing_callbacks_that_modify_the_cache.html | 3249 ++++++++ .../developing/eviction/chapter_overview.html | 3218 ++++++++ .../eviction/configuring_data_eviction.html | 3265 ++++++++ .../developing/eviction/how_eviction_works.html | 3223 ++++++++ .../developing/expiration/chapter_overview.html | 3216 ++++++++ .../expiration/configuring_data_expiration.html | 3262 ++++++++ .../expiration/how_expiration_works.html | 3259 ++++++++ .../function_exec/chapter_overview.html | 3219 ++++++++ .../function_exec/function_execution.html | 3442 ++++++++ .../how_function_execution_works.html | 3324 ++++++++ .../chapter_overview.html | 3222 ++++++++ .../outside_data_sources/chapter_overview.html | 3222 ++++++++ .../how_data_loaders_work.html | 3237 ++++++++ .../implementing_data_loaders.html | 3270 ++++++++ .../outside_data_sources/sync_outside_data.html | 3219 ++++++++ .../automated_rebalance.html | 3252 ++++++++ .../partitioned_regions/chapter_overview.html | 3241 ++++++++ .../checking_region_redundancy.html | 3232 ++++++++ .../colocating_partitioned_region_data.html | 3315 ++++++++ .../configure_pr_single_hop.html | 3216 ++++++++ .../configuring_bucket_for_pr.html | 3250 ++++++++ .../configuring_ha_for_pr.html | 3243 ++++++++ ...custom_partitioning_and_data_colocation.html | 3247 ++++++++ .../how_partitioning_works.html | 3244 ++++++++ .../partitioned_regions/how_pr_ha_works.html | 3251 ++++++++ .../how_pr_single_hop_works.html | 3235 ++++++++ .../join_query_partitioned_regions.html | 3271 ++++++++ .../managing_partitioned_regions.html | 3229 ++++++++ .../moving_partitioned_data.html | 3253 ++++++++ ...custom_partitioning_and_data_colocation.html | 3219 ++++++++ .../overview_how_pr_ha_works.html | 3216 ++++++++ .../overview_how_pr_single_hop_works.html | 3216 ++++++++ .../rebalancing_pr_data.html | 3285 ++++++++ .../set_crash_redundancy_recovery.html | 3248 ++++++++ .../set_enforce_unique_host.html | 3214 ++++++++ .../set_join_redundancy_recovery.html | 3254 ++++++++ .../partitioned_regions/set_pr_redundancy.html | 3228 ++++++++ .../set_redundancy_zones.html | 3223 ++++++++ .../using_custom_partition_resolvers.html | 3404 ++++++++ .../query_additional/advanced_querying.html | 3228 ++++++++ .../query_additional/case_sensitivity.html | 3213 ++++++++ .../developing/query_additional/literals.html | 3272 ++++++++ .../developing/query_additional/operators.html | 3259 ++++++++ .../order_by_on_partitioned_regions.html | 3215 ++++++++ .../partitioned_region_key_or_field_value.html | 3266 ++++++++ .../partitioned_region_query_restrictions.html | 3229 ++++++++ .../query_additional/query_debugging.html | 3262 ++++++++ .../query_language_features.html | 3219 ++++++++ .../query_on_a_single_node.html | 3345 ++++++++ .../query_additional/supported_keywords.html | 3329 ++++++++ .../using_query_bind_parameters.html | 3244 ++++++++ .../query_index/create_multiple_indexes.html | 3246 ++++++++ .../query_index/creating_an_index.html | 3277 ++++++++ .../query_index/creating_hash_indexes.html | 3246 ++++++++ .../query_index/creating_key_indexes.html | 3242 ++++++++ .../query_index/creating_map_indexes.html | 3232 ++++++++ .../developing/query_index/index_samples.html | 3257 ++++++++ .../indexes_on_single_region_queries.html | 3226 ++++++++ .../indexes_with_overflow_regions.html | 3234 ++++++++ .../query_index/indexing_guidelines.html | 3229 ++++++++ .../query_index/maintaining_indexes.html | 3250 ++++++++ .../10/developing/query_index/query_index.html | 3252 ++++++++ .../query_index/query_index_hints.html | 3217 ++++++++ .../using_indexes_with_equijoin_queries.html | 3269 ++++++++ ..._with_equijoin_queries_multiple_regions.html | 3311 ++++++++ .../10/developing/query_select/aggregates.html | 3288 ++++++++ .../query_select/the_from_clause.html | 3266 ++++++++ .../query_select/the_import_statement.html | 3211 ++++++++ .../query_select/the_select_statement.html | 3360 ++++++++ .../query_select/the_where_clause.html | 3486 +++++++++ .../querying_basics/chapter_overview.html | 3221 ++++++++ .../comments_in_query_strings.html | 3210 ++++++++ .../monitor_queries_for_low_memory.html | 3223 ++++++++ .../querying_basics/oql_compared_to_sql.html | 3216 ++++++++ .../performance_considerations.html | 3218 ++++++++ .../querying_basics/query_basics.html | 3232 ++++++++ .../query_grammar_and_reserved_words.html | 3340 ++++++++ .../querying_partitioned_regions.html | 3221 ++++++++ .../querying_basics/reserved_words.html | 3306 ++++++++ .../restrictions_and_unsupported_features.html | 3218 ++++++++ .../querying_basics/running_a_query.html | 3266 ++++++++ .../supported_character_sets.html | 3207 ++++++++ .../querying_basics/what_is_a_query_string.html | 3234 ++++++++ .../region_options/chapter_overview.html | 3222 ++++++++ .../data_hosts_and_accessors.html | 3216 ++++++++ .../region_options/dynamic_region_creation.html | 3374 ++++++++ .../developing/region_options/region_types.html | 3339 ++++++++ .../storage_distribution_options.html | 3226 ++++++++ .../storing_data_on_disk/chapter_overview.html | 3224 ++++++++ .../how_persist_overflow_work.html | 3249 ++++++++ .../overflow_config_examples.html | 3232 ++++++++ .../storing_data_on_disk.html | 3269 ++++++++ .../transactions/JTA_transactions.html | 3404 ++++++++ .../transactions/about_transactions.html | 3231 ++++++++ .../transactions/cache_plugins_with_jta.html | 3211 ++++++++ .../cache_transaction_performance.html | 3214 ++++++++ .../transactions/cache_transactions.html | 3230 ++++++++ .../cache_transactions_by_region_type.html | 3352 ++++++++ .../transactions/chapter_overview.html | 3228 ++++++++ .../client_server_transactions.html | 3236 ++++++++ .../configuring_db_connections_using_JNDI.html | 3490 +++++++++ .../data_location_cache_transactions.html | 3217 ++++++++ .../how_cache_transactions_work.html | 3259 ++++++++ .../transactions/jca_adapter_example.html | 3231 ++++++++ .../monitor_troubleshoot_transactions.html | 3244 ++++++++ .../transactions/run_a_cache_transaction.html | 3298 ++++++++ ...un_a_cache_transaction_with_external_db.html | 3235 ++++++++ .../transaction_coding_examples.html | 3225 ++++++++ .../transaction_event_management.html | 3233 ++++++++ .../transaction_jta_gemfire_example.html | 3228 ++++++++ .../transactions/transaction_semantics.html | 3239 ++++++++ .../transaction_suspend_resume_example.html | 3218 ++++++++ .../transactional_and_nontransactional_ops.html | 3424 ++++++++ .../transactional_function_example.html | 3252 ++++++++ .../transactions/transactions_overview.html | 3247 ++++++++ .../transactions/turning_off_jta.html | 3220 ++++++++ .../transactions/working_with_transactions.html | 3389 ++++++++ .../15_minute_quickstart_gfsh.html | 3614 +++++++++ docs/guide/10/getting_started/book_intro.html | 3222 ++++++++ .../10/getting_started/geode_overview.html | 3222 ++++++++ .../installation/install_standalone.html | 3282 ++++++++ .../guide/10/getting_started/product_intro.html | 3288 ++++++++ .../querying_quick_reference.html | 3672 +++++++++ .../10/getting_started/setup_classpath.html | 3284 ++++++++ .../system_requirements/host_machine.html | 3238 ++++++++ .../10/getting_started/uninstall_geode.html | 3209 ++++++++ .../10/images/ClientServerAdvancedTopics-5.gif | Bin 0 -> 10798 bytes .../10/images/ClientServerAdvancedTopics-6.gif | Bin 0 -> 12056 bytes .../10/images/ClientServerAdvancedTopics-7.gif | Bin 0 -> 5000 bytes docs/guide/10/images/ContinuousQuerying-1.gif | Bin 0 -> 6955 bytes docs/guide/10/images/ContinuousQuerying-3.gif | Bin 0 -> 9141 bytes docs/guide/10/images/DataManagement-9.png | Bin 0 -> 48188 bytes docs/guide/10/images/DeltaPropagation-1.gif | Bin 0 -> 7593 bytes docs/guide/10/images/DeltaPropagation-3.gif | Bin 0 -> 6843 bytes docs/guide/10/images/Events-2.gif | Bin 0 -> 8793 bytes docs/guide/10/images/Events-3.gif | Bin 0 -> 6432 bytes docs/guide/10/images/FuncExecOnMembers.png | Bin 0 -> 64959 bytes .../10/images/FuncExecOnRegionHAWithFilter.png | Bin 0 -> 80141 bytes .../10/images/FuncExecOnRegionNoMetadata.png | Bin 0 -> 70177 bytes .../images/FuncExecOnRegionPeersWithFilter.png | Bin 0 -> 86576 bytes .../10/images/FuncExecOnRegionWithFilter.png | Bin 0 -> 60773 bytes .../10/images/FuncExecOnRegionWithMetadata.png | Bin 0 -> 59576 bytes docs/guide/10/images/FuncExecOnServers.png | Bin 0 -> 57470 bytes docs/guide/10/images/Gemcached.png | Bin 0 -> 87366 bytes docs/guide/10/images/JConsole.png | Bin 0 -> 64272 bytes docs/guide/10/images/MultiSite-4.gif | Bin 0 -> 4991 bytes .../images/MultisiteConcurrency_WAN_Gateway.png | Bin 0 -> 103701 bytes docs/guide/10/images/SQLite_Persistence_Mgr.png | Bin 0 -> 58388 bytes .../10/images/Statistics-implementation.png | Bin 0 -> 28057 bytes docs/guide/10/images/Statistics-interfaces.png | Bin 0 -> 28312 bytes docs/guide/10/images/Transaction-simple.png | Bin 0 -> 119831 bytes docs/guide/10/images/consistent_multisite.png | Bin 0 -> 39442 bytes docs/guide/10/images/diskStores-1.gif | Bin 0 -> 7292 bytes docs/guide/10/images/diskStores-3.gif | Bin 0 -> 5898 bytes docs/guide/10/images/jconsole_mbeans.png | Bin 0 -> 211394 bytes docs/guide/10/images/jvisualvm.png | Bin 0 -> 90153 bytes docs/guide/10/images/logging-1.gif | Bin 0 -> 2778 bytes docs/guide/10/images/member_view_list.png | Bin 0 -> 107811 bytes .../10/images/multisite-topology-avoid-3.png | Bin 0 -> 9794 bytes .../10/images/multisite-topology-hybrid-1.png | Bin 0 -> 7627 bytes .../10/images/multisite-topology-hybrid-2.png | Bin 0 -> 7631 bytes .../10/images/multisite-topology-parallel.png | Bin 0 -> 7838 bytes .../10/images/multisite-topology-serial.png | Bin 0 -> 6886 bytes docs/guide/10/images/parallel_sender.png | Bin 0 -> 36089 bytes docs/guide/10/images/pulse-data-browser.png | Bin 0 -> 99987 bytes docs/guide/10/images/pulse-region-detail.png | Bin 0 -> 61149 bytes docs/guide/10/images/pulse_alerts_widget.png | Bin 0 -> 137883 bytes docs/guide/10/images/pulse_cluster_view.png | Bin 0 -> 154531 bytes docs/guide/10/images/pulse_data_view.png | Bin 0 -> 138140 bytes docs/guide/10/images/pulse_locator.png | Bin 0 -> 228513 bytes docs/guide/10/images/pulse_member_view.png | Bin 0 -> 132309 bytes .../10/images/rest_example_java_packages.png | Bin 0 -> 30206 bytes docs/guide/10/images/security-1.gif | Bin 0 -> 8343 bytes docs/guide/10/images/security-3.gif | Bin 0 -> 8287 bytes docs/guide/10/images/security-4.gif | Bin 0 -> 7028 bytes docs/guide/10/images/security-5.gif | Bin 0 -> 7408 bytes docs/guide/10/images/serial_sender.png | Bin 0 -> 32385 bytes docs/guide/10/images/swagger_home.png | Bin 0 -> 187378 bytes docs/guide/10/images/swagger_post_region.png | Bin 0 -> 170963 bytes .../10/images/swagger_post_region_response.png | Bin 0 -> 176783 bytes docs/guide/10/images/swagger_v1.png | Bin 0 -> 149806 bytes docs/guide/10/images/swagger_v1_response.png | Bin 0 -> 143134 bytes docs/guide/10/images/transactions-client-1.png | Bin 0 -> 113816 bytes .../10/images/transactions_jca_adapter.png | Bin 0 -> 104775 bytes docs/guide/10/images/transactions_jta.png | Bin 0 -> 104780 bytes .../10/images/transactions_jta_app_server.png | Bin 0 -> 91885 bytes docs/guide/10/images_svg/JMX_Architecture.svg | 3 + docs/guide/10/images_svg/MBeans.svg | 3 + .../async_system_queue_conflation.svg | 3 + docs/guide/10/images_svg/cache_data_loader.svg | 3 + .../guide/10/images_svg/cache_data_loader_2.svg | 3 + .../10/images_svg/client_server_deployment.svg | 3 + .../10/images_svg/client_server_event_dist.svg | 3 + .../client_server_message_tracking.svg | 3 + .../10/images_svg/cluster-group-config.svg | 3 + .../10/images_svg/cluster_config_overview.svg | 3 + .../colocated_partitioned_regions.svg | 3 + docs/guide/10/images_svg/cs_connection_pool.svg | 3 + .../10/images_svg/cs_locator_discovery.svg | 3 + docs/guide/10/images_svg/cs_subscriptions.svg | 3 + docs/guide/10/images_svg/cs_topology.svg | 3 + docs/guide/10/images_svg/custom_partitioned.svg | 3 + .../guide/10/images_svg/developing_overflow.svg | 3 + .../10/images_svg/developing_persistence.svg | 3 + .../developing_persistence_and_overflow.svg | 3 + docs/guide/10/images_svg/distributed_how_1.svg | 3 + docs/guide/10/images_svg/distributed_how_2.svg | 3 + docs/guide/10/images_svg/distributed_how_3.svg | 3 + .../guide/10/images_svg/distributed_preload.svg | 3 + .../guide/10/images_svg/distributed_replica.svg | 3 + .../images_svg/distributed_replica_preload.svg | 3 + docs/guide/10/images_svg/expiration.svg | 3 + .../10/images_svg/how_partitioning_works_1.svg | 3 + .../10/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/10/images_svg/locator_discovery.svg | 3 + .../guide/10/images_svg/member_severe_alert.svg | 3 + .../images_svg/network_partition_scenario.svg | 3 + docs/guide/10/images_svg/p2p_topology.svg | 3 + .../guide/10/images_svg/partitioned_data_HA.svg | 3 + .../images_svg/partitioned_data_buckets_1.svg | 3 + .../images_svg/partitioned_data_buckets_2.svg | 3 + .../10/images_svg/region_entry_versions_1.svg | 3 + .../10/images_svg/region_entry_versions_2.svg | 3 + .../10/images_svg/region_entry_versions_3.svg | 3 + .../10/images_svg/server_client_event_dist.svg | 3 + docs/guide/10/images_svg/server_discovery.svg | 3 + docs/guide/10/images_svg/server_grouping.svg | 3 + .../images_svg/transactions_partitioned_1.svg | 3 + .../images_svg/transactions_partitioned_2.svg | 3 + .../10/images_svg/transactions_replicate_1.svg | 3 + .../10/images_svg/transactions_replicate_2.svg | 3 + .../10/images_svg/transactions_replicate_3.svg | 3 + .../10/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 + .../10/images_svg/tune_cs_event_messaging.svg | 3 + .../unbalanced_network_capacity_probs.svg | 3 + .../autoreconnect/member-reconnect.html | 3262 ++++++++ docs/guide/10/managing/book_intro.html | 3244 ++++++++ .../cache_snapshots/chapter_overview.html | 3232 ++++++++ .../cache_snapshots/exporting_a_snapshot.html | 3247 ++++++++ .../filtering_snapshot_entries.html | 3226 ++++++++ .../cache_snapshots/importing_a_snapshot.html | 3256 ++++++++ .../read_snapshots_programmatically.html | 3223 ++++++++ .../using_cache_and_region_snapshots.html | 3226 ++++++++ .../disk_storage/backup_restore_disk_store.html | 3366 ++++++++ .../managing/disk_storage/chapter_overview.html | 3234 ++++++++ .../disk_storage/compacting_disk_stores.html | 3316 ++++++++ .../disk_free_space_monitoring.html | 3238 ++++++++ .../disk_store_configuration_params.html | 3317 ++++++++ .../disk_storage/file_names_and_extensions.html | 3343 ++++++++ .../handling_missing_disk_stores.html | 3255 ++++++++ .../disk_storage/how_disk_stores_work.html | 3250 ++++++++ .../keeping_offline_disk_store_in_sync.html | 3244 ++++++++ .../managing_disk_buffer_flushes.html | 3223 ++++++++ .../disk_storage/managing_disk_stores.html | 3221 ++++++++ .../disk_storage/managing_disk_stores_cmds.html | 3283 ++++++++ .../managing/disk_storage/operation_logs.html | 3245 ++++++++ .../optimize_availability_and_performance.html | 3217 ++++++++ .../overview_using_disk_stores.html | 3219 ++++++++ .../starting_system_with_disk_stores.html | 3316 ++++++++ .../disk_storage/using_disk_stores.html | 3381 ++++++++ .../using_the_default_disk_store.html | 3245 ++++++++ .../disk_storage/validating_disk_store.html | 3219 ++++++++ .../10/managing/heap_use/heap_management.html | 3408 ++++++++ .../guide/10/managing/heap_use/lock_memory.html | 3227 ++++++++ .../managing/heap_use/off_heap_management.html | 3385 ++++++++ .../10/managing/logging/configuring_log4j2.html | 3249 ++++++++ .../10/managing/logging/how_logging_works.html | 3222 ++++++++ docs/guide/10/managing/logging/logging.html | 3225 ++++++++ .../10/managing/logging/logging_categories.html | 3401 ++++++++ .../10/managing/logging/logging_whats_next.html | 3234 ++++++++ .../10/managing/logging/setting_up_logging.html | 3251 ++++++++ .../management/configuring_rmi_connector.html | 3219 ++++++++ .../management/gfsh_and_management_api.html | 3243 ++++++++ .../managing/management/jmx_manager_node.html | 3220 ++++++++ .../management/jmx_manager_operations.html | 3379 ++++++++ .../management/list_of_mbean_notifications.html | 3392 ++++++++ .../10/managing/management/list_of_mbeans.html | 3222 ++++++++ .../management/list_of_mbeans_full.html | 3603 +++++++++ .../management/management_and_monitoring.html | 3231 ++++++++ .../management_and_monitoring_features.html | 3229 ++++++++ .../management/management_system_overview.html | 3303 ++++++++ .../managing/management/mbean_architecture.html | 3255 ++++++++ .../management/mbean_notifications.html | 3218 ++++++++ .../10/managing/management/mbeans_jconsole.html | 3228 ++++++++ .../10/managing/management/mm_overview.html | 3281 ++++++++ .../notification_federation_and_alerts.html | 3240 ++++++++ .../management/programming_example.html | 3414 ++++++++ .../monitor_tune/cache_consistency.html | 3267 ++++++++ .../managing/monitor_tune/chapter_overview.html | 3237 ++++++++ .../monitor_tune/multicast_communication.html | 3227 ++++++++ ..._communication_configuring_speed_limits.html | 3228 ++++++++ ...st_communication_provisioning_bandwidth.html | 3243 ++++++++ ...st_communication_runtime_considerations.html | 3227 ++++++++ ...nication_testing_multicast_speed_limits.html | 3323 ++++++++ ...multicast_communication_troubleshooting.html | 3221 ++++++++ .../monitor_tune/performance_controls.html | 3227 ++++++++ ...ormance_controls_controlling_socket_use.html | 3233 ++++++++ ...performance_controls_data_serialization.html | 3209 ++++++++ ...formance_controls_increasing_cache_hits.html | 3211 ++++++++ ...rmance_controls_managing_slow_receivers.html | 3255 ++++++++ ...ormance_controls_setting_cache_timeouts.html | 3220 ++++++++ .../monitor_tune/performance_on_vsphere.html | 3329 ++++++++ .../10/managing/monitor_tune/slow_messages.html | 3228 ++++++++ .../managing/monitor_tune/slow_receivers.html | 3218 ++++++++ .../monitor_tune/slow_receivers_managing.html | 3303 ++++++++ .../slow_receivers_preventing_problems.html | 3228 ++++++++ .../monitor_tune/socket_communication.html | 3229 ++++++++ ...communication_ephemeral_tcp_port_limits.html | 3234 ++++++++ ...ocket_communication_have_enough_sockets.html | 3379 ++++++++ ...mmunication_setting_socket_buffer_sizes.html | 3321 ++++++++ ...munication_tcpip_p2p_handshake_timeouts.html | 3215 ++++++++ .../monitor_tune/socket_tcp_keepalive.html | 3214 ++++++++ .../monitor_tune/sockets_and_gateways.html | 3307 ++++++++ .../monitor_tune/system_member_performance.html | 3224 ++++++++ ..._performance_connection_thread_settings.html | 3212 ++++++++ ...r_performance_distributed_system_member.html | 3213 ++++++++ .../system_member_performance_garbage.html | 3232 ++++++++ ...tem_member_performance_jvm_mem_settings.html | 3238 ++++++++ .../monitor_tune/udp_communication.html | 3237 ++++++++ .../network_partitioning/chapter_overview.html | 3228 ++++++++ .../network_partitioning/failure_detection.html | 3248 ++++++++ .../handling_network_partitioning.html | 3241 ++++++++ ...w_network_partitioning_management_works.html | 3246 ++++++++ ...coordinators_lead_members_and_weighting.html | 3270 ++++++++ .../network_partitioning_scenarios.html | 3235 ++++++++ .../preventing_network_partitions.html | 3215 ++++++++ .../region_compression/region_compression.html | 3390 ++++++++ .../security/authentication_examples.html | 3252 ++++++++ .../security/authentication_overview.html | 3225 ++++++++ .../security/authorization_example.html | 3252 ++++++++ .../security/authorization_overview.html | 3218 ++++++++ .../10/managing/security/chapter_overview.html | 3227 ++++++++ .../10/managing/security/enable_security.html | 3253 ++++++++ .../managing/security/encrypting_passwords.html | 3223 ++++++++ .../security/encrypting_with_diffie_helman.html | 3261 ++++++++ .../security/implementing_authentication.html | 3348 ++++++++ .../security/implementing_authorization.html | 3909 ++++++++++ .../security/implementing_security.html | 3265 ++++++++ .../10/managing/security/implementing_ssl.html | 3472 +++++++++ .../10/managing/security/post_processing.html | 3258 ++++++++ .../10/managing/security/properties_file.html | 3219 ++++++++ .../10/managing/security/security-audit.html | 3253 ++++++++ .../security/security_audit_overview.html | 3222 ++++++++ .../10/managing/security/security_intro.html | 3224 ++++++++ .../guide/10/managing/security/ssl_example.html | 3271 ++++++++ .../10/managing/security/ssl_overview.html | 3231 ++++++++ .../application_defined_statistics.html | 3248 ++++++++ .../managing/statistics/chapter_overview.html | 3223 ++++++++ .../statistics/how_statistics_work.html | 3217 ++++++++ .../statistics/setting_up_statistics.html | 3312 ++++++++ .../transient_region_and_entry_statistics.html | 3227 ++++++++ .../managing/statistics/viewing_statistics.html | 3207 ++++++++ .../troubleshooting/chapter_overview.html | 3237 ++++++++ .../diagnosing_system_probs.html | 3616 +++++++++ .../prevent_and_recover_disk_full_errors.html | 3232 ++++++++ .../producing_troubleshooting_artifacts.html | 3262 ++++++++ .../recovering_conflicting_data_exceptions.html | 3254 ++++++++ .../recovering_from_app_crashes.html | 3216 ++++++++ .../recovering_from_cs_crashes.html | 3243 ++++++++ .../recovering_from_machine_crashes.html | 3248 ++++++++ .../recovering_from_network_outages.html | 3253 ++++++++ .../recovering_from_p2p_crashes.html | 3382 ++++++++ .../system_failure_and_recovery.html | 3427 ++++++++ docs/guide/10/prereq_and_install.html | 3222 ++++++++ docs/guide/10/reference/book_intro.html | 3228 ++++++++ .../reference/statistics/statistics_list.html | 7325 ++++++++++++++++++ .../reference/topics/cache-elements-list.html | 3365 ++++++++ docs/guide/10/reference/topics/cache_xml.html | 6328 +++++++++++++++ .../topics/chapter_overview_cache_xml.html | 3228 ++++++++ .../chapter_overview_regionshortcuts.html | 3260 ++++++++ .../topics/client-cache-elements-list.html | 3319 ++++++++ .../guide/10/reference/topics/client-cache.html | 5869 ++++++++++++++ .../guide/10/reference/topics/elements_ref.html | 3303 ++++++++ .../10/reference/topics/gemfire_properties.html | 3841 +++++++++ .../10/reference/topics/gfe_cache_xml.html | 6621 ++++++++++++++++ docs/guide/10/reference/topics/glossary.html | 3801 +++++++++ .../handling_exceptions_and_failures.html | 3217 ++++++++ .../memory_requirements_for_cache_data.html | 3530 +++++++++ .../non-ascii_strings_in_config_files.html | 3220 ++++++++ .../topics/region_shortcuts_reference.html | 4802 ++++++++++++ .../topics/region_shortcuts_table.html | 3703 +++++++++ docs/guide/10/rest_apps/book_intro.html | 3237 ++++++++ docs/guide/10/rest_apps/chapter_overview.html | 3215 ++++++++ docs/guide/10/rest_apps/delete_all_data.html | 3241 ++++++++ .../guide/10/rest_apps/delete_data_for_key.html | 3241 ++++++++ .../delete_data_for_multiple_keys.html | 3241 ++++++++ docs/guide/10/rest_apps/delete_named_query.html | 3263 ++++++++ docs/guide/10/rest_apps/develop_rest_apps.html | 3743 +++++++++ .../10/rest_apps/get_execute_adhoc_query.html | 3306 ++++++++ docs/guide/10/rest_apps/get_functions.html | 3252 ++++++++ docs/guide/10/rest_apps/get_queries.html | 3269 ++++++++ docs/guide/10/rest_apps/get_region_data.html | 3322 ++++++++ .../get_region_data_for_multiple_keys.html | 3422 ++++++++ .../guide/10/rest_apps/get_region_key_data.html | 3277 ++++++++ docs/guide/10/rest_apps/get_region_keys.html | 3255 ++++++++ docs/guide/10/rest_apps/get_regions.html | 3280 ++++++++ docs/guide/10/rest_apps/get_servers.html | 3246 ++++++++ docs/guide/10/rest_apps/head_region_size.html | 3250 ++++++++ docs/guide/10/rest_apps/ping_service.html | 3239 ++++++++ docs/guide/10/rest_apps/post_create_query.html | 3292 ++++++++ .../10/rest_apps/post_execute_functions.html | 3309 ++++++++ docs/guide/10/rest_apps/post_execute_query.html | 3358 ++++++++ .../guide/10/rest_apps/post_if_absent_data.html | 3334 ++++++++ .../rest_apps/put_multiple_values_for_keys.html | 3293 ++++++++ docs/guide/10/rest_apps/put_replace_data.html | 3287 ++++++++ .../guide/10/rest_apps/put_update_cas_data.html | 3405 ++++++++ docs/guide/10/rest_apps/put_update_data.html | 3272 ++++++++ docs/guide/10/rest_apps/put_update_query.html | 3285 ++++++++ docs/guide/10/rest_apps/rest_admin.html | 3216 ++++++++ docs/guide/10/rest_apps/rest_api_reference.html | 3225 ++++++++ docs/guide/10/rest_apps/rest_examples.html | 3870 +++++++++ docs/guide/10/rest_apps/rest_functions.html | 3216 ++++++++ docs/guide/10/rest_apps/rest_prereqs.html | 3225 ++++++++ docs/guide/10/rest_apps/rest_queries.html | 3228 ++++++++ docs/guide/10/rest_apps/rest_regions.html | 3254 ++++++++ docs/guide/10/rest_apps/setup_config.html | 3330 ++++++++ docs/guide/10/rest_apps/troubleshooting.html | 3328 ++++++++ docs/guide/10/rest_apps/using_swagger.html | 3242 ++++++++ docs/guide/10/tools_modules/book_intro.html | 3230 ++++++++ .../gemcached/about_gemcached.html | 3232 ++++++++ .../10/tools_modules/gemcached/advantages.html | 3219 ++++++++ .../gemcached/chapter_overview.html | 3223 ++++++++ .../gemcached/deploying_gemcached.html | 3274 ++++++++ .../guide/10/tools_modules/gfsh/about_gfsh.html | 3227 ++++++++ .../10/tools_modules/gfsh/cache_xml_2_gfsh.html | 3288 ++++++++ .../10/tools_modules/gfsh/chapter_overview.html | 3241 ++++++++ .../tools_modules/gfsh/command-pages/alter.html | 3682 +++++++++ .../gfsh/command-pages/backup.html | 3261 ++++++++ .../gfsh/command-pages/change.html | 3275 ++++++++ .../tools_modules/gfsh/command-pages/clear.html | 3224 ++++++++ .../tools_modules/gfsh/command-pages/close.html | 3332 ++++++++ .../gfsh/command-pages/compact.html | 3316 ++++++++ .../gfsh/command-pages/configure.html | 3281 ++++++++ .../gfsh/command-pages/connect.html | 3347 ++++++++ .../gfsh/command-pages/create.html | 4114 ++++++++++ .../tools_modules/gfsh/command-pages/debug.html | 3238 ++++++++ .../gfsh/command-pages/define.html | 3264 ++++++++ .../gfsh/command-pages/deploy.html | 3266 ++++++++ .../gfsh/command-pages/describe.html | 3593 +++++++++ .../gfsh/command-pages/destroy.html | 3380 ++++++++ .../gfsh/command-pages/disconnect.html | 3224 ++++++++ .../tools_modules/gfsh/command-pages/echo.html | 3245 ++++++++ .../gfsh/command-pages/encrypt.html | 3239 ++++++++ .../gfsh/command-pages/execute.html | 3262 ++++++++ .../tools_modules/gfsh/command-pages/exit.html | 3217 ++++++++ .../gfsh/command-pages/export.html | 3510 +++++++++ .../10/tools_modules/gfsh/command-pages/gc.html | 3243 ++++++++ .../tools_modules/gfsh/command-pages/get.html | 3267 ++++++++ .../tools_modules/gfsh/command-pages/help.html | 3251 ++++++++ .../tools_modules/gfsh/command-pages/hint.html | 3252 ++++++++ .../gfsh/command-pages/history.html | 3247 ++++++++ .../gfsh/command-pages/import.html | 3291 ++++++++ .../tools_modules/gfsh/command-pages/list.html | 3631 +++++++++ .../gfsh/command-pages/load-balance.html | 3246 ++++++++ .../gfsh/command-pages/locate.html | 3272 ++++++++ .../gfsh/command-pages/netstat.html | 3335 ++++++++ .../tools_modules/gfsh/command-pages/pause.html | 3242 ++++++++ .../tools_modules/gfsh/command-pages/pdx.html | 3269 ++++++++ .../tools_modules/gfsh/command-pages/put.html | 3279 ++++++++ .../tools_modules/gfsh/command-pages/query.html | 3257 ++++++++ .../gfsh/command-pages/rebalance.html | 3269 ++++++++ .../gfsh/command-pages/remove.html | 3259 ++++++++ .../gfsh/command-pages/resume.html | 3242 ++++++++ .../gfsh/command-pages/revoke.html | 3244 ++++++++ .../tools_modules/gfsh/command-pages/run.html | 3279 ++++++++ .../tools_modules/gfsh/command-pages/set.html | 3252 ++++++++ .../10/tools_modules/gfsh/command-pages/sh.html | 3250 ++++++++ .../tools_modules/gfsh/command-pages/show.html | 3478 +++++++++ .../gfsh/command-pages/shutdown.html | 3250 ++++++++ .../tools_modules/gfsh/command-pages/sleep.html | 3241 ++++++++ .../tools_modules/gfsh/command-pages/start.html | 3999 ++++++++++ .../gfsh/command-pages/status.html | 3507 +++++++++ .../tools_modules/gfsh/command-pages/stop.html | 3434 ++++++++ .../gfsh/command-pages/undeploy.html | 3262 ++++++++ .../gfsh/command-pages/validate.html | 3236 ++++++++ .../gfsh/command-pages/version.html | 3246 ++++++++ .../tools_modules/gfsh/command_scripting.html | 3217 ++++++++ .../10/tools_modules/gfsh/configuring_gfsh.html | 3310 ++++++++ .../gfsh/getting_started_gfsh.html | 3314 ++++++++ .../tools_modules/gfsh/gfsh_command_index.html | 3360 ++++++++ .../gfsh/gfsh_quick_reference.html | 3229 ++++++++ .../gfsh/os_command_line_execution.html | 3224 ++++++++ .../gfsh/quick_ref_commands_by_area.html | 3971 ++++++++++ .../10/tools_modules/gfsh/starting_gfsh.html | 3243 ++++++++ .../10/tools_modules/gfsh/tour_of_gfsh.html | 3543 +++++++++ .../gfsh/useful_gfsh_shell_variables.html | 3310 ++++++++ .../http_session_mgmt/chapter_overview.html | 3238 ++++++++ .../common_gemfire_topologies.html | 3221 ++++++++ .../http_session_mgmt/http_why_use_gemfire.html | 3241 ++++++++ .../http_session_mgmt/interactive_mode_ref.html | 3283 ++++++++ .../http_session_mgmt/quick_start.html | 3322 ++++++++ .../session_mgmt_tcserver.html | 3221 ++++++++ .../http_session_mgmt/session_mgmt_tomcat.html | 3221 ++++++++ .../session_mgmt_weblogic.html | 3218 ++++++++ .../session_state_log_files.html | 3278 ++++++++ .../http_session_mgmt/tc_additional_info.html | 3239 ++++++++ .../tc_changing_gf_default_cfg.html | 3270 ++++++++ .../tc_installing_the_module.html | 3213 ++++++++ .../tc_setting_up_the_module.html | 3308 ++++++++ .../tomcat_changing_gf_default_cfg.html | 3372 ++++++++ .../tomcat_installing_the_module.html | 3225 ++++++++ .../tomcat_setting_up_the_module.html | 3286 ++++++++ .../weblogic_changing_gf_default_cfg.html | 3394 ++++++++ .../weblogic_common_configuration_changes.html | 3226 ++++++++ .../weblogic_setting_up_the_module.html | 3385 ++++++++ .../10/tools_modules/lucene_integration.html | 3312 ++++++++ .../tools_modules/pulse/chapter_overview.html | 3229 ++++++++ .../10/tools_modules/pulse/quickstart.html | 3977 ++++++++++ .../pulse/system_requirements.html | 3220 ++++++++ docs/guide/10/tools_modules/redis_adapter.html | 3281 ++++++++ .../10/topologies_and_comm/book_intro.html | 3224 ++++++++ .../cs_configuration/chapter_overview.html | 3231 ++++++++ .../client_server_example_configurations.html | 3321 ++++++++ .../client_server_whats_next.html | 3240 ++++++++ .../configure_servers_into_logical_groups.html | 3231 ++++++++ .../setting_up_a_client_server_system.html | 3260 ++++++++ .../standard_client_server_deployment.html | 3220 ++++++++ .../chapter_overview.html | 3225 ++++++++ .../multisite_topologies.html | 3294 ++++++++ .../setting_up_a_multisite_system.html | 3513 +++++++++ .../p2p_configuration/chapter_overview.html | 3219 ++++++++ .../configuring_peer_member_groups.html | 3234 ++++++++ .../setting_up_a_p2p_system.html | 3219 ++++++++ .../setting_up_peer_communication.html | 3239 ++++++++ .../topology_concepts/IPv4_and_IPv6.html | 3231 ++++++++ .../topology_concepts/chapter_overview.html | 3228 ++++++++ .../how_communication_works.html | 3244 ++++++++ .../how_member_discovery_works.html | 3247 ++++++++ .../how_multisite_systems_work.html | 3225 ++++++++ .../how_server_discovery_works.html | 3247 ++++++++ .../how_the_pool_manages_connections.html | 3275 ++++++++ .../topology_concepts/member_communication.html | 3237 ++++++++ .../topology_concepts/multisite_overview.html | 3300 ++++++++ .../topology_concepts/topology_types.html | 3237 ++++++++ .../topology_concepts/using_bind_addresses.html | 3357 ++++++++ docs/index.html | 18 +- javascripts/bookbinder.js | 15 + releases/index.html | 2 +- subnavs/geode-subnav | 1788 +++-- 657 files changed, 1778242 insertions(+), 972 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/geode/blob/79c89cbd/community/index.html ---------------------------------------------------------------------- diff --git a/community/index.html b/community/index.html index 9952ee8..a5051c4 100644 --- a/community/index.html +++ b/community/index.html @@ -19,7 +19,7 @@ specific language governing permissions and limitations under the License. --> <meta charset="utf-8"> - <title>Apache Geode â </title> + <title>Apache Geode â Community</title> <meta http-equiv="x-ua-compatible" content="ie=edge" /> <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1" /> <meta name="keywords" content="Apache Geode, Geode, GemFire, In-memory, IMDB, IMDG, cache"> @@ -333,58 +333,13 @@ under the License. --> </div> <div class="row"> <div class="col-md-3 done"> - <h3><a target="_blank" href="https://fosdem.org/2016/schedule/event/hpc_bigdata_fastdata1/";>Clubhouse: Domain-driven Design and Reactive Programming</a> <br /> - <small><b>Featuring Vaughn Vernon</b><br/>Virtual Event<br/> September 21, 2016, 9-9:50 am PT</small></h3> - <p> - - </p> - <p> - <ul> - <li> - <a href="https://pivotal.zoom.us/j/540483502"; target="_blank">Watch on Zoom.</a> (Zoom client will download on first use.) - </li> - <li> - Phone (optional): - <ul> - <li> - 408-638-0968 (US toll) or 646-558-8656 (US toll) - </li> - <li> - Meeting ID: 540 483 502 - </li> - <li> <a href="https://pivotal.zoom.us/zoomconference?m=Jnvh-1uWfqE95Tb4M9AwS9X7P9oPTlfH"; target="blank">View international numbers</a> - </li> - </ul> - </p> - </div> - <div class="col-md-3 done"> - <h3><a target="_blank" href="https://pivotal.zoom.us/j/540483502";>Clubhouse: Geode's New Security Infrastructure</a><br /> - <small><b>Featuring Jinmei - Liao</b><br/>Virtual Event<br />October 19, 2016, 9-9:50 am PT</small></h3> - <p> - <ul> - <li> - <a href="https://pivotal.zoom.us/j/540483502"; target="_blank">Watch on Zoom.</a> (Zoom client will download on first use.) - </li> - <li> - Phone (optional): - <ul> - <li> - 408-638-0968 (US toll) or 646-558-8656 (US toll) - </li> - <li> - Meeting ID: 540 483 502 - </li> - <li> <a href="https://pivotal.zoom.us/zoomconference?m=Jnvh-1uWfqE95Tb4M9AwS9X7P9oPTlfH"; target="blank">View international numbers</a> - </li> - </ul> - </p> - </div> + <h3>Watch this space for upcoming Apache Geode events! <br /> + </div> </div> <div class="row"> <div class="col-md-3"> <h3> </h3> - <p><i>Want to organize a Geode event? <a href="mailto:[email protected]";>Contact us!</a></i><p> + <p><i>Want to organize an event? Subscribe to the Apache Geode Users list by sending a blank email to<br/><a href="mailto:[email protected]";>[email protected]</a>, then email the list with your event idea!</i><p> </div> </div> </div> @@ -663,3 +618,4 @@ under the License. --> </body> </html> + http://git-wip-us.apache.org/repos/asf/geode/blob/79c89cbd/docs/guide/10/CONTRIBUTE ---------------------------------------------------------------------- diff --git a/docs/guide/10/CONTRIBUTE b/docs/guide/10/CONTRIBUTE new file mode 100644 index 0000000..b07bfdf --- /dev/null +++ b/docs/guide/10/CONTRIBUTE @@ -0,0 +1,53 @@ +<!-- +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>
