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

Refactor Service File Generators for Better Maintainability #306

Open
ImmaZoni opened this issue Oct 31, 2023 · 0 comments
Open

Refactor Service File Generators for Better Maintainability #306

ImmaZoni opened this issue Oct 31, 2023 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@ImmaZoni
Copy link
Contributor

ImmaZoni commented Oct 31, 2023

Description:
The current implementation of both the Systemd Service File Generator and the Docker File Generator embeds their templates directly within the index.jsx of their respective components. This approach, while functional, poses challenges in maintaining and updating the templates.

Proposal:
To enhance maintainability and allow for easier updates, especially by non-developers, I recommend refactoring the components. We should externalize the templates into dedicated files, namely SystemdTemplate and DockerComposeTemplate.

Benefits:

  • Separation of Concerns: By decoupling the templates from the core logic, we reinforce the principle of separation of concerns.
  • Ease of Update: Non-technical contributors can easily view and modify the templates without the risk of inadvertently breaking the core functionality.
  • Enhanced Collaboration: This setup would foster a collaborative environment where users can contribute to the template's improvement without delving into the component logic.

I'm eager to gather feedback from the community on this suggestion. Your insights would be invaluable as we strive for continuous improvement! 😄


@ImmaZoni ImmaZoni added enhancement New feature or request good first issue Good for newcomers labels Oct 31, 2023
@ImmaZoni ImmaZoni changed the title Refactor SystemdServiceFileGenerator & DockerFileGenerator to pull from template files Refactor Service File Generators for Better Maintainability Oct 31, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant