Improvements to readme and contributing guides #9688
Replies: 2 comments 2 replies
-
|
I was trying to find which part of Appwrite PHP code controlled the function containers, so I could patch it for the functions to have access to a custom docker network and a custom docker volume. Other Appwrite parts are in the compose file, but the containers are imperatively created, so I wanted to find that and how to patch it, but never could. I ended creating a sidecar container to proxy requests, the function sends requests to that container which is in the Appwrite network and also in my custom network and then that permanent container makes what I wanted the function to do. |
Beta Was this translation helpful? Give feedback.
-
|
Thanks for this feedback! It sounds like we need to add more documentation about how functions works under the hood and, as part of that, point to various places in the code that do key things. Am I missing anything else? |
Beta Was this translation helpful? Give feedback.
-
|
Would be nice to also see "if you want to patch this, a good idea would be to edit here", and/or "edit here like this". Probably not inside the code, but maybe as a an auxiliary version of the code with comments or in the docs. Just thinking out loud, unsure how this would be in practice but would alleviate mental load in working with a completely new (to new contributors) codebase. |
Beta Was this translation helpful? Give feedback.
-
|
I think what's mostly missing is proper guides on how to develop/debug utopia things + appwrite |
Beta Was this translation helpful? Give feedback.
Uh oh!
There was an error while loading. Please reload this page.
-
Did you ever have any confusion or run into issues after going through any of our readmes or contributing guides? If so, please let us know as we want to update them to make it easy and clear for anyone to get started contributing to Appwrite 🙏🏼
Please make sure to mention:
Beta Was this translation helpful? Give feedback.
All reactions