Skip to content

Update Developer Documentation #808

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Xaohs opened this issue Apr 1, 2025 · 1 comment · May be fixed by #813
Open

Update Developer Documentation #808

Xaohs opened this issue Apr 1, 2025 · 1 comment · May be fixed by #813
Assignees
Labels
discuss Further information is requested documentation Improvements or additions to documentation

Comments

@Xaohs
Copy link
Contributor

Xaohs commented Apr 1, 2025

I have walked through the setup of OAB as a developer from scratch on my (new Arch linux) machine. I have found some possible weaknesses in the developer docs that would be worth adding in (or I might have missed?). Here's my findings:

  • Development
    • GDAL is required, and without GDAL you will get an error describing this at the migrate step
    • After installing GDAL, you also need to install/enable postgis as an extension and/or the user that created the database needs to be superuser
    • I don't think anywhere there's specified that you can run cache_zaken to eventually have a "working" environment
    • Translations need to be run initially, this is not documented (src/manage.py compilemessages --locale nl)

@SilviaAmAm Let me know your opinion on which of these should be added to the docs (if any)

@Xaohs Xaohs added discuss Further information is requested documentation Improvements or additions to documentation labels Apr 1, 2025
@SilviaAmAm
Copy link
Collaborator

Yes please document these things! 🙏

@Xaohs Xaohs self-assigned this Apr 1, 2025
@Xaohs Xaohs linked a pull request Apr 2, 2025 that will close this issue
Xaohs added a commit that referenced this issue Apr 29, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss Further information is requested documentation Improvements or additions to documentation
Projects
Status: No status
Development

Successfully merging a pull request may close this issue.

2 participants