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

[DOCS] Documentation Request: How to Create Custom Microservices in Isle-dc #2354

Open
DonRichards opened this issue Dec 11, 2024 · 2 comments

Comments

@DonRichards
Copy link
Member

There does not appear to be an existing page on how to create custom microservices for dockerized version of Islandora in the current documentation. A new page will need to be created for this content.

  • If applicable, link to the documentation page relevant to your issue below.
    N/A

  • If this is a request for new documentation, where in the existing documentation does this documentation belong?
    This documentation would belong under the ISLE-dc Setup and Maintenance section or a new dedicated section for Custom Microservices.

  • Describe your documentation request.
    There is a need for detailed documentation on how to create custom microservices for Isle-dc. The requested documentation should include:

    • Prerequisites for development (tools, libraries, basic knowledge).
    • Steps for creating and configuring a new microservice.
    • How to setup and utilize the /etc/confd/templates/ file.
    • Integration with Isle-dc's Docker Compose setup.
    • Guidelines for testing and deploying the microservice.
    • Example configuration and templates for a basic custom service.
    • Troubleshooting tips and common issues.

The documentation should aim to empower developers to extend Isle-dc’s functionality, covering examples like creating alternatives or extensions to services like Cantaloupe (IIIF) or Crayfits (FITS).

  • Which version of Islandora are you using?
    Islandora 2.x with the latest ISLE-dc deployment.

  • What user roles is this documentation intended for?

  • Developers
  • Systems Administrators
  • What implementations of Islandora does this documentation request apply to?
    ISLE-dc deployments of Islandora.

Any related open or closed issues to this bug report?
N/A

Screenshots:
N/A

@DonRichards
Copy link
Member Author

Possibly an option but I think it would be nice to have a bare bones documentation. https://github.com/lehigh-university-libraries/scyllaridae

@joecorall
Copy link
Member

joecorall commented Dec 11, 2024

@DonRichards I will work on getting the documentation fleshed out. To date I've just been relying on examples and some admittedly crude steps in the READMEbut agree step by step would be useful 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