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

Add Codespaces as an alternative to install/use Annif #27

Merged
merged 22 commits into from
May 30, 2024
Merged

Conversation

juhoinkinen
Copy link
Member

No description provided.

@osma
Copy link
Member

osma commented May 29, 2024

Some questions for the documentation:

  • do you have to shut down the instance when you don't need it? how?
  • is the data persistent? (I think so)
  • how can I access it again afterwards, for example the following day?
  • how do I edit projects.cfg under Codespaces?
  • any special instructions for e.g. annif run command?

@juhoinkinen
Copy link
Member Author

juhoinkinen commented May 29, 2024

Some questions for the documentation:

  • do you have to shut down the instance when you don't need it? how?

No, the documentation says it is not necessary to stop an instance, it happens automatically: "If you do not explicitly stop a codespace, it will continue to run until it times out from inactivity. Closing a codespace does not stop the codespace."

  • is the data persistent? (I think so)

From the same docs: "When you stop a codespace, any running processes are stopped. Any saved changes in your codespace will still be available when you next start it. The terminal history is preserved, but the visible contents of the terminal window are not preserved between codespace sessions."

  • how can I access it again afterwards, for example the following day?
  1. The codespaces of Annif-tutorial owned by your GH account can be seen from here.
  2. Click the codespace you want to resume working on, and you should see your terminal as it was before.
  • how do I edit projects.cfg under Codespaces?

There is at least nano editor available for terminal use, or the Codespace editor can be used.

  • any special instructions for e.g. annif run command?

TODO.

@juhoinkinen
Copy link
Member Author

juhoinkinen commented May 29, 2024

However there is a problem in the setup of the environment: Annif and its dependencies etc. are meant to be installed when the instance starts by using postCreateCommand or postStartupCommand in devcontainer.json, but sometimes it does not happen. Looks like this issue.

Maybe only on the first startup after some changes the installation really occurs...

I try if using Annif-tutorial Dockerimage in the devcontainer.json works better.

Edit: Seems to be working better. TODO: Adjust installation instructions for this.

@juhoinkinen
Copy link
Member Author

We'll try this out with @reetagithub.

@juhoinkinen juhoinkinen marked this pull request as ready for review May 30, 2024 06:57
@juhoinkinen juhoinkinen merged commit d502986 into master May 30, 2024
1 check passed
@juhoinkinen juhoinkinen deleted the codespaces branch May 30, 2024 10:48
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

Successfully merging this pull request may close these issues.

2 participants