-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome to the documentation for the Evictorbook app! This Wiki includes the documentation on the app part of the Evictorbook.com project, responsible for fetching and serving landlord and property data in the web UI. See here for more background on the political purpose and history of the Evictorbook project.
Please see The Evictorbook Developer's Guide for an in-depth introduction to the project.
See also Evictorbook Community Agreements
IMPORTANT: We want all of the links and images on this Wiki to be relative links, both since we'll be migrating it to a different URL and so that nothing breaks when the open source community forks it. Here's how to do so.
Links: Links are fairly straightforward, here's an example: [another page in the wiki](setup#troubleshooting)
which renders in Markdown as another page in the wiki.
Images: Images take a bit more effort since they need to be hosted on the wiki. Here's how to do it:
- Clone the wiki locally with
git clone https://github.com/antievictionmappingproject/evictorbook-documentation.wiki.git
- Add images to the
/_images
folder in the local copy of the wiki repo. - Commit changes and push the commit with images to the master branch for the wiki.
- Add a link to an image like this:
<img src="_images/aemp_logo.png" width="200">
- Migrate the reference documents to the Wiki itself
Note: this documentation is a work in progress