Skip to content

Commit

Permalink
documentation at code.kx.com/q
Browse files Browse the repository at this point in the history
  • Loading branch information
5jt committed Dec 29, 2019
1 parent d578e37 commit 06ae417
Show file tree
Hide file tree
Showing 14 changed files with 21 additions and 61 deletions.
8 changes: 4 additions & 4 deletions README.md
Expand Up @@ -3,7 +3,7 @@ Documentation for kdb+ and q



Version 2.0 of the documentation site at [code.kx.com](https://code.kx.com).
Version 2.0 of the documentation site at [code.kx.com/q](https://code.kx.com/q).



Expand All @@ -25,14 +25,14 @@ Not upwardly compatible
-----------------------

Version 2.0 substantially reorganizes the URL structure of the site.
Most keywords and operators now have short URLs, e.g. code.kx.com/v2/ref/aj and code.kx.com/v2/ref/fill.
Most keywords and operators now have short URLs, e.g. code.kx.com/q/ref/aj and code.kx.com/q/ref/fill.

This marks a break from [Version 1.0](https://github.com/kxsystems/docs-v1/).
There is no Git continuity between the two repos.

The terminology revision begun in Version 1.0 is complete: _adverbs_ are now _iterators_. The Reference material for them has been completely rewritten and the 2013 whitepaper “Efficient use of adverbs” re-issued as [“Iterators”](https://code.kx.com/v2/wp/iterators/). The concept of _rank_ is extended from functions to all applicable values. _Variadic_ replaces _ambivalent_ for values (e.g. derived functions and matrixes) that may be applied as either unary or binary.
The terminology revision begun in Version 1.0 is complete: _adverbs_ are now _iterators_. The Reference material for them has been completely rewritten and the 2013 whitepaper “Efficient use of adverbs” re-issued as [“Iterators”](https://code.kx.com/q/wp/iterators/). The concept of _rank_ is extended from functions to all applicable values. _Variadic_ replaces _ambivalent_ for values (e.g. derived functions and matrixes) that may be applied as either unary or binary.

The Cookbook articles are now in the [Knowledge Base](https://code.kx.com/kb/).
The Cookbook articles are now in the [Knowledge Base](https://code.kx.com/q/kb/).



Expand Down
39 changes: 0 additions & 39 deletions docker_docs.sh

This file was deleted.

2 changes: 1 addition & 1 deletion docs/about/sg/miscellaneous.md
Expand Up @@ -75,7 +75,7 @@ Hyphenate adjectival phrases. For example, the hyphen in _high-level category_ i
## Linking

Take opportunities to link to the Reference, the Knowledge Base, _Q for Mortals_,etc.
Links can start from the site root, e.g. `/v2/ref/cond/`.
Links can start from the site root, e.g. `/q/ref/cond/`.


## Function reference
Expand Down
2 changes: 1 addition & 1 deletion docs/about/sg/style.md
Expand Up @@ -14,7 +14,7 @@ keywords: bold, code, italic, kdb+, markdown, q, style

Everything in plain type should be American English or

- a term in the [Glossary](https://code.kx.com/v2/basics/glossary/)
- a term in the [Glossary](https://code.kx.com/q/basics/glossary/)
- a locally-defined usage


Expand Down
2 changes: 1 addition & 1 deletion docs/about/site-news.md
Expand Up @@ -149,7 +149,7 @@ The site content is now licensed under a <a rel="license" href="https://creative
— <i>Bob Dylan</i> “When the ship comes in”
</p>
<p style="display: inline-block; padding: 0 1em;">
<a href="https://www.bobdylan.com/albums/the-times-they-are-a-changin/" title="The Times they Are A’Changin’"><img alt="Bob Dylan" src="//code.kx.com/v2/img/dylan.png" style="height: 70px"/></a>
<a href="https://www.bobdylan.com/albums/the-times-they-are-a-changin/" title="The Times they Are A’Changin’"><img alt="Bob Dylan" src="//code.kx.com/q/img/dylan.png" style="height: 70px"/></a>
</p>
</blockquote>

Expand Down
4 changes: 2 additions & 2 deletions docs/learn/install/linux.md
Expand Up @@ -63,7 +63,7 @@ l32/ 2()core 4096MB sjt mark.local 192.168.0.17 NONEXPIRE
Welcome to kdb+ 32bit edition
For support please see https://groups.google.com/d/forum/personal-kdbplus
Tutorials can be found at http://code.kx.com/v2/tutorials/install
Tutorials can be found at http://code.kx.com/q/tutorials/install
To exit type \\
To remove this startup msg, edit q.q
q)til 6
Expand Down Expand Up @@ -150,7 +150,7 @@ l32/ 2()core 4096MB sjt mark.local 192.168.0.17 NONEXPIRE
Welcome to kdb+ 32bit edition
For support please see http://groups.google.com/d/forum/personal-kdbplus
Tutorials can be found at http://code.kx.com/v2/tutorials/install
Tutorials can be found at http://code.kx.com/q/tutorials/install
To exit type \\
To remove this startup msg, edit q.q
```
Expand Down
4 changes: 2 additions & 2 deletions docs/learn/install/macos.md
Expand Up @@ -32,7 +32,7 @@ m32/ 2()core 4096MB sjt mark.local 192.168.0.17 NONEXPIRE
Welcome to kdb+ 32bit edition
For support please see http://groups.google.com/d/forum/personal-kdbplus
Tutorials can be found at http://code.kx.com/v2/tutorials/install
Tutorials can be found at http://code.kx.com/q/tutorials/install
To exit type \\
To remove this startup msg, edit q.q
```
Expand Down Expand Up @@ -126,7 +126,7 @@ m32/ 2()core 4096MB sjt mark.local 192.168.0.17 NONEXPIRE
Welcome to kdb+ 32bit edition
For support please see http://groups.google.com/d/forum/personal-kdbplus
Tutorials can be found at http://code.kx.com/v2/tutorials/install
Tutorials can be found at http://code.kx.com/q/tutorials/install
To exit type \\
To remove this startup msg, edit q.q
```
Expand Down
2 changes: 1 addition & 1 deletion docs/learn/install/windows.md
Expand Up @@ -59,7 +59,7 @@ w32/ 4()core 3974MB mr.user it1234567 192.168.0.37 NONEXPIRE
Welcome to kdb+ 32bit edition
For support please see http://groups.google.com/d/forum/personal-kdbplus
Tutorials can be found at http://code.kx.com/v2/tutorials/install
Tutorials can be found at http://code.kx.com/q/tutorials/install
To exit type \\
To remove this startup msg, edit q.q
q)til 6
Expand Down
4 changes: 2 additions & 2 deletions docs/scripts/theme.js
Expand Up @@ -13,7 +13,7 @@ $(function() {
}
});
// Search engine call from Search box
var kxSearch = 'https://code.kx.com/v2/search2?query='; // >>> reverse-proxy on Nginx at code.kx.com
var kxSearch = 'https://code.kx.com/q/search2?query='; // >>> reverse-proxy on Nginx at code.kx.com
var srchHandler =function( evt ) {
if( evt.which===13 ) {
var qry = $("[data-md-component=query]").val().trim();
Expand Down Expand Up @@ -41,7 +41,7 @@ $(function() {
});
$(btn).click(function() {
var host = window.location.host;
var dest = "/v2/about/search/";
var dest = "/q/about/search/";
window.location = dest;
});
});
2 changes: 1 addition & 1 deletion docs/wiki.md
Expand Up @@ -14,7 +14,7 @@ The content, which runs on [Mediawiki](http://mediawiki.org),
has now been [archived on GitHub](https://github.com/kxsystems/wiki).

<i class="far fa-hand-point-right"></i>
[Current **reference card**](https://code.kx.com/v2/ref/)
[Current **reference card**](https://code.kx.com/q/ref/)

Inquiries to <librarian@kx.com>.

Expand Down
6 changes: 3 additions & 3 deletions docs/wp/lightning-tickerplants/index.md
Expand Up @@ -44,7 +44,7 @@ Lightning daemon (`lnd`) | 0.6.0-beta (`commit=v0.6.0-beta-41-g1c22474ad31b5f7fe

[qbitcoind](https://github.com/jlucid/qbitcoind) is a q library designed to interact with a Bitcoin core full node.

This library is used herein to transfer funds from a Bitcoin core wallet to a Lightning wallet. For more information on running a node, and using qbitcoind, see [Kdb+ Securing Digital Assets](https://kx.com/blog/securing-digital-assets-a-bitcoin-full-node-api-for-kdb/) and [Storing and exploring the Bitcoin blockchain](https://code.kx.com/v2/wp/blockchain/).
This library is used herein to transfer funds from a Bitcoin core wallet to a Lightning wallet. For more information on running a node, and using qbitcoind, see [Kdb+ Securing Digital Assets](https://kx.com/blog/securing-digital-assets-a-bitcoin-full-node-api-for-kdb/) and [Storing and exploring the Bitcoin blockchain](../blockchain/index.md).

The reader should be aware that the above software is a beta version and the technology is still relatively new and experimental.
Keep funds held on Lightning to a minimum.
Expand Down Expand Up @@ -138,7 +138,7 @@ $sudo apt-get install bitcoind
```

Before starting the daemon, a `bitcoin.conf` file should be created in the install folder (usually `$HOME/.bitcoin`),
as described in white paper [Storing and exploring the Bitcoin blockchain](https://code.kx.com/v2/wp/blockchain/#installing-a-bitcoin-full-node).
as described in white paper [Storing and exploring the Bitcoin blockchain](../blockchain/index.md#installing-a-bitcoin-full-node).
However, the sample `bitcoin.conf` file presented in that white paper should now be extended, as shown below, to
include the [ZeroMQ](https://github.com/bitcoin/bitcoin/blob/master/doc/zmq.md) wrapper, which will allow the Lightning
node to be notified of events like the arrival of new blocks or transactions. Note that in the configuration file below, the
Expand Down Expand Up @@ -336,7 +336,7 @@ use of the powerful embedPy interface, recently released by Kx, which allows the
### EmbedPy setup
EmbedPy is available on [GitHub](https://github.com/kxsystems/embedpy) to use with kdb+ V3.5+ and Python 3.5 or higher, for macOS or Linux operating systems and Python 3.6 or higher on the Windows operating system. The installation directory also contains a `README` about embedPy, and an example directory containing thorough examples.
The reader is encouraged to follow the [online documentation](https://code.kx.com/v2/ml/embedpy/) to become familiar with the functionality.
The reader is encouraged to follow the [online documentation](../../ml/embedpy/index.md) to become familiar with the functionality.
### Running `qlnd`
Expand Down
2 changes: 1 addition & 1 deletion docs/wp/symfiles.md
Expand Up @@ -501,7 +501,7 @@ operations.

### Single-threaded sym rewrite

The [function](https://code.kx.com/v2/kb/compacting-hdb-sym/) that we’re going to discuss in detail below was written by Charles Skelton and can be used as
The [function](https://code.kx.com/q/kb/compacting-hdb-sym/) that we’re going to discuss in detail below was written by Charles Skelton and can be used as
a template for compacting a sym file. Changes have been made where
needed for V3.6 of kdb+, with comments added where necessary. The
function assumes a single enumeration (sym), and only splayed tables in
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Expand Up @@ -57,7 +57,7 @@ site_author: 'Kx Systems'
site_description: "Kx documentation for kdb+ and the q programming language"
# config.site_name: 'code.kx.com'
site_name: 'Kdb+ and q documentation'
site_url: 'https://code.kx.com/v2/'
site_url: 'https://code.kx.com/q/'
use_directory_urls: true
theme:
custom_dir: custom_theme/
Expand All @@ -76,7 +76,7 @@ theme:
title: "On this page"
nav:
- Home: index.md
- Reference: https://code.kx.com/v2/ref/
- Reference: https://code.kx.com/q/ref/
- GitHub: github.md
- Support: support.md
- Developer tools: devtools.md
Expand Down
1 change: 0 additions & 1 deletion robots.txt

This file was deleted.

0 comments on commit 06ae417

Please sign in to comment.