Skip to content

Commit ff4f8d9

Browse files
ldennisldennis
committed
initial commit
0 parents  commit ff4f8d9

File tree

189 files changed

+25562
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

189 files changed

+25562
-0
lines changed

‎docs/Gemfile‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
source 'http://rubygems.org'
2+
gem 'github-pages'

‎docs/Makefile‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
clean:
2+
rm -f src/sqlitegen/all.html src/sqlitegen/syntax_linkage.tcl
3+
4+
5+
spellcheck:
6+
find pages -name "*.md" -exec aspell check {} \;
7+
8+
9+
aspell-dict:
10+
cp --backup aspell.en.pws ~/.aspell.en.pws

‎docs/README‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
This is Comdb2 documentation. If you're going to work on it, and want
2+
to preview changes before you commit, you'll need to set up a few
3+
things. This'll tell you how.
4+
5+
Instructions for Debian-based systems follow. Instructions for
6+
Redhat-based systems would be welcome.
7+
8+
0) install a sane build environment (sudo apt-get install build-essential zlib1g-dev)
9+
1) cd docs
10+
2) Install jekyll (sudo apt install jekyll)
11+
3) Start server (jekyll serve --watch --host your_ip --port your_port)
12+
13+
The docs are in pages/*.md. The table of contents on the left is in
14+
_data/sidebars/mydoc_sidebar.yml When you save files, jekyll should
15+
regenerate the docs automatically. Point your browser at
16+
http://your_ip:your_port to view them.
17+
18+
Images in the docs/images directory are not checked in (except for svg diagrams). Any svg diagrams were
19+
done with draw.io, and the source files are in docs/diagrams. Syntax diagrams are generated by SQLite's
20+
scripts. To generates those
21+
1) cd docs/sqlitegen
22+
2) run ./bubble-generator.tcl (tcl is already a build requirement for Comdb2 and should be present)
23+
3) click the 'Everything' button.
24+
4) kill bubble-generator.tcl after it's done
25+
The program depends on Tk and thus Xlib, so converting it to something that doesn't need X isn't trivial,
26+
and probably isn't worth the time.

‎docs/_config.yml‎

Lines changed: 68 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
2+
topnav_title: Comdb2
3+
# this appears on the top navigation bar next to the home button
4+
5+
site_title: Comdb2 Documentation
6+
# this appears in the html browser tab for the site title (seen mostly by search engines, not users)
7+
8+
feedback_uuid: 15833401
9+
# used as a contact email for the Feedback link in the top navigation bar
10+
11+
defaults:
12+
-
13+
scope:
14+
path: ""
15+
type: "pages"
16+
values:
17+
layout: "page"
18+
comments: true
19+
search: true
20+
sidebar: mydoc_sidebar
21+
-
22+
scope:
23+
path: ""
24+
type: "tooltips"
25+
values:
26+
layout: "page"
27+
comments: true
28+
search: true
29+
tooltip: true
30+
31+
-
32+
scope:
33+
path: ""
34+
type: "posts"
35+
values:
36+
layout: "post"
37+
comments: true
38+
search: true
39+
sidebar: mydoc_sidebar
40+
# these are defaults used for the frontmatter for these file types
41+
42+
exclude:
43+
- .idea/
44+
- .gitignore
45+
# these are the files and directories that jekyll will exclude from the build
46+
47+
48+
#### IGNORE BELOW HERE ####
49+
50+
output: web
51+
# this property is useful for conditional filtering of content that is separate from the PDF.
52+
53+
host: 127.0.0.1
54+
# the preview server used. Leave as is.
55+
56+
port: 8080
57+
# the port where the preview is rendered. You can leave this as is unless you have other Jekyll builds using this same port that might cause conflicts. in that case, use another port such as 4006.
58+
59+
highlighter: rouge
60+
# library used for syntax highlighting
61+
62+
markdown: kramdown
63+
kramdown:
64+
input: GFM
65+
auto_ids: true
66+
hard_wrap: false
67+
syntax_highlighter: rouge
68+
# filter used to process markdown. note that kramdown differs from github-flavored markdown in some subtle ways

‎docs/_data/definitions.yml‎

Whitespace-only changes.

‎docs/_data/sidebars/mydoc_sidebar.yml‎

Lines changed: 149 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
2+
3+
entries:
4+
- title: sidebar
5+
product: Comdb2
6+
version: 7.0pre
7+
folders:
8+
9+
- title: Overview
10+
output: web
11+
folderitems:
12+
13+
- title: What is Comdb2?
14+
url: /overview_home.html
15+
output: web
16+
type: homepage
17+
18+
- title: Installing Comdb2
19+
url: /install.html
20+
output: web
21+
type: homepage
22+
23+
- title: Your first database
24+
url: /example_db.html
25+
output: web
26+
type: homepage
27+
28+
- title: The Comdb2 transaction model
29+
url: /transaction_model.html
30+
output: web
31+
type: homepage
32+
33+
- title: Linearizable Consistency
34+
url: /durable.html
35+
output: web
36+
type: homepage
37+
38+
- title: Contributing to Comdb2
39+
url: /contrib.html
40+
output: web
41+
42+
- title: Programming for Comdb2
43+
output: web
44+
folderitems:
45+
46+
- title: SQL language
47+
url: /sql.html
48+
output: web
49+
50+
- title: Schema definition language
51+
url: /table_schema.html
52+
output: web
53+
54+
- title: Data types
55+
url: /datatypes.html
56+
output: web
57+
58+
- title: Datetime types
59+
url: /datetime.html
60+
output: web
61+
62+
- title: Decimal types
63+
url: /decimals.html
64+
output: web
65+
66+
- title: Constraints
67+
url: /constraints.html
68+
output: web
69+
70+
- title: C API
71+
url: /c_api.html
72+
output: web
73+
74+
- title: JDBC API
75+
url: /jdbc_api.html
76+
output: web
77+
78+
- title: Writing language bindings
79+
url: /client_protocol.html
80+
output: web
81+
82+
- title: Stored procedures
83+
url: /storedprocs.html
84+
output: web
85+
86+
- title: System tables
87+
url: /system_tables.html
88+
output: web
89+
90+
- title: Triggers
91+
url: /triggers.html
92+
output: web
93+
94+
- title: Bi-Temporal Tables
95+
url: /bitemporal.html
96+
output: web
97+
98+
- title: Configuring databases
99+
output: web
100+
folderitems:
101+
102+
- title: Configuration files
103+
url: /config_files.html
104+
output: web
105+
106+
- title: Command line arguments
107+
url: /args.html
108+
output: web
109+
110+
- title: Setting up clusters
111+
url: /cluster.html
112+
output: web
113+
114+
- title: Client setup
115+
url: /clients.html
116+
output: web
117+
118+
- title: Setting up hosted services
119+
url: /hosted.html
120+
output: web
121+
122+
- title: Encryption
123+
url: /crypto.html
124+
output: web
125+
126+
- title: Authentication
127+
url: /auth.html
128+
output: web
129+
130+
- title: Configuring Secure Sockets Layer (SSL)
131+
url: /ssl.html
132+
output: web
133+
134+
- title: Operating databases
135+
url: /operations.html
136+
output: web
137+
folderitems:
138+
139+
- title: Operational commands
140+
url: /op.html
141+
output: web
142+
143+
- title: Backups
144+
url: /backups.html
145+
output: web
146+
147+
- title: Examining logs
148+
url: /logs.html
149+
output: web

‎docs/_data/tags.yml‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
allowed-tags:
2+
- intro
3+
- code
4+
- JDBC
5+
- Java
6+
- Security
7+
- SSL
8+
- TLS
9+
- Encryption

‎docs/_data/topnav.yml‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Topnav single links
2+
## if you want to list an external url, use external_url instead of url. the theme will apply a different link base.
3+
topnav:
4+
- title: Topnav
5+
items:
6+
- title: Repository
7+
external_url: https://github.com/bloomberg/comdb2

‎docs/_includes/archive.html‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
layout: default
3+
type: archive
4+
---
5+
6+
<div class="post-header">
7+
<h1 class="post-title-main">{{ page.title }}</h1>
8+
</div>
9+
<div class="post-content">
10+
11+
{{ content }}
12+
</div>
13+
14+
15+

‎docs/_includes/callout.html‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
<div markdown="span" class="bs-callout bs-callout-{{include.type}}">{{include.content}}</div>

0 commit comments

Comments
 (0)