Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs #50

Merged
merged 2 commits into from Dec 19, 2019
Merged

Update docs #50

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d0259af
Update tantivy
mosuka Dec 19, 2019
feb9b96
Update docs
mosuka Dec 19, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/building_bayard.html
View file
Open in desktop
Expand Up @@ -152,7 +152,7 @@ <h1><a class="header" href="#building-bayard" id="building-bayard">Building Baya
<h2><a class="header" href="#requirements" id="requirements">Requirements</a></h2>
<p>The following products are required to build Bayrad:</p>
<ul>
<li>Rust &gt;= 1.38.0</li>
<li>Rust &gt;= 1.39.0</li>
<li>make &gt;= 3.81</li>
<li>protoc &gt;= 3.9.2</li>
</ul>
Expand Down
2 changes: 1 addition & 1 deletion docs/designing_schema.html
View file
Open in desktop
Expand Up @@ -349,7 +349,7 @@ <h2><a class="header" href="#example-schema" id="example-schema">Example schema<
}
},
{
&quot;name&quot;: &quot;star&quot;,
&quot;name&quot;: &quot;popularity&quot;,
&quot;type&quot;: &quot;u64&quot;,
&quot;options&quot;: {
&quot;indexed&quot;: true,
Expand Down
77 changes: 44 additions & 33 deletions docs/getting_started.html
View file
Open in desktop
Expand Up @@ -246,80 +246,91 @@ <h2><a class="header" href="#indexing-document" id="indexing-document">Indexing
&quot;url&quot;: &quot;https://github.com/bayard-search/bayard&quot;,
&quot;name&quot;: &quot;Bayard&quot;,
&quot;description&quot;: &quot;Bayard is a full text search and indexing server, written in Rust, built on top of Tantivy.&quot;,
&quot;popularity&quot;: 1132,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/rust&quot;]
}'
&quot;popularity&quot;: 1152,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/rust&quot;],
&quot;timestamp&quot;: &quot;2019-12-19T10:41:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 2 '{
&quot;url&quot;: &quot;https://lucene.apache.org/solr/&quot;,
&quot;name&quot;: &quot;Apache Solr&quot;,
&quot;description&quot;: &quot;Solr is highly reliable, scalable and fault tolerant, providing distributed indexing, replication and load-balanced querying, automated failover and recovery, centralized configuration and more.&quot;,
&quot;popularity&quot;: 3112,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/java&quot;]
}'
&quot;popularity&quot;: 3135,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/java&quot;],
&quot;timestamp&quot;: &quot;2019-12-19T14:08:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 3 '{
&quot;url&quot;: &quot;https://www.elastic.co/products/elasticsearch&quot;,
&quot;name&quot;: &quot;Elasticsearch&quot;,
&quot;description&quot;: &quot;Elasticsearch is a distributed, open source search and analytics engine for all types of data, including textual, numerical, geospatial, structured, and unstructured.&quot;,
&quot;popularity&quot;: 45871,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/java&quot;]
}'
&quot;popularity&quot;: 46054,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/java&quot;],
&quot;timestamp&quot;: &quot;2019-12-19T08:19:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 4 '{
&quot;url&quot;: &quot;https://github.com/mosuka/blast&quot;,
&quot;name&quot;: &quot;Blast&quot;,
&quot;description&quot;: &quot;Blast is a full text search and indexing server, written in Go, built on top of Bleve.&quot;,
&quot;popularity&quot;: 644,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/go&quot;]
}'
&quot;popularity&quot;: 654,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/go&quot;],
&quot;timestamp&quot;: &quot;2019-10-18T19:50:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 5 '{
&quot;url&quot;: &quot;https://github.com/go-ego/riot&quot;,
&quot;name&quot;: &quot;Riot&quot;,
&quot;description&quot;: &quot;Riot is Go Open Source, Distributed, Simple and efficient full text search engine.&quot;,
&quot;popularity&quot;: 4936,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/go&quot;]
}'
&quot;popularity&quot;: 4948,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/go&quot;],
&quot;timestamp&quot;: &quot;2019-12-16T07:12:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 6 '{
&quot;url&quot;: &quot;https://github.com/toshi-search/Toshi&quot;,
&quot;name&quot;: &quot;Toshi&quot;,
&quot;description&quot;: &quot;Toshi is meant to be a full-text search engine similar to Elasticsearch. Toshi strives to be to Elasticsearch what Tantivy is to Lucene.&quot;,
&quot;popularity&quot;: 2433,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/rust&quot;]
}'
&quot;popularity&quot;: 2448,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/rust&quot;],
&quot;timestamp&quot;: &quot;2019-12-02T04:00:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 7 '{
&quot;url&quot;: &quot;https://github.com/valeriansaliou/sonic&quot;,
&quot;name&quot;: &quot;Sonic&quot;,
&quot;description&quot;: &quot;Sonic is a fast, lightweight and schema-less search backend.&quot;,
&quot;popularity&quot;: 7842,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/rust&quot;]
}'
&quot;popularity&quot;: 7895,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/rust&quot;],
&quot;timestamp&quot;: &quot;2019-12-10T23:13:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 8 '{
&quot;url&quot;: &quot;https://github.com/tantivy-search/tantivy&quot;,
&quot;name&quot;: &quot;Tantivy&quot;,
&quot;description&quot;: &quot;Tantivy is a full-text search engine library inspired by Apache Lucene and written in Rust.&quot;,
&quot;popularity&quot;: 3100,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/rust&quot;]
}'
&quot;popularity&quot;: 3142,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/rust&quot;],
&quot;timestamp&quot;: &quot;2019-12-19T10:07:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 9 '{
&quot;url&quot;: &quot;https://lucene.apache.org/&quot;,
&quot;name&quot;: &quot;Lucene&quot;,
&quot;description&quot;: &quot;Apache Lucene is a high-performance, full-featured text search engine library written entirely in Java.&quot;,
&quot;popularity&quot;: 3112,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/java&quot;]
}'
&quot;popularity&quot;: 3135,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/java&quot;],
&quot;timestamp&quot;: &quot;2019-12-19T14:08:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 10 '{
&quot;url&quot;: &quot;https://blevesearch.com/&quot;,
&quot;name&quot;: &quot;Bleve&quot;,
&quot;description&quot;: &quot;Bleve is a modern text indexing library for go.&quot;,
&quot;popularity&quot;: 6185,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/go&quot;]
}'
&quot;popularity&quot;: 6211,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/go&quot;],
&quot;timestamp&quot;: &quot;2019-10-30T16:13:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 11 '{
&quot;url&quot;: &quot;https://bitbucket.org/mchaput/whoosh/wiki/Home&quot;,
&quot;name&quot;: &quot;Whoosh&quot;,
&quot;description&quot;: &quot;Whoosh is a fast, pure Python search engine library.&quot;,
&quot;popularity&quot;: 0,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/python&quot;]
}'
$ ./bin/bayard commit
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/python&quot;],
&quot;timestamp&quot;: &quot;2019-10-08T05:30:26+09:00&quot;
}' | jq .
$ ./bin/bayard commit | jq .
</code></pre>
<h2><a class="header" href="#getting-document" id="getting-document">Getting document</a></h2>
<p>You can get document with the following command:</p>
Expand Down
81 changes: 46 additions & 35 deletions docs/print.html
View file
Open in desktop
Expand Up @@ -179,7 +179,7 @@ <h1><a class="header" href="#building-bayard" id="building-bayard">Building Baya
<h2><a class="header" href="#requirements" id="requirements">Requirements</a></h2>
<p>The following products are required to build Bayrad:</p>
<ul>
<li>Rust &gt;= 1.38.0</li>
<li>Rust &gt;= 1.39.0</li>
<li>make &gt;= 3.81</li>
<li>protoc &gt;= 3.9.2</li>
</ul>
Expand Down Expand Up @@ -288,80 +288,91 @@ <h2><a class="header" href="#indexing-document" id="indexing-document">Indexing
&quot;url&quot;: &quot;https://github.com/bayard-search/bayard&quot;,
&quot;name&quot;: &quot;Bayard&quot;,
&quot;description&quot;: &quot;Bayard is a full text search and indexing server, written in Rust, built on top of Tantivy.&quot;,
&quot;popularity&quot;: 1132,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/rust&quot;]
}'
&quot;popularity&quot;: 1152,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/rust&quot;],
&quot;timestamp&quot;: &quot;2019-12-19T10:41:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 2 '{
&quot;url&quot;: &quot;https://lucene.apache.org/solr/&quot;,
&quot;name&quot;: &quot;Apache Solr&quot;,
&quot;description&quot;: &quot;Solr is highly reliable, scalable and fault tolerant, providing distributed indexing, replication and load-balanced querying, automated failover and recovery, centralized configuration and more.&quot;,
&quot;popularity&quot;: 3112,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/java&quot;]
}'
&quot;popularity&quot;: 3135,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/java&quot;],
&quot;timestamp&quot;: &quot;2019-12-19T14:08:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 3 '{
&quot;url&quot;: &quot;https://www.elastic.co/products/elasticsearch&quot;,
&quot;name&quot;: &quot;Elasticsearch&quot;,
&quot;description&quot;: &quot;Elasticsearch is a distributed, open source search and analytics engine for all types of data, including textual, numerical, geospatial, structured, and unstructured.&quot;,
&quot;popularity&quot;: 45871,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/java&quot;]
}'
&quot;popularity&quot;: 46054,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/java&quot;],
&quot;timestamp&quot;: &quot;2019-12-19T08:19:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 4 '{
&quot;url&quot;: &quot;https://github.com/mosuka/blast&quot;,
&quot;name&quot;: &quot;Blast&quot;,
&quot;description&quot;: &quot;Blast is a full text search and indexing server, written in Go, built on top of Bleve.&quot;,
&quot;popularity&quot;: 644,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/go&quot;]
}'
&quot;popularity&quot;: 654,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/go&quot;],
&quot;timestamp&quot;: &quot;2019-10-18T19:50:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 5 '{
&quot;url&quot;: &quot;https://github.com/go-ego/riot&quot;,
&quot;name&quot;: &quot;Riot&quot;,
&quot;description&quot;: &quot;Riot is Go Open Source, Distributed, Simple and efficient full text search engine.&quot;,
&quot;popularity&quot;: 4936,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/go&quot;]
}'
&quot;popularity&quot;: 4948,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/go&quot;],
&quot;timestamp&quot;: &quot;2019-12-16T07:12:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 6 '{
&quot;url&quot;: &quot;https://github.com/toshi-search/Toshi&quot;,
&quot;name&quot;: &quot;Toshi&quot;,
&quot;description&quot;: &quot;Toshi is meant to be a full-text search engine similar to Elasticsearch. Toshi strives to be to Elasticsearch what Tantivy is to Lucene.&quot;,
&quot;popularity&quot;: 2433,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/rust&quot;]
}'
&quot;popularity&quot;: 2448,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/rust&quot;],
&quot;timestamp&quot;: &quot;2019-12-02T04:00:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 7 '{
&quot;url&quot;: &quot;https://github.com/valeriansaliou/sonic&quot;,
&quot;name&quot;: &quot;Sonic&quot;,
&quot;description&quot;: &quot;Sonic is a fast, lightweight and schema-less search backend.&quot;,
&quot;popularity&quot;: 7842,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/rust&quot;]
}'
&quot;popularity&quot;: 7895,
&quot;category&quot;: [&quot;/category/search/server&quot;, &quot;/language/rust&quot;],
&quot;timestamp&quot;: &quot;2019-12-10T23:13:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 8 '{
&quot;url&quot;: &quot;https://github.com/tantivy-search/tantivy&quot;,
&quot;name&quot;: &quot;Tantivy&quot;,
&quot;description&quot;: &quot;Tantivy is a full-text search engine library inspired by Apache Lucene and written in Rust.&quot;,
&quot;popularity&quot;: 3100,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/rust&quot;]
}'
&quot;popularity&quot;: 3142,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/rust&quot;],
&quot;timestamp&quot;: &quot;2019-12-19T10:07:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 9 '{
&quot;url&quot;: &quot;https://lucene.apache.org/&quot;,
&quot;name&quot;: &quot;Lucene&quot;,
&quot;description&quot;: &quot;Apache Lucene is a high-performance, full-featured text search engine library written entirely in Java.&quot;,
&quot;popularity&quot;: 3112,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/java&quot;]
}'
&quot;popularity&quot;: 3135,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/java&quot;],
&quot;timestamp&quot;: &quot;2019-12-19T14:08:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 10 '{
&quot;url&quot;: &quot;https://blevesearch.com/&quot;,
&quot;name&quot;: &quot;Bleve&quot;,
&quot;description&quot;: &quot;Bleve is a modern text indexing library for go.&quot;,
&quot;popularity&quot;: 6185,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/go&quot;]
}'
&quot;popularity&quot;: 6211,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/go&quot;],
&quot;timestamp&quot;: &quot;2019-10-30T16:13:00+09:00&quot;
}' | jq .
$ ./bin/bayard put 11 '{
&quot;url&quot;: &quot;https://bitbucket.org/mchaput/whoosh/wiki/Home&quot;,
&quot;name&quot;: &quot;Whoosh&quot;,
&quot;description&quot;: &quot;Whoosh is a fast, pure Python search engine library.&quot;,
&quot;popularity&quot;: 0,
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/python&quot;]
}'
$ ./bin/bayard commit
&quot;category&quot;: [&quot;/category/search/library&quot;, &quot;/language/python&quot;],
&quot;timestamp&quot;: &quot;2019-10-08T05:30:26+09:00&quot;
}' | jq .
$ ./bin/bayard commit | jq .
</code></pre>
<h2><a class="header" href="#getting-document" id="getting-document">Getting document</a></h2>
<p>You can get document with the following command:</p>
Expand Down Expand Up @@ -672,7 +683,7 @@ <h2><a class="header" href="#example-schema" id="example-schema">Example schema<
}
},
{
&quot;name&quot;: &quot;star&quot;,
&quot;name&quot;: &quot;popularity&quot;,
&quot;type&quot;: &quot;u64&quot;,
&quot;options&quot;: {
&quot;indexed&quot;: true,
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/searchindex.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs_src/building_bayard.md
View file
Open in desktop
Expand Up @@ -4,7 +4,7 @@

The following products are required to build Bayrad:

- Rust >= 1.38.0
- Rust >= 1.39.0
- make >= 3.81
- protoc >= 3.9.2

Expand Down
2 changes: 1 addition & 1 deletion docs_src/designing_schema.md
View file
Open in desktop
Expand Up @@ -154,7 +154,7 @@ Here is a sample schema:
}
},
{
"name": "star",
"name": "popularity",
"type": "u64",
"options": {
"indexed": true,
Expand Down