artefactual
Create Developer-targeted Documentation
It would be helpful for new developers and community contributors to have some documentation specific to how to set up your development environment and how to get started developing code for AtoM. I find it can be a bit difficult to get started writing code for AtoM if you're not a seasoned dev, I think having some of the setup documented would help reduce the barrier to entry to get community contributors on-board.
Some things I think would be useful for this documentation:
Specific setup instructions for your operating system (Linux/MacOS/Windows/WSL). I use WSL on Windows and could include specific setup instructions for this. A colleague I work with, @yenaing-oo, uses an ARM-based Mac and could include specific setup instructions for that architecture. How to debug the app in Docker depending on your IDE I use VS Code and could provide a launch config for this, for example Quick reference for project commands (like running php-cs-fixer, running the unit tests, running Webpack, etc.) Any extra scripts used to facilitate writing code, like this logging setup And a question open for discussion is, where should this documentation go? This documentation feels specific to this repository, so it could be stored somewhere here. For example, maybe a DEVELOPERS.md file would be appropriate.
Thanks for bringing this back to my attention, @melaniekung. I’ll be working with @danloveg to address this in the near future.
Another request (related to client project work) that ASI should consider:
Developer docs on how to pull updated translations from Weblate, for institutions with developers and/or system administrators who don't want to wait for the next official release to get updated translations
I have a PR open for one of the things on the list:
How to debug the app in Docker depending on your IDE. I use VS Code and could provide a launch config for this, for example
#328
