Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
5c716f9
docs(root): fix stale CentOS setup step, document disabled edit link
netravnen Aug 7, 2026
6da4c92
docs(getting-started): add role-picker, de-duplicate boilerplate, num…
netravnen Aug 7, 2026
6637fbc
docs(howto): split API reference out of search.md, expand MFA guide
netravnen Aug 7, 2026
6f09f91
docs(links): fix dead links in FAQ and blog posts
netravnen Aug 7, 2026
6412abb
docs(committee): add Deskpro public response snippets index
netravnen Aug 7, 2026
49cd733
docs(getting-started): add qualification criteria and deletion-lock g…
netravnen Aug 7, 2026
6f368e4
docs(faq): document RDAP affiliation, admin succession, and deletion …
netravnen Aug 7, 2026
31c962a
docs(nav): register Deskpro snippets and API reference pages in site nav
netravnen Aug 7, 2026
d74474d
docs(faq): add Mergers and Acquisitions guidance
netravnen Aug 7, 2026
c0e90f4
ci(docs): add fork preview build-check and deploy workflows
netravnen Aug 7, 2026
ce822f8
feat(blog): generate an Atom feed with git-derived dates
netravnen Aug 7, 2026
bba73ee
feat(deploy): generate docs/CNAME dynamically, dedicated dev domain
netravnen Aug 7, 2026
ea423bd
feat(hooks): unify site-URL resolution across build hooks
netravnen Aug 7, 2026
748ead2
feat(theme): add fork-preview banner above nav bar
netravnen Aug 7, 2026
ffb243d
refactor(feed): extract shared atom_common helpers, relocate blog feed
netravnen Aug 7, 2026
3e96e03
feat(feed): add release notes Atom feed
netravnen Aug 7, 2026
a6f295a
ci(deploy): force gh-pages to a single fresh commit each deploy
netravnen Aug 7, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 33 additions & 0 deletions .github/workflows/docs-build-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Docs Build Check

on:
pull_request:
push:
branches:
- master
- admincom/docs-improvements

permissions:
contents: read

jobs:
build-check:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Install uv
uses: astral-sh/setup-uv@v6
with:
enable-cache: true
cache-dependency-glob: "uv.lock"
python-version: "3.11"

- name: Install dependencies
run: uv sync --locked

- name: Build docs (strict)
run: uv run mkdocs build --strict
54 changes: 54 additions & 0 deletions .github/workflows/docs-deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
name: Deploy Docs Preview

on:
push:
branches:
- master
- admincom/docs-improvements
workflow_dispatch:

permissions:
contents: write

concurrency:
group: docs-deploy
cancel-in-progress: false

jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 0

- name: Install uv
uses: astral-sh/setup-uv@v6
with:
enable-cache: true
cache-dependency-glob: "uv.lock"
python-version: "3.11"

- name: Install dependencies
run: uv sync --locked

- name: Configure git identity for the gh-deploy commit
run: |
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"

# This fork's preview serves at a dedicated dev domain, docs-dev.peeringdb.dk,
# distinct from upstream production's docs.peeringdb.com. The domain is set
# as a repo variable (Settings -> Secrets and variables -> Actions ->
# Variables -> SITE_URL_OVERRIDE) rather than hardcoded here, so it can be
# changed without editing this file. It feeds both scripts/generate_cname.py
# (writes docs/CNAME) and scripts/generate_blog_atom_feed.py (the feed's
# self-link), so both stay in sync with wherever this deploy actually serves
# from. Safe by default if this branch is ever merged upstream: with no
# variable set there, both hooks fall back to mkdocs.yml's site_url
# (docs.peeringdb.com), so no manual CNAME edit is needed at merge time.
- name: Deploy to gh-pages
env:
SITE_URL_OVERRIDE: ${{ vars.SITE_URL_OVERRIDE }}
run: uv run mkdocs gh-deploy --clean --force --no-history
5 changes: 5 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,8 @@ site/
.DS_Store
venv/
.venv/
docs/blog/atom.xml
docs/release_notes/atom.xml
docs/CNAME
__pycache__/
*.pyc
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ To work on and change these documents, you'll need git, python, and pip.

- CentOS
```sh
sudo yum install python-pip
sudo dnf install python3 python3-pip
```

Fork the repo
Expand Down
1 change: 0 additions & 1 deletion docs/CNAME

This file was deleted.

2 changes: 1 addition & 1 deletion docs/blog/mfa_mandatory.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# PeeringDB Will Require MFA and API Keys to Log In
*March 13, 2025*

You must have a [second factor](/howto/enable_require_2fa/) to log in to PeeringDB starting on 1 July 2025. If you automate updates using [our API](/api_specs/), you'll need to use an [API Key](/howto/api_keys/).
You must have a [second factor](/howto/authenticate/#multi-factor-authentication-mfa) to log in to PeeringDB starting on 1 July 2025. If you automate updates using [our API](/api_specs/), you'll need to use an [API Key](/howto/api_keys/).

But anonymous usage will not be going away. You can query the website or API without authenticating. This change will impact users who make updates or need access to contact information published in PeeringDB.

Expand Down
2 changes: 1 addition & 1 deletion docs/blog/peeringdb_2022_user_survey.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ We had about 250 responses to last year’s survey which helped guide our produc
* Added FIDO U2F 2FA support to [www.peeringdb.com](https://www.peeringdb.com/)
* Normalized place names

We’ve also published more documents in our [HOWTO documentation series](/howto/).
We’ve also published more documents in our [HOWTO documentation series](/howtos/).

Steve McManus, PeeringDB Product Committee Chair, says: "*The 2021 survey helped us focus development where it was most needed. We used it to develop our roadmap. We are still implementing things we have learned from previous surveys but want your input on how we should adapt. Please take a few moments of their time to help us make PeeringDB a better service!*”

Expand Down
2 changes: 2 additions & 0 deletions docs/blogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

PeeringDB blogs provide deeper insight into the releases and product roadmap.

Subscribe via [Atom feed](blog/atom.xml) to get notified of new posts.

## 2026
- [Do We Still Need Public Beta?](blog/public_beta.md) - July 26, 2026
- [Data Quality for Networks](blog/data_quality_for_networks.md) - July 1, 2026
Expand Down
Loading
Loading