From a52e8b8f3ca03a500edda48db945a5177a86a178 Mon Sep 17 00:00:00 2001 From: Vince Polsinelli Date: Thu, 19 Apr 2018 14:12:27 -0400 Subject: [PATCH] Fixed broken links to documentation --- bindings/go/README.md | 4 ++-- bindings/go/src/fdb/directory/directory.go | 2 +- bindings/go/src/fdb/errors.go | 2 +- bindings/go/src/fdb/keyselector.go | 2 +- bindings/go/src/fdb/subspace/subspace.go | 2 +- bindings/go/src/fdb/transaction.go | 12 ++++++------ bindings/go/src/fdb/tuple/tuple.go | 2 +- bindings/python/README.rst | 2 +- bindings/python/fdb/__init__.py | 2 +- bindings/python/fdb/locality.py | 2 +- bindings/ruby/fdb.gemspec.in | 2 +- bindings/ruby/lib/fdb.rb | 2 +- bindings/ruby/lib/fdbdirectory.rb | 2 +- bindings/ruby/lib/fdbimpl.rb | 2 +- bindings/ruby/lib/fdblocality.rb | 2 +- bindings/ruby/lib/fdbsubspace.rb | 2 +- bindings/ruby/lib/fdbtuple.rb | 2 +- fdbclient/vexillographer/ruby.cs | 2 +- packaging/foundationdb.conf | 2 +- packaging/msi/FDBInstaller.wxs | 2 +- packaging/msi/skeleton.conf | 2 +- packaging/osx/foundationdb.conf.new | 2 +- 22 files changed, 28 insertions(+), 28 deletions(-) diff --git a/bindings/go/README.md b/bindings/go/README.md index 15beef47ed..d2ae6947bb 100644 --- a/bindings/go/README.md +++ b/bindings/go/README.md @@ -1,7 +1,7 @@ fdb-go ====== -[Go language](http://golang.org) bindings for [FoundationDB](https://www.foundationdb.org/documentation/), a distributed key-value store with ACID transactions. +[Go language](http://golang.org) bindings for [FoundationDB](https://apple.github.io/foundationdb/index.html#documentation), a distributed key-value store with ACID transactions. This package requires: @@ -28,4 +28,4 @@ Documentation ------------- * [API documentation](https://godoc.org/github.com/apple/foundationdb/bindings/go/src/fdb) -* [Tutorial](https://www.foundationdb.org/documentation/class-scheduling-go.html) +* [Tutorial](https://apple.github.io/foundationdb/class-scheduling.html) diff --git a/bindings/go/src/fdb/directory/directory.go b/bindings/go/src/fdb/directory/directory.go index 21f576d1fd..792621b386 100644 --- a/bindings/go/src/fdb/directory/directory.go +++ b/bindings/go/src/fdb/directory/directory.go @@ -26,7 +26,7 @@ // // For general guidance on directory usage, see the Directories section of the // Developer Guide -// (https://www.foundationdb.org/documentation/developer-guide.html#developer-guide-directories). +// (https://apple.github.io/foundationdb/developer-guide.html#directories). // // Directories are identified by hierarchical paths analogous to the paths in a // Unix-like file system. A path is represented as a slice of strings. Each diff --git a/bindings/go/src/fdb/errors.go b/bindings/go/src/fdb/errors.go index 7317799fae..cd551c39fe 100644 --- a/bindings/go/src/fdb/errors.go +++ b/bindings/go/src/fdb/errors.go @@ -37,7 +37,7 @@ import ( // as a panic from any FoundationDB API function whose name ends with OrPanic. // // You may compare the Code field of an Error against the list of FoundationDB -// error codes at https://www.foundationdb.org/documentation/api-error-codes.html, +// error codes at https://apple.github.io/foundationdb/api-error-codes.html, // but generally an Error should be passed to (Transaction).OnError. When using // (Database).Transact, non-fatal errors will be retried automatically. type Error struct { diff --git a/bindings/go/src/fdb/keyselector.go b/bindings/go/src/fdb/keyselector.go index 538a626a1c..7d4f45ffe5 100644 --- a/bindings/go/src/fdb/keyselector.go +++ b/bindings/go/src/fdb/keyselector.go @@ -34,7 +34,7 @@ type Selectable interface { // // The most common key selectors are constructed with the functions documented // below. For details of how KeySelectors are specified and resolved, see -// https://www.foundationdb.org/documentation/developer-guide.html#key-selectors. +// https://apple.github.io/foundationdb/developer-guide.html#key-selectors. type KeySelector struct { Key KeyConvertible OrEqual bool diff --git a/bindings/go/src/fdb/subspace/subspace.go b/bindings/go/src/fdb/subspace/subspace.go index f2523a81ef..b779d5a9f7 100644 --- a/bindings/go/src/fdb/subspace/subspace.go +++ b/bindings/go/src/fdb/subspace/subspace.go @@ -29,7 +29,7 @@ // As a best practice, API clients should use at least one subspace for // application data. For general guidance on subspace usage, see the Subspaces // section of the Developer Guide -// (https://www.foundationdb.org/documentation/developer-guide.html#developer-guide-sub-keyspaces). +// (https://apple.github.io/foundationdb/developer-guide.html#subspaces). package subspace import ( diff --git a/bindings/go/src/fdb/transaction.go b/bindings/go/src/fdb/transaction.go index 87ff29ae8b..4ba435ce30 100644 --- a/bindings/go/src/fdb/transaction.go +++ b/bindings/go/src/fdb/transaction.go @@ -171,7 +171,7 @@ func (t Transaction) SetReadVersion(version int64) { // but making it harder to reason about concurrency. // // For more information on snapshot reads, see -// https://www.foundationdb.org/documentation/developer-guide.html#using-snapshot-reads. +// https://apple.github.io/foundationdb/developer-guide.html#snapshot-reads. func (t Transaction) Snapshot() Snapshot { return Snapshot{t.transaction} } @@ -196,7 +196,7 @@ func (t Transaction) OnError(e Error) FutureNil { // As with other client/server databases, in some failure scenarios a client may // be unable to determine whether a transaction succeeded. For more information, // see -// https://www.foundationdb.org/documentation/developer-guide.html#developer-guide-unknown-results. +// https://apple.github.io/foundationdb/developer-guide.html#transactions-with-unknown-results. func (t Transaction) Commit() FutureNil { return &futureNil{newFuture(C.fdb_transaction_commit(t.ptr))} } @@ -396,7 +396,7 @@ func addConflictRange(t *transaction, er ExactRange, crtype conflictRangeType) e // conflict. // // For more information on conflict ranges, see -// https://www.foundationdb.org/documentation/developer-guide.html#conflict-ranges. +// https://apple.github.io/foundationdb/developer-guide.html#conflict-ranges. func (t Transaction) AddReadConflictRange(er ExactRange) error { return addConflictRange(t.transaction, er, conflictRangeTypeRead) } @@ -413,7 +413,7 @@ func copyAndAppend(orig []byte, b byte) []byte { // this key could cause the transaction to fail with a conflict. // // For more information on conflict ranges, see -// https://www.foundationdb.org/documentation/developer-guide.html#conflict-ranges. +// https://apple.github.io/foundationdb/developer-guide.html#conflict-ranges. func (t Transaction) AddReadConflictKey(key KeyConvertible) error { return addConflictRange(t.transaction, KeyRange{key, Key(copyAndAppend(key.FDBKey(), 0x00))}, conflictRangeTypeRead) } @@ -424,7 +424,7 @@ func (t Transaction) AddReadConflictKey(key KeyConvertible) error { // conflict. // // For more information on conflict ranges, see -// https://www.foundationdb.org/documentation/developer-guide.html#conflict-ranges. +// https://apple.github.io/foundationdb/developer-guide.html#conflict-ranges. func (t Transaction) AddWriteConflictRange(er ExactRange) error { return addConflictRange(t.transaction, er, conflictRangeTypeWrite) } @@ -434,7 +434,7 @@ func (t Transaction) AddWriteConflictRange(er ExactRange) error { // read this key could fail with a conflict. // // For more information on conflict ranges, see -// https://www.foundationdb.org/documentation/developer-guide.html#conflict-ranges. +// https://apple.github.io/foundationdb/developer-guide.html#conflict-ranges. func (t Transaction) AddWriteConflictKey(key KeyConvertible) error { return addConflictRange(t.transaction, KeyRange{key, Key(copyAndAppend(key.FDBKey(), 0x00))}, conflictRangeTypeWrite) } diff --git a/bindings/go/src/fdb/tuple/tuple.go b/bindings/go/src/fdb/tuple/tuple.go index d00a594abf..bf9365b711 100644 --- a/bindings/go/src/fdb/tuple/tuple.go +++ b/bindings/go/src/fdb/tuple/tuple.go @@ -27,7 +27,7 @@ // of higher-level data models. // // For general guidance on tuple usage, see the Tuple section of Data Modeling -// (https://www.foundationdb.org/documentation/data-modeling.html#data-modeling-tuples). +// (https://apple.github.io/foundationdb/data-modeling.html#tuples). // // FoundationDB tuples can currently encode byte and unicode strings, integers // and NULL values. In Go these are represented as []byte, string, int64 and diff --git a/bindings/python/README.rst b/bindings/python/README.rst index 168b522f08..2cd7d6f75c 100644 --- a/bindings/python/README.rst +++ b/bindings/python/README.rst @@ -1,3 +1,3 @@ -Complete documentation of the FoundationDB Python API can be found at https://www.foundationdb.org/documentation/api-python.html. +Complete documentation of the FoundationDB Python API can be found at https://apple.github.io/foundationdb/api-python.html. These bindings require the FoundationDB client. The client can be obtained from https://www.foundationdb.org/downloads/fdb-c/. diff --git a/bindings/python/fdb/__init__.py b/bindings/python/fdb/__init__.py index 34f2419f8e..2bf616202e 100644 --- a/bindings/python/fdb/__init__.py +++ b/bindings/python/fdb/__init__.py @@ -21,7 +21,7 @@ # FoundationDB Python API """Documentation for this API can be found at -https://www.foundationdb.org/documentation/api-python.html""" +https://apple.github.io/foundationdb/api-python.html""" def open(*args, **kwargs): diff --git a/bindings/python/fdb/locality.py b/bindings/python/fdb/locality.py index cc298c00c8..d6f6e15201 100644 --- a/bindings/python/fdb/locality.py +++ b/bindings/python/fdb/locality.py @@ -21,7 +21,7 @@ # FoundationDB Python API """Documentation for this API can be found at -https://www.foundationdb.org/documentation/api-python.html""" +https://apple.github.io/foundationdb/api-python.html""" from fdb import impl as _impl diff --git a/bindings/ruby/fdb.gemspec.in b/bindings/ruby/fdb.gemspec.in index ad3cfbbeab..21c216240d 100644 --- a/bindings/ruby/fdb.gemspec.in +++ b/bindings/ruby/fdb.gemspec.in @@ -9,7 +9,7 @@ Gem::Specification.new do |s| Ruby bindings for the FoundationDB database. Complete documentation of the FoundationDB Ruby API can be found at: -https://www.foundationdb.org/documentation/api-ruby.html. +https://apple.github.io/foundationdb/api-ruby.html. EOF s.authors = ["FoundationDB"] s.email = 'fdb-dist@apple.com' diff --git a/bindings/ruby/lib/fdb.rb b/bindings/ruby/lib/fdb.rb index 0c2e5b5954..1552641d38 100644 --- a/bindings/ruby/lib/fdb.rb +++ b/bindings/ruby/lib/fdb.rb @@ -21,7 +21,7 @@ # FoundationDB Ruby API # Documentation for this API can be found at -# https://www.foundationdb.org/documentation/api-ruby.html +# https://apple.github.io/foundationdb/api-ruby.html module FDB @@chosen_version = -1 diff --git a/bindings/ruby/lib/fdbdirectory.rb b/bindings/ruby/lib/fdbdirectory.rb index 5c411fe91e..d14af34722 100644 --- a/bindings/ruby/lib/fdbdirectory.rb +++ b/bindings/ruby/lib/fdbdirectory.rb @@ -23,7 +23,7 @@ # FoundationDB Ruby API # Documentation for this API can be found at -# https://www.foundationdb.org/documentation/api-ruby.html +# https://apple.github.io/foundationdb/api-ruby.html require 'thread' diff --git a/bindings/ruby/lib/fdbimpl.rb b/bindings/ruby/lib/fdbimpl.rb index dcee3236b9..565bc915b9 100644 --- a/bindings/ruby/lib/fdbimpl.rb +++ b/bindings/ruby/lib/fdbimpl.rb @@ -23,7 +23,7 @@ # FoundationDB Ruby API # Documentation for this API can be found at -# https://www.foundationdb.org/documentation/api-ruby.html +# https://apple.github.io/foundationdb/api-ruby.html require 'ffi' diff --git a/bindings/ruby/lib/fdblocality.rb b/bindings/ruby/lib/fdblocality.rb index b661bfd071..400769adbb 100644 --- a/bindings/ruby/lib/fdblocality.rb +++ b/bindings/ruby/lib/fdblocality.rb @@ -23,7 +23,7 @@ # FoundationDB Ruby API # Documentation for this API can be found at -# https://www.foundationdb.org/documentation/api-ruby.html +# https://apple.github.io/foundationdb/api-ruby.html module FDB module Locality diff --git a/bindings/ruby/lib/fdbsubspace.rb b/bindings/ruby/lib/fdbsubspace.rb index 3ff7444877..eab191330a 100644 --- a/bindings/ruby/lib/fdbsubspace.rb +++ b/bindings/ruby/lib/fdbsubspace.rb @@ -23,7 +23,7 @@ # FoundationDB Ruby API # Documentation for this API can be found at -# https://www.foundationdb.org/documentation/api-ruby.html +# https://apple.github.io/foundationdb/api-ruby.html require_relative 'fdbtuple' diff --git a/bindings/ruby/lib/fdbtuple.rb b/bindings/ruby/lib/fdbtuple.rb index 816d28e1fc..71b2402693 100644 --- a/bindings/ruby/lib/fdbtuple.rb +++ b/bindings/ruby/lib/fdbtuple.rb @@ -23,7 +23,7 @@ # FoundationDB Ruby API # Documentation for this API can be found at -# https://www.foundationdb.org/documentation/api-ruby.html +# https://apple.github.io/foundationdb/api-ruby.html module FDB module Tuple diff --git a/fdbclient/vexillographer/ruby.cs b/fdbclient/vexillographer/ruby.cs index c1a0cc9004..409afb1834 100644 --- a/fdbclient/vexillographer/ruby.cs +++ b/fdbclient/vexillographer/ruby.cs @@ -79,7 +79,7 @@ namespace vexillographer # THE SOFTWARE. # Documentation for this API can be found at -# https://www.foundationdb.org/documentation/api-ruby.html +# https://apple.github.io/foundationdb/api-ruby.html module FDB"); foreach (Scope s in Enum.GetValues(typeof(Scope))) diff --git a/packaging/foundationdb.conf b/packaging/foundationdb.conf index b7335ef4e4..96a7336134 100644 --- a/packaging/foundationdb.conf +++ b/packaging/foundationdb.conf @@ -2,7 +2,7 @@ ## ## Configuration file for FoundationDB server processes ## Full documentation is available at -## https://www.foundationdb.org/documentation/configuration.html#foundationdb-conf +## https://apple.github.io/foundationdb/configuration.html#the-configuration-file [fdbmonitor] user = foundationdb diff --git a/packaging/msi/FDBInstaller.wxs b/packaging/msi/FDBInstaller.wxs index 871a2a8c2c..0bd77ecc99 100644 --- a/packaging/msi/FDBInstaller.wxs +++ b/packaging/msi/FDBInstaller.wxs @@ -390,7 +390,7 @@ diff --git a/packaging/msi/skeleton.conf b/packaging/msi/skeleton.conf index 79ede0c15b..72b4b95055 100644 --- a/packaging/msi/skeleton.conf +++ b/packaging/msi/skeleton.conf @@ -2,7 +2,7 @@ ## ## Configuration file for FoundationDB server processes ## Full documentation is available at -## https://www.foundationdb.org/documentation/configuration.html#foundationdb-conf +## https://apple.github.io/foundationdb/configuration.html#the-configuration-file [fdbmonitor] restart_delay = 20 diff --git a/packaging/osx/foundationdb.conf.new b/packaging/osx/foundationdb.conf.new index 8871047c11..da1a1cd62e 100644 --- a/packaging/osx/foundationdb.conf.new +++ b/packaging/osx/foundationdb.conf.new @@ -2,7 +2,7 @@ ## ## Configuration file for FoundationDB server processes ## Full documentation is available at -## https://www.foundationdb.org/documentation/configuration.html#foundationdb-conf +## https://apple.github.io/foundationdb/configuration.html#the-configuration-file [general] restart_delay = 60