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

Document GraphConfig JSON more clearly #385

Open
GCHQDeveloper314 opened this issue Sep 14, 2023 · 1 comment
Open

Document GraphConfig JSON more clearly #385

GCHQDeveloper314 opened this issue Sep 14, 2023 · 1 comment
Labels
enhancement Improvement to an existing part of the documentation
Milestone

Comments

@GCHQDeveloper314
Copy link
Member

Currently the only direct mention of the GraphConfig JSON file is a brief section in the dev docs.

The graphConfig JSON file is important when deploying Gaffer graphs using the REST API (the usual means of deployment). As such, it should be documented in further detail to ensure that it's clear how this config file is used.

In the development guide, a full explanation of the GraphConfig Java object is given, but there's only a quick mention of the JSON version of this. A section should be added to the administration guide setting out the options for configuring a graphConfig.json file - this could link to the development page for further details.

@GCHQDeveloper314 GCHQDeveloper314 added the enhancement Improvement to an existing part of the documentation label Sep 14, 2023
@GCHQDeveloper314 GCHQDeveloper314 added this to the v2.0.0 milestone Sep 14, 2023
@GCHQDeveloper314
Copy link
Member Author

GCHQDeveloper314 commented Oct 13, 2023

It might be better if some of the details related to this on the Graph component dev docs page were simply moved to the admin guide.

@GCHQDeveloper314 GCHQDeveloper314 modified the milestones: v2.0.0, v2.1.0 Nov 30, 2023
@GCHQDeveloper314 GCHQDeveloper314 modified the milestones: v2.1.0, Backlog Apr 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improvement to an existing part of the documentation
Projects
None yet
Development

No branches or pull requests

1 participant