NLeSC / guide

Software Development Guide
https://guide.esciencecenter.nl
Creative Commons Attribution 4.0 International
47 stars 30 forks source link

reorganize chapters: add technology guides section #340

Closed egpbos closed 1 month ago

egpbos commented 1 month ago

Changes in this PR

This PR adds the new section of technology guides and moves the GPU and UX chapters there.

Also moved language guides to the root folder level, because I find it annoying to have to click into the best_practices folder.

Note: datasets still has to be moved to technologies, but there is an outstanding PR https://github.com/NLeSC/guide/pull/339 on that and I don't want to stress git's ability to detect moved files too much, otherwise we lose the ability to easily browse edit history.

Fixes #335.

bouweandela commented 1 month ago

@egpbos You've requested our review, but it is still in draft. Would you like me to review this now?

egpbos commented 1 month ago

Yes, you can review. The only thing that I still want to do before merging is move the dataset chapter as well, after #339 is merged, that's why it's still in draft.

egpbos commented 1 month ago

Good catch, updated the README.

I would suggest to consider the Best Practices in another thread, because I'm not sure if we should completely remove it.

egpbos commented 1 month ago

Ah, we had that other thread already :P #321

egpbos commented 1 month ago

Ok, I moved it down as you suggested after all. Otherwise the technology menu is too far down and it may not be noticed.

egpbos commented 1 month ago

Assuming @bouweandela is happy with the changes, since he suggested them ;) Merging!