PeeringDB Documentation

As viewable at https://docs.peeringdb.com/

NOTE Please do not put issues here anymore, new issues should be created at https://github.com/peeringdb/peeringdb/issues

Modifying these docs

To work on and change these documents, you'll need git, python, and pip.

• CentOS

  sudo yum install python-pip
  

Fork the repo

• click the Fork button on https://github.com/peeringdb/docs
• select your GitHub username

Clone the repo

cd ~/src # Adjust here and below as appropriate.
git clone git@github.com:$GITHUB_USERNAME/docs.git

Install MkDocs and other requirements

cd ~/src/docs
python3 -m venv .venv
source .venv/bin/activate
python -m pip install --upgrade uv
uv sync

Start mkdocs

cd ~/src/docs
source .venv/bin/activate
mkdocs serve

or, if you'd like to specify the port, use -a $ADDRESS:$PORT, for example:

cd ~/src/docs
source .venv/bin/activate
mkdocs serve -a 0.0.0.0:7889

You should now see a message similar to: Serving on http://127.0.0.1:8000

Point your browser at that URL, and you'll get real time updates to the generated documentation as you edit.

Markdown has its own formatting syntax, to get started look here for an excellent cheatsheet.

Updating the site

Once you are happy with your changes, commit and push, then run

cd ~/src/docs
git commit -a
git push

If you want to be able to view your changes at $GITHUB_USER.github.io/docs, just run:

cd ~/src/docs
source .venv/bin/activate
mkdocs gh-deploy --clean

To get your changes pushed to the live site, just create a pull request, if you're unfamiliar with how to do that, GitHub has documentation.

Updating your fork

The first time you want to do it, you need to add a remote with

cd ~/src/docs
git remote add upstream git@github.com:peeringdb/docs.git

After that, to sync to the upstream repo and install requirements/updates

cd ~/src/docs
git fetch upstream
git merge upstream/master
source .venv/bin/activate
uv sync