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

complete and test towards a guided deploy-success #1

Open
16 tasks
marc-portier opened this issue May 15, 2024 · 1 comment
Open
16 tasks

complete and test towards a guided deploy-success #1

marc-portier opened this issue May 15, 2024 · 1 comment
Assignees

Comments

@marc-portier
Copy link
Contributor

  • README.md needs to describe the clear path to deployed system that can be replayed by anyone (with acceptable prior knowledge) , steps in that scenario should include for completeness
    • checking dependencies (be them installed software or required resources)
    • git repo checkout
    • local .env customisation
    • launch the service (docker up)
    • connect to the admin UI
    • upload one or more of our exported vocab-configs
    • wait for data to poor in, showcase the search in admin UI for verification
    • define a widget and copy paste the html to embed
    • create a local static website to host that widget
    • test - showcase that widget in a browser
    • list and defer to available docs in the vocabserver** repos for more

Additionally:

  • scenario needs to be verified by somebody actually doing this on a clean system, assuring it is working

And to be clear, the setup should include

  • decent default settings for locations, logging, required resources
  • split between hidden admin UI and public service API
  • using the built packages at ghcr.io
@cedricdcc
Copy link
Collaborator

The whole setup of the docker images makes no sense since the packages made from the https://github.com/vlizBE/vocabserver-app do not contain the needed files for all the services to run.

If we want all this info about scenario's and what todo and how to setup an instance of the vocabserver-app. I suggest we do that in the vocabserver-app repo instead of here

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants