Skip to content
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

Create a tips, tools and tactics guide for coders #733

Open
NateWr opened this issue Apr 21, 2021 · 2 comments
Open

Create a tips, tools and tactics guide for coders #733

NateWr opened this issue Apr 21, 2021 · 2 comments
Labels
dev-docs For developer documentation

Comments

@NateWr
Copy link
Contributor

NateWr commented Apr 21, 2021

This guide could provide a bunch of different advice/tools for working with the code. Some ideas:

@NateWr NateWr added the dev-docs For developer documentation label Apr 21, 2021
@jonasraoni
Copy link
Contributor

As a new developer landing in the sea of unknown code, what I always miss is:

  • Understanding how the software works (https://wiki.osgeo.org/wiki/File:Ojs_workflow.png)
  • How to build a simple form to save/load data (covering routes, ways to save data, if I can create new tables/fields, permissions, etc.)
  • Small and concise text + hands-on examples are a great way to learn (the best documentation I've seen so far was the one from Vue.js).

@marcbria
Copy link
Contributor

marcbria commented Apr 21, 2021

Soooo long ago we made a version of this diagram that IMHO is as detailed but more clear than the original one.
https://revistes.uab.cat/web/sites/default/files/documents/workflowojs-v04.svg

Some time after (but still far away) we did a simplified version to explain OMP that could also be adapted:
https://revistes.uab.cat/web/sites/default/files/documents/all-v3.png

Jumping to a different topic... as an old sysadmin I'm used to track errors in the sever side, but in different posts Nate made us notice this is going to change. More and more logic is in the front end so would be great if a video about "how to debug" in the front end is recorded.

I'm not thinking only in coders... it will be useful for sysadmins and even final users that need to track an issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dev-docs For developer documentation
Projects
None yet
Development

No branches or pull requests

3 participants