https://department-of-veterans-affairs.github.io/ves-event-bus-developer-portal/
This is the public-facing developer portal for all things Enterprise Event Bus. The Event Bus is in production and fairly stable, but the content in this repository will be updated regularly to keep information current.
See something you think can be improved? We welcome collaboration on the Event Bus Portal. Feel free to file an issue, or follow the local development steps below and then submit a pull request.
The product documentation made available lives in the /docs directory of this repo. Documentation source files are written in Markdown and then rendered in HTML using MkDocs and MkDocs Material, based on settings in mkdocs.yml.
Rendered documentation is viewable at https://department-of-veterans-affairs.github.io/ves-event-bus-developer-portal/.
This project requires Python 3.x. For Mac users, Python can be installed using homebrew with:
brew install python3
Python will require using a virtual environment. Set up the virtual environment at any path you like. ./venv is used here.
python3 -m venv venv
source venv/bin/activate
The source command will activate and start your virtual environment. In order to quickly iterate while working on documentation, install the following:
pip3 install --only-binary=:all: -r requirements-lock.txt
mkdocs may need to be added to PATH.
Changes to documentation can be viewed by running mkdocs serve in your terminal, from the root of this repository. The portal will be served at http://127.0.0.1:8000/.
When finished with local development, exit the Python virtual environment by running deactivate.
Need help with something? Feel free to file an issue.