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

Wiki: Compile all documents related to setting up an internal WebApi #369

Open
kbekaert opened this issue Apr 30, 2024 · 6 comments
Open

Comments

@kbekaert
Copy link
Collaborator

Gather all documentation related to setting up an internal WebAPI in one place. In this way, it is easier to respond to the questions from institutes outside EU/ICES.

@ricardd
Copy link
Collaborator

ricardd commented May 2, 2024

@kbekaert I will loop in my favourite developers @stoyelq and @davjfish who were responsible for developing our DFO Dots application and its SmartDots WebAPI functionality, they will likely have some good ideas for this.

That being said, the existing SmartDots Web API – Technical documentation does contain all the necessary details,

I think what is needed is describing the types of systems that exist and that provide the WebAPI functionality (e.g. ICES system, DTU Dots, DFO Dots, ...). Something for an audience that is not as familiar with the technical details provided in the WebAPI documentation.

@kbekaert
Copy link
Collaborator Author

kbekaert commented May 2, 2024

@ricardd, Thanks for your comment. Yes I understood an additional document would be needed "for dummies". Would it be OK for you to initiate such a document? I think you understand best what piece of information was missing to have an easier start developing your own DFODots.

@ricardd
Copy link
Collaborator

ricardd commented May 2, 2024

@kbekaert I am happy to take a stab at this, I might just work off the Wiki.

@ricardd
Copy link
Collaborator

ricardd commented May 7, 2024

@kbekaert please see
https://github.com/ices-eg/SmartDots/wiki/Notes-and-documentation-to-implement-the-SmartDots-API

I will be gathering more ideas from our developers, and I think that others in WGSMART can improve the draft wiki entry above.

@ComeDenechaud ComeDenechaud moved this to Prioritization in WGSMART Jul 23, 2024
@ComeDenechaud
Copy link
Collaborator

Can be considered closed for now, the links and documents are in place and can be built upon as needed

@github-project-automation github-project-automation bot moved this from Prioritization to Done in WGSMART Jul 23, 2024
@kbekaert kbekaert reopened this Sep 5, 2024
@wimallegaert wimallegaert changed the title Compile all documents related to setting up an internal WebApi Wiki: Compile all documents related to setting up an internal WebApi Sep 5, 2024
@wimallegaert
Copy link
Contributor

TODO's:

  • Add page: How to setup SmartDots for internal use?
  • Cfr e-mail New Zealand: demo database + source code .NET Web API

@wimallegaert wimallegaert added this to the 2-day meeting 2024 milestone Sep 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Commited
Development

No branches or pull requests

4 participants