Skip to content

Commit 18a2839

Browse files
committed
initial port of the wiki
0 parents  commit 18a2839

23 files changed

+1462
-0
lines changed

.github/workflows/mkdocs.yml

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
name: mkdocs
2+
on:
3+
push:
4+
branches:
5+
- gh-pages
6+
permissions:
7+
contents: write
8+
pages: write
9+
id-token: write
10+
jobs:
11+
deploy:
12+
runs-on: ubuntu-latest
13+
steps:
14+
- uses: actions/checkout@v4
15+
- name: Configure GitHub Pages
16+
uses: actions/configure-pages@v5
17+
- uses: actions/setup-python@v5
18+
with:
19+
python-version: 3.x
20+
- run: echo "cache_id=$(date --utc '+%V')" >> $GITHUB_ENV
21+
- uses: actions/cache@v4
22+
with:
23+
key: mkdocs-material-${{ env.cache_id }}
24+
path: .cache
25+
restore-keys: |
26+
mkdocs-material-
27+
- run: pip install mkdocs-material
28+
- run: pip install mkdocs-print-site-plugin
29+
- run: pip install mkdocs-autorefs
30+
- run: mkdocs build
31+
- name: Upload artifact
32+
uses: actions/upload-pages-artifact@v3
33+
with:
34+
path: ./site
35+
- name: Deploy artifact
36+
id: deployment
37+
uses: actions/deploy-pages@v4

Pipfile

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
[[source]]
2+
url = "https://pypi.org/simple"
3+
verify_ssl = true
4+
name = "pypi"
5+
6+
[packages]
7+
mkdocs-material = "*"
8+
mkdocs-print-site-plugin = "*"
9+
mkdocs-autorefs = "*"
10+
11+
[dev-packages]
12+
13+
[requires]
14+
python_version = "3.14"

Pipfile.lock

Lines changed: 572 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Install MkDocs Material and Other Things
2+
3+
```
4+
pipenv install mkdocs-material
5+
pipenv install mkdocs-print-site-plugin
6+
pipenv install mkdocs-autorefs
7+
```
8+
9+
# Serve
10+
11+
```
12+
pipenv run mkdocs serve
13+
```
14+
15+
16+
# Build
17+
```
18+
pipenv run mkdocs build
19+
```

docs/images/favicon.png

2.49 KB
Loading
7.14 KB
Loading
285 KB
Loading
390 KB
Loading
217 KB
Loading

docs/index.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
This is the user's manual for the ICANN-RDAP project, an open-source implementation of
2+
the Registry Data Access Protocol (RDAP). ICANN-RDAP includes four sub-projects.
3+
4+
# Command Line Tools
5+
6+
There are two command line tools, `rdap` and `rdap-test`.
7+
8+
The [`rdap`](rdap-cli-tools/cli-client/index.md) command is an easy-to-use, full-featured command line client.
9+
10+
The [`rdap-test`](rdap-cli-tools/test-tool/index.md) is an easy-to-use troubleshooting tool meant to help users identify issues.
11+
12+
# Rust Libraries
13+
14+
The Rust libraries are available from crates.io:
15+
16+
* [Common Library](https://crates.io/crates/icann-rdap-common) contains Rust structs and functions for RDAP. This library has been incorporated into custom, production RDAP servers and other software.
17+
* [Client Library](https://crates.io/crates/icann-rdap-client) has useful functions for querying RDAP servers, including bootstrapping. This library has been incorporated into custom, product clients such as intrusion detection systesm.
18+
19+
# An RDAP Server
20+
21+
This is an easy-to-use RDAP server that has in-memory storage and requires no infrastucture.
22+
This server is ideal for prototyping and testing.

0 commit comments

Comments
 (0)