Constellation Dev Training Guide Updates

[Quasar985]

Prerequisites

• [ ] Put an X between the brackets on this line if you have done all of the following:

  • Running the latest version of Constellation

  • Attached the Support Package via Help > Support Package

  • Checked the FAQs: https://github.com/constellation-app/constellation/wiki/FAQ

  • Checked that your issue isn’t already filed: https://github.com/constellation-app/constellation/issues

  • Checked that there is not already a module that provides the described functionality: https://github.com/constellation-app/constellation/wiki/Catalogue-of-Repositories

Description

List of issues with the developer training guides from https://github.com/constellation-app/constellation/issues/1238 that I was unable to fix myself.

Chapter 5:

• Need to better explain GraphReadMethods/ReadableGraph vs GraphWriteMethods/WritableGraph, how they relate to locking and the importance of .release()/.commit().
• Need to better explain executeNow vs executeLater.
• Recommend making 'Spread Outbreak' a step-by-step tutorial and having students build a selection plugin as an exercise. - This one I was unsure if it'd been done already because I am not familiar with the code

Chapter 6:

• 6.1.2 > We should move all this to the toString() method of Outbreak.

Bugs: Setting Geo.Country to digraph should auto-complete to country Duplicate cities in training data are merged, we should add country as a primary key to avoid this

Documentation Additions: Chapter 4: Controller parameter behaviour (PluginParameterControllers) Chapter 5: Controlling merging behaviour (GraphElementMerger / GraphAttributeMerger) Chapter 8: Security & Proxy management Chapter 9: Graph Renderer Framework Chapter 9: Arrangement Framework

Other things that could be good to add: Rendering framework layer.xml Rest API Management of 3rd party libraries Adding application preference options

[github-actions[bot]]

Hello @Quasar985, thank you for your interest in our work! If you have a question about using Constellation then please have a read of our Quick Start Guide. If you are a developer then it is advised to go through the Developer Training Guide. Note: We have already migrated to NetBeans 12, however the examples in the training guide still reference NetBeans 8.2. We are working on a new version so just bear that in mind. PS: I'm just an automated script, not a human being.