mikewalch closed pull request #93: Created tag for linking to javadocs, properties, and docs URL: https://github.com/apache/accumulo-website/pull/93
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/Gemfile b/Gemfile index 89a99193..a05fec5e 100644 --- a/Gemfile +++ b/Gemfile @@ -1,3 +1,4 @@ source 'https://rubygems.org' -gem 'github-pages', '181', group: :jekyll_plugins +gem 'jekyll', '3.7.3' +gem 'jekyll-redirect-from', '0.13.0' gem 'therubyracer' diff --git a/Gemfile.lock b/Gemfile.lock index 4ce9911f..fa1cebe5 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,87 +1,16 @@ GEM remote: https://rubygems.org/ specs: - activesupport (4.2.9) - i18n (~> 0.7) - minitest (~> 5.1) - thread_safe (~> 0.3, >= 0.3.4) - tzinfo (~> 1.1) addressable (2.5.2) public_suffix (>= 2.0.2, < 4.0) - coffee-script (2.4.1) - coffee-script-source - execjs - coffee-script-source (1.11.1) colorator (1.1.0) - commonmarker (0.17.9) - ruby-enum (~> 0.5) concurrent-ruby (1.0.5) em-websocket (0.5.1) eventmachine (>= 0.12.9) http_parser.rb (~> 0.6.0) - ethon (0.11.0) - ffi (>= 1.3.0) eventmachine (1.2.5) - execjs (2.7.0) - faraday (0.14.0) - multipart-post (>= 1.2, < 3) ffi (1.9.23) forwardable-extended (2.6.0) - gemoji (3.0.0) - github-pages (181) - activesupport (= 4.2.9) - github-pages-health-check (= 1.4.0) - jekyll (= 3.7.3) - jekyll-avatar (= 0.5.0) - jekyll-coffeescript (= 1.1.1) - jekyll-commonmark-ghpages (= 0.1.5) - jekyll-default-layout (= 0.1.4) - jekyll-feed (= 0.9.3) - jekyll-gist (= 1.5.0) - jekyll-github-metadata (= 2.9.4) - jekyll-mentions (= 1.3.0) - jekyll-optional-front-matter (= 0.3.0) - jekyll-paginate (= 1.1.0) - jekyll-readme-index (= 0.2.0) - jekyll-redirect-from (= 0.13.0) - jekyll-relative-links (= 0.5.3) - jekyll-remote-theme (= 0.2.3) - jekyll-sass-converter (= 1.5.2) - jekyll-seo-tag (= 2.4.0) - jekyll-sitemap (= 1.2.0) - jekyll-swiss (= 0.4.0) - jekyll-theme-architect (= 0.1.1) - jekyll-theme-cayman (= 0.1.1) - jekyll-theme-dinky (= 0.1.1) - jekyll-theme-hacker (= 0.1.1) - jekyll-theme-leap-day (= 0.1.1) - jekyll-theme-merlot (= 0.1.1) - jekyll-theme-midnight (= 0.1.1) - jekyll-theme-minimal (= 0.1.1) - jekyll-theme-modernist (= 0.1.1) - jekyll-theme-primer (= 0.5.3) - jekyll-theme-slate (= 0.1.1) - jekyll-theme-tactile (= 0.1.1) - jekyll-theme-time-machine (= 0.1.1) - jekyll-titles-from-headings (= 0.5.1) - jemoji (= 0.9.0) - kramdown (= 1.16.2) - liquid (= 4.0.0) - listen (= 3.1.5) - mercenary (~> 0.3) - minima (= 2.4.0) - nokogiri (>= 1.8.1, < 2.0) - rouge (= 2.2.1) - terminal-table (~> 1.4) - github-pages-health-check (1.4.0) - addressable (~> 2.3) - net-dns (~> 0.8) - octokit (~> 4.0) - public_suffix (~> 2.0) - typhoeus (~> 1.3) - html-pipeline (2.7.1) - activesupport (>= 2) - nokogiri (>= 1.4) http_parser.rb (0.6.0) i18n (0.9.5) concurrent-ruby (~> 1.0) @@ -98,120 +27,20 @@ GEM pathutil (~> 0.9) rouge (>= 1.7, < 4) safe_yaml (~> 1.0) - jekyll-avatar (0.5.0) - jekyll (~> 3.0) - jekyll-coffeescript (1.1.1) - coffee-script (~> 2.2) - coffee-script-source (~> 1.11.1) - jekyll-commonmark (1.2.0) - commonmarker (~> 0.14) - jekyll (>= 3.0, < 4.0) - jekyll-commonmark-ghpages (0.1.5) - commonmarker (~> 0.17.6) - jekyll-commonmark (~> 1) - rouge (~> 2) - jekyll-default-layout (0.1.4) - jekyll (~> 3.0) - jekyll-feed (0.9.3) - jekyll (~> 3.3) - jekyll-gist (1.5.0) - octokit (~> 4.2) - jekyll-github-metadata (2.9.4) - jekyll (~> 3.1) - octokit (~> 4.0, != 4.4.0) - jekyll-mentions (1.3.0) - activesupport (~> 4.0) - html-pipeline (~> 2.3) - jekyll (~> 3.0) - jekyll-optional-front-matter (0.3.0) - jekyll (~> 3.0) - jekyll-paginate (1.1.0) - jekyll-readme-index (0.2.0) - jekyll (~> 3.0) jekyll-redirect-from (0.13.0) jekyll (~> 3.3) - jekyll-relative-links (0.5.3) - jekyll (~> 3.3) - jekyll-remote-theme (0.2.3) - jekyll (~> 3.5) - rubyzip (>= 1.2.1, < 3.0) - typhoeus (>= 0.7, < 2.0) jekyll-sass-converter (1.5.2) sass (~> 3.4) - jekyll-seo-tag (2.4.0) - jekyll (~> 3.3) - jekyll-sitemap (1.2.0) - jekyll (~> 3.3) - jekyll-swiss (0.4.0) - jekyll-theme-architect (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-cayman (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-dinky (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-hacker (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-leap-day (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-merlot (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-midnight (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-minimal (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-modernist (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-primer (0.5.3) - jekyll (~> 3.5) - jekyll-github-metadata (~> 2.9) - jekyll-seo-tag (~> 2.0) - jekyll-theme-slate (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-tactile (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-theme-time-machine (0.1.1) - jekyll (~> 3.5) - jekyll-seo-tag (~> 2.0) - jekyll-titles-from-headings (0.5.1) - jekyll (~> 3.3) jekyll-watch (2.0.0) listen (~> 3.0) - jemoji (0.9.0) - activesupport (~> 4.0, >= 4.2.9) - gemoji (~> 3.0) - html-pipeline (~> 2.2) - jekyll (~> 3.0) kramdown (1.16.2) - libv8 (3.16.14.19) + libv8 (3.16.14.19-x86_64-linux) liquid (4.0.0) listen (3.1.5) rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) ruby_dep (~> 1.2) mercenary (0.3.6) - mini_portile2 (2.3.0) - minima (2.4.0) - jekyll (~> 3.5) - jekyll-feed (~> 0.9) - jekyll-seo-tag (~> 2.1) - minitest (5.11.3) - multipart-post (2.0.0) - net-dns (0.8.0) - nokogiri (1.8.2) - mini_portile2 (~> 2.3.0) - octokit (4.8.0) - sawyer (~> 0.8.0, >= 0.5.3) pathutil (0.16.1) forwardable-extended (~> 2.6) public_suffix (2.0.5) @@ -220,36 +49,23 @@ GEM ffi (>= 0.5.0, < 2) ref (2.0.0) rouge (2.2.1) - ruby-enum (0.7.2) - i18n ruby_dep (1.5.0) - rubyzip (1.2.1) safe_yaml (1.0.4) sass (3.5.6) sass-listen (~> 4.0.0) sass-listen (4.0.0) rb-fsevent (~> 0.9, >= 0.9.4) rb-inotify (~> 0.9, >= 0.9.7) - sawyer (0.8.1) - addressable (>= 2.3.5, < 2.6) - faraday (~> 0.8, < 1.0) - terminal-table (1.8.0) - unicode-display_width (~> 1.1, >= 1.1.1) therubyracer (0.12.3) libv8 (~> 3.16.14.15) ref - thread_safe (0.3.6) - typhoeus (1.3.0) - ethon (>= 0.9.0) - tzinfo (1.2.5) - thread_safe (~> 0.1) - unicode-display_width (1.3.0) PLATFORMS ruby DEPENDENCIES - github-pages (= 181) + jekyll (= 3.7.3) + jekyll-redirect-from (= 0.13.0) therubyracer BUNDLED WITH diff --git a/_config.yml b/_config.yml index 3c8a6ac4..2b4e126d 100644 --- a/_config.yml +++ b/_config.yml @@ -16,8 +16,10 @@ twitter_username: ApacheAccumulo exclude: [vendor] latest_minor_release: 1.9 latest_release: 1.9.1 +javadoc_version: 1.9.1 num_home_posts: 5 -javadoc_core: "https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.9.1"; +javadoc_base: "https://static.javadoc.io/org.apache.accumulo"; +docs_baseurl: "/docs/2.0" # Build settings markdown: kramdown @@ -66,10 +68,11 @@ defaults: title_prefix: "Accumulo Documentation - " version: "2.0" latest_release: "2.0.0" + javadoc_version: "1.9.1" docs_baseurl: "/docs/2.0" javadoc_base: "https://static.javadoc.io/org.apache.accumulo"; - javadoc_core: "https://static.javadoc.io/org.apache.accumulo/accumulo-core/1.9.1"; skiph1fortitle: "true" -whitelist: [jekyll-redirect-from] +#whitelist: [jekyll-redirect-from] +#plugins_dir: ./_plugins plugins: [jekyll-redirect-from] diff --git a/_devtools/cibuild b/_devtools/cibuild index be105d21..6d7f7491 100755 --- a/_devtools/cibuild +++ b/_devtools/cibuild @@ -1,5 +1,5 @@ #! /usr/bin/env bash set -e # halt script on error -bundle exec jekyll build --safe +bundle exec jekyll build diff --git a/_docs-2-0/administration/caching.md b/_docs-2-0/administration/caching.md index bdd591a0..c7b99a30 100644 --- a/_docs-2-0/administration/caching.md +++ b/_docs-2-0/administration/caching.md @@ -46,4 +46,4 @@ their defaults by setting the following properties: [table.cache.index.enable]: {{ page.docs_baseurl }}/administration/properties#table_cache_index_enable [tserver.cache.data.size]: {{ page.docs_baseurl }}/administration/properties#tserver_cache_data_size [tserver.cache.index.size]: {{ page.docs_baseurl }}/administration/properties#tserver_cache_data_size -[tableops]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/admin/TableOperations.html#setProperty(java.lang.String, java.lang.String, java.lang.String) +[tableops]: {% jurl org.apache.accumulo.core.client.admin.TableOperations#setProperty-java.lang.String-java.lang.String-java.lang.String- %} diff --git a/_docs-2-0/administration/multivolume.md b/_docs-2-0/administration/multivolume.md index d79d7357..604d2fe3 100644 --- a/_docs-2-0/administration/multivolume.md +++ b/_docs-2-0/administration/multivolume.md @@ -72,5 +72,5 @@ available in Hadoop 2.0, which allows DataNodes to respond to multiple NameNode servers, so you do not have to partition your DataNodes by NameNode. -[instance.volumes]: {{ page.docs_baseurl }}/administration/properties#instance_volumes -[instance.volumes.replacements]: {{ page.docs_baseurl }}/administration/properties#instance_volumes_replacements +[instance.volumes]: {% sprop instance.volumes %} +[instance.volumes.replacements]: {% sprop instance.volumes.replacements %} diff --git a/_docs-2-0/administration/ssl.md b/_docs-2-0/administration/ssl.md index b2a3e5df..c28e92e8 100644 --- a/_docs-2-0/administration/ssl.md +++ b/_docs-2-0/administration/ssl.md @@ -127,10 +127,10 @@ methods are equivalent whether the certificate is generate for an Accumulo serve [ssl.truststore.password]: {{ page.docs_baseurl }}/development/client-properties#ssl_truststore_password [ssl.keystore.path]: {{ page.docs_baseurl }}/development/client-properties#ssl_keystore_path [ssl.keystore.password]: {{ page.docs_baseurl }}/development/client-properties#ssl_keystore_password -[instance.secret]: {{ page.docs_baseurl }}/administration/properties#instance_secret -[rpc.javax.net.ssl.trustStore]: {{ page.docs_baseurl }}/administration/properties#rpc_javax_net_ssl_trustStore -[rpc.javax.net.ssl.trustStorePassword]: {{ page.docs_baseurl }}/administration/properties#rpc_javax_net_ssl_trustStorePassword -[instance.rpc.ssl.enabled]: {{ page.docs_baseurl }}/administration/properties#instance_rpc_ssl_enabled -[rpc.javax.net.ssl.keyStore]: {{ page.docs_baseurl }}/administration/properties#rpc_javax_net_ssl_keyStore -[rpc.javax.net.ssl.keyStorePassword]: {{ page.docs_baseurl }}/administration/properties#rpc_javax_net_ssl_keyStorePassword -[instance.rpc.ssl.clientAuth]: {{ page.docs_baseurl }}/administration/properties#instance_rpc_ssl_clientAuth +[instance.secret]: {% sprop instance.secret %} +[rpc.javax.net.ssl.trustStore]: {% sprop rpc.javax.net.ssl.trustStore %} +[rpc.javax.net.ssl.trustStorePassword]: {% sprop rpc.javax.net.ssl.trustStorePassword %} +[instance.rpc.ssl.enabled]: {% sprop instance.rpc.ssl.enabled %} +[rpc.javax.net.ssl.keyStore]: {% sprop rpc.javax.net.ssl.keyStore %} +[rpc.javax.net.ssl.keyStorePassword]: {% sprop rpc.javax.net.ssl.keyStorePassword %} +[instance.rpc.ssl.clientAuth]: {% sprop instance.rpc.ssl.clientAuth %} diff --git a/_docs-2-0/administration/tracing.md b/_docs-2-0/administration/tracing.md index 5d698d50..b49a9f84 100644 --- a/_docs-2-0/administration/tracing.md +++ b/_docs-2-0/administration/tracing.md @@ -343,12 +343,12 @@ Time Start Service@Location Name [config-mgmt]: {{ page.docs_baseurl }}/administration/configuration-management [Zipkin]: https://github.com/openzipkin/zipkin -[trace.user]: {{ page.docs_baseurl }}/administration/properties#trace_user -[trace.token.property.password]: {{ page.docs_baseurl }}/administration/properties#trace_token_property_password -[trace.port.client]: {{ page.docs_baseurl }}/administration/properties#trace_port_client -[trace.table]: {{ page.docs_baseurl }}/administration/properties#trace_table -[trace.zookeeper.path]: {{ page.docs_baseurl }}/administration/properties#trace_zookeeper_path -[trace.span.receivers]: {{ page.docs_baseurl }}/administration/properties#trace_span_receivers -[trace.span.receiver.*]: {{ page.docs_baseurl }}/administration/properties#trace_span_receiver_prefix +[trace.user]: {% sprop trace.user %} +[trace.token.property.password]: {% sprop trace.token.property.password %} +[trace.port.client]: {% sprop trace.port.client %} +[trace.table]: {% sprop trace.table %} +[trace.zookeeper.path]: {% sprop trace.zookeeper.path %} +[trace.span.receivers]: {% sprop trace.span.receivers %} +[trace.span.receiver.*]: {% sprop trace.span.receiver.prefix %} [zk-path-client]: {{ page.docs_baseurl }}/development/client-properties#trace_zookeeper_path [receivers-client]: {{ page.docs_baseurl }}/development/client-properties#trace_span_receivers diff --git a/_docs-2-0/development/development_tools.md b/_docs-2-0/development/development_tools.md index 6dc3548f..b677429f 100644 --- a/_docs-2-0/development/development_tools.md +++ b/_docs-2-0/development/development_tools.md @@ -154,7 +154,7 @@ there are still many limitations to the existing test harness. Some of them are: These are left as future improvements to the harness. -[Range]: {{ page.javadoc_core }}/org/apache/accumulo/core/data/Range.html -[IteratorTestCase]: {{ page.javadoc_base }}/accumulo-iterator-test-harness/{{ page.latest_release }}/org/apache/accumulo/iteratortest/testcases/IteratorTestCase.html -[BaseJUnit4IteratorTest]: {{ page.javadoc_base }}/accumulo-iterator-test-harness/{{ page.latest_release }}/org/apache/accumulo/iteratortest/junit4/BaseJUnit4IteratorTest.html -[MiniAccumuloCluster]: {{ page.javadoc_base }}/accumulo-minicluster/{{ page.latest_release }}/org/apache/accumulo/minicluster/MiniAccumuloCluster.html +[Range]: {% jurl org.apache.accumulo.core.data.Range %} +[IteratorTestCase]: {% jurl org.apache.accumulo.iteratortest.testcases.IteratorTestCase %} +[BaseJUnit4IteratorTest]: {% jurl org.apache.accumulo.iteratortest.junit4.BaseJUnit4IteratorTest %} +[MiniAccumuloCluster]: {% jurl org.apache.accumulo.minicluster.MiniAccumuloCluster %} diff --git a/_docs-2-0/development/high_speed_ingest.md b/_docs-2-0/development/high_speed_ingest.md index dccafc4a..9d07f63c 100644 --- a/_docs-2-0/development/high_speed_ingest.md +++ b/_docs-2-0/development/high_speed_ingest.md @@ -112,7 +112,7 @@ on how use to use MapReduce with Accumulo, see the [MapReduce documentation][map and the [MapReduce example code][mapred-code]. [bulk-example]: https://github.com/apache/accumulo-examples/blob/master/docs/bulkIngest.md -[AccumuloOutputFormat]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/mapred/AccumuloOutputFormat.html -[AccumuloFileOutputFormat]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/mapred/AccumuloFileOutputFormat.html +[AccumuloOutputFormat]: {% jurl org.apache.accumulo.core.client.mapred.AccumuloOutputFormat %} +[AccumuloFileOutputFormat]: {% jurl org.apache.accumulo.core.client.mapred.AccumuloFileOutputFormat %} [mapred-docs]: {{ page.docs_baseurl }}/development/mapreduce [mapred-code]: https://github.com/apache/accumulo-examples/blob/master/docs/mapred.md diff --git a/_docs-2-0/development/iterators.md b/_docs-2-0/development/iterators.md index cb4e37b3..8cbdb71a 100644 --- a/_docs-2-0/development/iterators.md +++ b/_docs-2-0/development/iterators.md @@ -414,13 +414,13 @@ to the missing values. The [Iterator test harness][iterator-test-harness] is generalized testing framework for Accumulo Iterators that can identify common pitfalls in user-created Iterators. -[SortedKeyValueIterator]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/SortedKeyValueIterator.html -[IteratorEnvironment]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/IteratorEnvironment.html -[Filter]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/Filter.html -[Combiner]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/Combiner.html -[Range]: {{ page.javadoc_core }}/org/apache/accumulo/core/data/Range.html +[SortedKeyValueIterator]: {% jurl org.apache.accumulo.core.iterators.SortedKeyValueIterator %} +[IteratorEnvironment]: {% jurl org.apache.accumulo.core.iterators.IteratorEnvironment %} +[Filter]: {% jurl org.apache.accumulo.core.iterators.Filter %} +[Combiner]: {% jurl org.apache.accumulo.core.iterators.Combiner %} +[Range]: {% jurl org.apache.accumulo.core.data.Range %} [iterator-test-harness]: {{ page.docs_baseurl }}/development/development_tools#iterator-test-harness -[BatchScanner]: {{ page.javadoc_core}}/org/apache/accumulo/core/client/BatchScanner.html -[Scanner]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/Scanner.html -[BatchWriter]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/BatchWriter.html -[WholeRowIterator]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/user/WholeRowIterator.html +[BatchScanner]: {% jurl org.apache.accumulo.core.client.BatchScanner %} +[Scanner]: {% jurl org.apache.accumulo.core.client.Scanner %} +[BatchWriter]: {% jurl org.apache.accumulo.core.client.BatchWriter %} +[WholeRowIterator]: {% jurl org.apache.accumulo.core.iterators.user.WholeRowIterator %} diff --git a/_docs-2-0/development/mapreduce.md b/_docs-2-0/development/mapreduce.md index ee372fb2..a72b1c5c 100644 --- a/_docs-2-0/development/mapreduce.md +++ b/_docs-2-0/development/mapreduce.md @@ -170,6 +170,6 @@ AccumuloOutputFormat.setMaxMutationBufferSize(job, 50000000); // bytes The [MapReduce example][mapred-example] contains a complete example of using MapReduce with Accumulo. [mapred-example]: https://github.com/apache/accumulo-examples/blob/master/docs/mapred.md -[AccumuloInputFormat]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/mapred/AccumuloInputFormat.html -[AccumuloMultiTableInputFormat]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/mapred/AccumuloMultiTableInputFormat.html -[AccumuloOutputFormat]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/mapred/AccumuloOutputFormat.html +[AccumuloInputFormat]: {% jurl org.apache.accumulo.core.client.mapred.AccumuloInputFormat %} +[AccumuloMultiTableInputFormat]: {% jurl org.apache.accumulo.core.client.mapred.AccumuloMultiTableInputFormat %} +[AccumuloOutputFormat]: {% jurl org.apache.accumulo.core.client.mapred.AccumuloOutputFormat %} diff --git a/_docs-2-0/development/proxy.md b/_docs-2-0/development/proxy.md index 5c87fbf6..1aa700bc 100644 --- a/_docs-2-0/development/proxy.md +++ b/_docs-2-0/development/proxy.md @@ -374,5 +374,5 @@ if __name__ == "__main__": main() ``` -[Connector]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/Connector.html +[Connector]: {% jurl org.apache.accumulo.core.client.Connector %} [tutorial]: https://thrift.apache.org/tutorial/ diff --git a/_docs-2-0/development/sampling.md b/_docs-2-0/development/sampling.md index b1c54ef8..cde4642c 100644 --- a/_docs-2-0/development/sampling.md +++ b/_docs-2-0/development/sampling.md @@ -71,12 +71,12 @@ sample data. To use this feature, look at the javadoc of the `setSampler(...)` method of [AccumuloFileOutputFormat]. [example]: https://github.com/apache/accumulo-examples/blob/master/docs/sample.md -[Sampler]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/sample/Sampler.html -[sample-package]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/sample/package-summary.html -[skv-iterator]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/SortedKeyValueIterator.html -[clone-sampling]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/IteratorEnvironment.html#cloneWithSamplingEnabled() -[AccumuloInputFormat]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/mapred/AccumuloInputFormat.html -[AccumuloFileOutputFormat]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/mapred/AccumuloFileOutputFormat.html -[SampleNotPresentException]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/SampleNotPresentException.html -[BatchScanner]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/BatchScanner.html -[Scanner]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/Scanner.html +[Sampler]: {% jurl org.apache.accumulo.core.client.sample.Sampler %} +[sample-package]: {% jurl org.apache.accumulo.core.client.sample %} +[skv-iterator]: {% jurl org.apache.accumulo.core.iterators.SortedKeyValueIterator %} +[clone-sampling]: {% jurl org.apache.accumulo.core.iterators.IteratorEnvironment#cloneWithSamplingEnabled-- %} +[AccumuloInputFormat]: {% jurl org.apache.accumulo.core.client.mapred.AccumuloInputFormat %} +[AccumuloFileOutputFormat]: {% jurl org.apache.accumulo.core.client.mapred.AccumuloFileOutputFormat %} +[SampleNotPresentException]: {% jurl org.apache.accumulo.core.client.SampleNotPresentException %} +[BatchScanner]: {% jurl org.apache.accumulo.core.client.BatchScanner %} +[Scanner]: {% jurl org.apache.accumulo.core.client.Scanner %} diff --git a/_docs-2-0/development/security.md b/_docs-2-0/development/security.md index cc42537e..cd94c3b3 100644 --- a/_docs-2-0/development/security.md +++ b/_docs-2-0/development/security.md @@ -171,14 +171,14 @@ Authorizations mechanism. Typically, the query services layer sits between Accumulo and user workstations. [shell]: {{ page.docs_baseurl }}/getting-started/shell -[Key]: {{ page.javadoc_core }}/org/apache/accumulo/core/data/Key.html -[Value]: {{ page.javadoc_core }}/org/apache/accumulo/core/data/Value.html -[Mutation]: {{ page.javadoc_core }}/org/apache/accumulo/core/data/Mutation.html -[ColumnVisibility]: {{ page.javadoc_core }}/org/apache/accumulo/core/security/ColumnVisibility.html -[Scanner]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/Scanner.html -[BatchScanner]: {{ page.javadoc_core}}/org/apache/accumulo/core/client/BatchScanner.html -[Authorizations]: {{ page.javadoc_core}}/org/apache/accumulo/core/security/Authorizations.html -[SecurityOperations]: {{ page.javadoc_core}}/org/apache/accumulo/core/client/admin/SecurityOperations.html -[Instance]: {{ page.javadoc_core}}/org/apache/accumulo/core/client/Instance.html -[AuthenticationToken]: {{ page.javadoc_core}}/org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html -[PasswordToken]: {{ page.javadoc_core}}/org/apache/accumulo/core/client/security/tokens/PasswordToken.html +[Key]: {% jurl org.apache.accumulo.core.data.Key %} +[Value]: {% jurl org.apache.accumulo.core.data.Value %} +[Mutation]: {% jurl org.apache.accumulo.core.data.Mutation %} +[ColumnVisibility]: {% jurl org.apache.accumulo.core.security.ColumnVisibility %} +[Scanner]: {% jurl org.apache.accumulo.core.client.Scanner %} +[BatchScanner]: {% jurl org.apache.accumulo.core.client.BatchScanner %} +[Authorizations]: {% jurl org.apache.accumulo.core.security.Authorizations %} +[SecurityOperations]: {% jurl org.apache.accumulo.core.client.admin.SecurityOperations %} +[Instance]: {% jurl org.apache.accumulo.core.client.Instance %} +[AuthenticationToken]: {% jurl org.apache.accumulo.core.client.security.tokens.AuthenticationToken %} +[PasswordToken]: {% jurl org.apache.accumulo.core.client.security.tokens.PasswordToken %} diff --git a/_docs-2-0/development/summaries.md b/_docs-2-0/development/summaries.md index 33cd9ebd..4629c1ac 100644 --- a/_docs-2-0/development/summaries.md +++ b/_docs-2-0/development/summaries.md @@ -48,12 +48,12 @@ information. The following tablet server and table properties configure summarization. -* [tserver.cache.summary.size]({{page.docs_baseurl}}/administration/properties#tserver_cache_summary_size) -* [tserver.summary.partition.threads]({{page.docs_baseurl}}/administration/properties#tserver_summary_partition_threads) -* [tserver.summary.remote.threads]({{page.docs_baseurl}}/administration/properties#tserver_summary_remote_threads) -* [tserver.summary.retrieval.threads]({{page.docs_baseurl}}/administration/properties#tserver_summary_retreival_threads) -* [table.summarizer.*]({{page.docs_baseurl}}/administration/properties#table_summarizer_prefix) -* [table.file.summary.maxSize]({{page.docs_baseurl}}/administration/properties#table_file_summary_maxSize) +* [tserver.cache.summary.size]({% sprop tserver.cache.summary.size %}) +* [tserver.summary.partition.threads]({% sprop tserver.summary.partition.threads %}) +* [tserver.summary.remote.threads]({% sprop tserver.summary.remote.threads %}) +* [tserver.summary.retrieval.threads]({% sprop tserver.summary.retreival.threads %}) +* [table.summarizer.*]({% sprop table.summarizer.prefix %}) +* [table.file.summary.maxSize]({% sprop table.file.summary.maxSize %}) ## Permissions diff --git a/_docs-2-0/getting-started/clients.md b/_docs-2-0/getting-started/clients.md index 277324db..bcbbba91 100644 --- a/_docs-2-0/getting-started/clients.md +++ b/_docs-2-0/getting-started/clients.md @@ -344,29 +344,29 @@ This page covers Accumulo client basics. Below are links to additional document * [Proxy] - Documentation for interacting with Accumulo using non-Java languages through a proxy server * [MapReduce] - Documentation for reading and writing to Accumulo using MapReduce. -[Connector]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/Connector.html -[client-props]: {{ page.docs_baseurl }}/development/client-properties -[auth.type]: {{ page.docs_baseurl }}/development/client-properties#auth_type -[auth.principal]: {{ page.docs_baseurl }}/development/client-properties#auth_principal -[auth.token]: {{ page.docs_baseurl }}/development/client-properties#auth_token -[instance.name]: {{ page.docs_baseurl }}/development/client-properties#instance_name -[instance.zookeepers]: {{ page.docs_baseurl }}/development/client-properties#instance_zookeepers -[batch.writer.durability]: {{ page.docs_baseurl }}/development/client-properties#batch_writer_durability -[PasswordToken]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/security/tokens/PasswordToken.html -[AuthenticationToken]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/security/tokens/AuthenticationToken.html -[CredentialProviderToken]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/security/tokens/CredentialProviderToken.html -[KerberosToken]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/security/tokens/KerberosToken.html -[Mutation]: {{ page.javadoc_core }}/org/apache/accumulo/core/data/Mutation.html -[BatchWriter]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/BatchWriter.html -[ConditionalWriter]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/ConditionalWriter.html -[Scanner]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/Scanner.html -[IsolatedScanner]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/IsolatedScanner.html -[BatchScanner]: {{ page.javadoc_core}}/org/apache/accumulo/core/client/BatchScanner.html -[Range]: {{ page.javadoc_core }}/org/apache/accumulo/core/data/Range.html -[WholeRowIterator]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/user/WholeRowIterator.html -[Iterators]: {{ page.docs_baseurl }}/development/iterators -[Proxy]: {{ page.docs_baseurl }}/development/proxy -[MapReduce]: {{ page.docs_baseurl }}/development/mapreduce +[Connector]: {% jurl org.apache.accumulo.core.client.Connector %} +[client-props]: {% doc development/client-properties %} +[auth.type]: {% cprop auth.type %} +[auth.principal]: {% cprop auth.principal %} +[auth.token]: {% cprop auth.token %} +[instance.name]: {% cprop instance.name %} +[instance.zookeepers]: {% cprop instance.zookeepers %} +[batch.writer.durability]: {% cprop batch.writer.durability %} +[PasswordToken]: {% jurl org.apache.accumulo.core.client.security.tokens.PasswordToken %} +[AuthenticationToken]: {% jurl org.apache.accumulo.core.client.security.tokens.AuthenticationToken %} +[CredentialProviderToken]: {% jurl org.apache.accumulo.core.client.security.tokens.CredentialProviderToken %} +[KerberosToken]: {% jurl org.apache.accumulo.core.client.security.tokens.KerberosToken %} +[Mutation]: {% jurl org.apache.accumulo.core.data.Mutation %} +[BatchWriter]: {% jurl org.apache.accumulo.core.client.BatchWriter %} +[ConditionalWriter]: {% jurl org.apache.accumulo.core.client.ConditionalWriter %} +[Scanner]: {% jurl org.apache.accumulo.core.client.Scanner %} +[IsolatedScanner]: {% jurl org.apache.accumulo.core.client.IsolatedScanner %} +[BatchScanner]: {% jurl org.apache.accumulo.core.client.BatchScanner %} +[Range]: {% jurl org.apache.accumulo.core.data.Range %} +[WholeRowIterator]: {% jurl org.apache.accumulo.core.iterators.user.WholeRowIterator %} +[Iterators]: {% doc development/iterators %} +[Proxy]: {% doc development/proxy %} +[MapReduce]: {% doc development/mapreduce %} [mapred-example]: https://github.com/apache/accumulo-examples/blob/master/docs/mapred.md [batch]: https://github.com/apache/accumulo-examples/blob/master/docs/batch.md [reservations]: https://github.com/apache/accumulo-examples/blob/master/docs/reservations.md diff --git a/_docs-2-0/getting-started/table_configuration.md b/_docs-2-0/getting-started/table_configuration.md index 488a58ec..b59b2cef 100644 --- a/_docs-2-0/getting-started/table_configuration.md +++ b/_docs-2-0/getting-started/table_configuration.md @@ -706,17 +706,17 @@ preserved. ``` [bloom-filter-example]: https://github.com/apache/accumulo-examples/blob/master/docs/bloom.md -[constraint]: {{ page.javadoc_core }}/org/apache/accumulo/core/constraints/Constraint.html +[constraint]: {% jurl org.apache.accumulo.core.constraints.Constraint %} [constraints-example]: https://github.com/apache/accumulo-examples/blob/master/docs/contraints.md -[iterators-user]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/user/package-summary.html -[option-describer]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/OptionDescriber.html -[combiner]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/Combiner.html +[iterators-user]: {% jurl org.apache.accumulo.core.iterators.user %} +[option-describer]: {% jurl org.apache.accumulo.core.iterators.OptionDescriber %} +[combiner]: {% jurl org.apache.accumulo.core.iterators.Combiner %} [combiner-example]: https://github.com/apache/accumulo-examples/blob/master/docs/combiner.md -[filter]: {{ page.javadoc_core }}/org/apache/accumulo/core/iterators/Filter.html +[filter]: {% jurl org.apache.accumulo.core.iterators.Filter %} [table.majc.compaction.strategy]: {{ page.docs_baseurl}}/administration/properties#table_majc_compaction_strategy [config-properties]: {{ page.docs_baseurl}}/administration/properties -[Scanner]: {{ page.javadoc_core }}/org/apache/accumulo/core/client/Scanner.html -[BatchScanner]: {{ page.javadoc_core}}/org/apache/accumulo/core/client/BatchScanner.html +[Scanner]: {% jurl org.apache.accumulo.core.client.Scanner %} +[BatchScanner]: {% jurl org.apache.accumulo.core.client.BatchScanner %} [Caching]: {{ page.docs_baseurl }}/administration/caching [table.compaction.major.ratio]: {{ page.docs_baseurl}}/administration/properties#table_compaction_major_ratio [tserver.compaction.major.concurrent.max]: {{ page.docs_baseurl}}/administration/properties#tserver_compaction_major_concurrent_max diff --git a/_plugins/links.rb b/_plugins/links.rb new file mode 100755 index 00000000..1d622c6a --- /dev/null +++ b/_plugins/links.rb @@ -0,0 +1,145 @@ + +def convert_package(package) + retval = '' + vals = package.split('.') + vals.each_with_index do |value, index| + retval << value + if index != vals.size - 1 + if value =~ /^[a-z]/ + retval << '/' + else + retval << '.' + end + end + end + return retval +end + +def render_link(context, text, short, url_only) + clz = text.strip + base = context.registers[:site].config['javadoc_base'] + v = context.environments.first["page"]["javadoc_version"] + if v.nil? + v = context.registers[:site].config['javadoc_version'] + end + clz_slash = convert_package(clz) + clz_name = clz.split('.').last + + jmodule = 'unknown' + if clz.start_with?('org.apache.accumulo.core') + jmodule = 'accumulo-core' + elsif clz.start_with?('org.apache.accumulo.iteratortest') + jmodule = 'accumulo-iterator-test-harness' + elsif clz.start_with?('org.apache.accumulo.minicluster') + jmodule = 'accumulo-minicluster' + else + raise "Unknown package prefix for #{clz}" + end + + if clz_slash.include? "#" + clz_only = convert_package(clz.split('#').first) + method = clz.split('#').last + url = "#{base}/#{jmodule}/#{v}/#{clz_only}.html##{method}" + elsif clz_name =~ /^[a-z]/ + url = "#{base}/#{jmodule}/#{v}/#{clz_slash}/package-summary.html" + else + url = "#{base}/#{jmodule}/#{v}/#{clz_slash}.html" + end + if url_only + return url + end + if short + link_text = clz.split('.').last + else + link_text = clz + end + r = "[#{link_text}](#{url})" + return r +end + +class JavadocFullTag < Liquid::Tag + def initialize(tag_name, text, tokens) + super + @text = text + end + + def render(context) + return render_link(context, @text, false, false) + end +end + +class JavadocClassTag < Liquid::Tag + def initialize(tag_name, text, tokens) + super + @text = text + end + + def render(context) + return render_link(context, @text, true, false) + end +end + +class JavadocUrlTag < Liquid::Tag + def initialize(tag_name, text, tokens) + super + @text = text + end + + def render(context) + return render_link(context, @text, false, true) + end +end + +class ServerPropertyTag < Liquid::Tag + def initialize(tag_name, text, tokens) + super + @text = text + end + + def render(context) + base = context.environments.first["page"]["docs_baseurl"] + if base.nil? + base = context.registers[:site].config['docs_baseurl'] + end + prop = @text.gsub('.', '_') + return "#{base}/administration/properties##{prop}" + end +end + +class ClientPropertyTag < Liquid::Tag + def initialize(tag_name, text, tokens) + super + @text = text + end + + def render(context) + base = context.environments.first["page"]["docs_baseurl"] + if base.nil? + base = context.registers[:site].config['docs_baseurl'] + end + prop = @text.gsub('.', '_') + return "#{base}/development/client-properties##{prop}" + end +end + +class DocTag < Liquid::Tag + def initialize(tag_name, text, tokens) + super + @text = text + end + + def render(context) + base = context.environments.first["page"]["docs_baseurl"] + if base.nil? + base = context.registers[:site].config['docs_baseurl'] + end + return "#{base}/#{@text}" + end +end + +Liquid::Template.register_tag('jfull', JavadocFullTag) +Liquid::Template.register_tag('jclass', JavadocClassTag) +Liquid::Template.register_tag('jurl', JavadocUrlTag) +Liquid::Template.register_tag('sprop', ServerPropertyTag) +Liquid::Template.register_tag('cprop', ClientPropertyTag) +Liquid::Template.register_tag('doc', DocTag) diff --git a/tour/authorizations.md b/tour/authorizations.md index 4403e340..4c18c8f1 100644 --- a/tour/authorizations.md +++ b/tour/authorizations.md @@ -46,6 +46,6 @@ Key : id0001 hero:name [secretId] 1511900180231 false Value : Bruce Wayn Key : id0002 hero:name [secretId] 1511900180231 false Value : Dick Grayson ``` -[Authorizations]: {{ site.javadoc_core }}/org/apache/accumulo/core/security/Authorizations.html -[ColumnVisibility]: {{ site.javadoc_core }}/org/apache/accumulo/core/security/ColumnVisibility.html -[Mutation]: {{ site.javadoc_core }}/org/apache/accumulo/core/data/Mutation.html +[Authorizations]: {% jurl org.apache.accumulo.core.security.Authorizations %} +[ColumnVisibility]: {% jurl org.apache.accumulo.core.security.ColumnVisibility %} +[Mutation]: {% jurl org.apache.accumulo.core.data.Mutation %} diff --git a/tour/basic-read-write.md b/tour/basic-read-write.md index 028bbf0c..b6446f41 100644 --- a/tour/basic-read-write.md +++ b/tour/basic-read-write.md @@ -54,5 +54,5 @@ to read it. More to come later in the [Authorizations][auths] lesson! [dmodel]: /tour/data-model [auths]: /tour/authorizations -[Key]: {{ site.javadoc_core }}/org/apache/accumulo/core/data/Key.html -[Scanner]: {{ site.javadoc_core }}/org/apache/accumulo/core/client/Scanner.html +[Key]: {% jurl org.apache.accumulo.core.data.Key %} +[Scanner]: {% jurl org.apache.accumulo.core.client.Scanner %} diff --git a/tour/batch-scanner.md b/tour/batch-scanner.md index a388ce68..80c0d113 100644 --- a/tour/batch-scanner.md +++ b/tour/batch-scanner.md @@ -36,6 +36,6 @@ and `yearsOfService` qualifier. 4. Finally, use the BatchScanner to calculate the average years of service of 2000 villians. -[BatchScanner]: {{ site.javadoc_core }}/org/apache/accumulo/core/client/BatchScanner.html -[createBatchScanner]: {{ site.javadoc_core }}/org/apache/accumulo/core/client/Connector.html#createBatchScanner(java.lang.String,%20org.apache.accumulo.core.security.Authorizations,%20int) -[fetchColumn]: {{ site.javadoc_core }}/org/apache/accumulo/core/client/ScannerBase.html#fetchColumn(org.apache.hadoop.io.Text,%20org.apache.hadoop.io.Text) +[BatchScanner]: {% jurl org.apache.accumulo.core.client.BatchScanner %} +[createBatchScanner]: {% jurl org.apache.accumulo.core.client.Connector#createBatchScanner-java.lang.String-org.apache.accumulo.core.security.Authorizations-int- %} +[fetchColumn]: {% jurl org.apache.accumulo.core.client.ScannerBase#fetchColumn-org.apache.hadoop.io.Text-org.apache.hadoop.io.Text- %} diff --git a/tour/conditional-writer.md b/tour/conditional-writer.md index dc98d8a4..618caf03 100644 --- a/tour/conditional-writer.md +++ b/tour/conditional-writer.md @@ -119,12 +119,12 @@ ConditionalWriter. * Call [write] passing it the conditional mutation. * Return `true` if [getStatus] from the [Result] returned by [write] is [ACCEPTED]. -[ConditionalWriter]: {{ site.javadoc_core }}/org/apache/accumulo/core/client/ConditionalWriter.html -[Result]: {{ site.javadoc_core }}/org/apache/accumulo/core/client/ConditionalWriter.Result.html -[createConditionalWriter]: {{ site.javadoc_core }}/org/apache/accumulo/core/client/Connector.html#createConditionalWriter(java.lang.String,%20org.apache.accumulo.core.client.ConditionalWriterConfig) -[Condition]: {{ site.javadoc_core }}/org/apache/accumulo/core/data/Condition.html -[ConditionalMutation]: {{ site.javadoc_core }}/org/apache/accumulo/core/data/ConditionalMutation.html -[getStatus]: {{ site.javadoc_core }}/org/apache/accumulo/core/client/ConditionalWriter.Result.html#getStatus() -[write]: {{ site.javadoc_core }}/org/apache/accumulo/core/client/ConditionalWriter.html#write(org.apache.accumulo.core.data.ConditionalMutation) -[setValue]: {{ site.javadoc_core }}/org/apache/accumulo/core/data/Condition.html#setValue(java.lang.CharSequence) -[ACCEPTED]: {{ site.javadoc_core }}/org/apache/accumulo/core/client/ConditionalWriter.Status.html#ACCEPTED +[ConditionalWriter]: {% jurl org.apache.accumulo.core.client.ConditionalWriter %} +[Result]: {% jurl org.apache.accumulo.core.client.ConditionalWriter.Result %} +[createConditionalWriter]: {% jurl org.apache.accumulo.core.client.Connector#createConditionalWriter-java.lang.String-org.apache.accumulo.core.client.ConditionalWriterConfig- %} +[Condition]: {% jurl org.apache.accumulo.core.data.Condition %} +[ConditionalMutation]: {% jurl org.apache.accumulo.core.data.ConditionalMutation %} +[getStatus]: {% jurl org.apache.accumulo.core.client.ConditionalWriter.Result#getStatus-- %} +[write]: {% jurl org.apache.accumulo.core.client.ConditionalWriter#write-org.apache.accumulo.core.data.ConditionalMutation- %} +[setValue]: {% jurl org.apache.accumulo.core.data.Condition#setValue-java.lang.CharSequence- %} +[ACCEPTED]: {% jurl org.apache.accumulo.core.client.ConditionalWriter.Status#ACCEPTED %} diff --git a/tour/ranges-splits.md b/tour/ranges-splits.md index 07386d49..03db08fc 100644 --- a/tour/ranges-splits.md +++ b/tour/ranges-splits.md @@ -35,5 +35,5 @@ Knowing these terms are critical when working closely with Accumulo. Iterators When working with large amounts of data across many Tablet Servers, a simple Scanner might not do the trick. Next lesson we learn about the power of the multi-threaded BatchScanner! -[Range]: {{ site.javadoc_core }}/org/apache/accumulo/core/data/Range.html -[TableOperations]: {{ site.javadoc_core }}/org/apache/accumulo/core/client/admin/TableOperations.html +[Range]: {% jurl org.apache.accumulo.core.data.Range %} +[TableOperations]: {% jurl org.apache.accumulo.core.client.admin.TableOperations %} ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] With regards, Apache Git Services
