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 docs are starting with the archetype #1

Closed
wants to merge 2 commits into from

Conversation

ibacher
Copy link

@ibacher ibacher commented Feb 15, 2024

No description provided.

@ibacher
Copy link
Author

ibacher commented Feb 15, 2024

cc: @rbuisson

Copy link

@kazlaw kazlaw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ibacher the maven-archetype doesn't seem to be found when using the generate command. How should I set up my archetype repositories for it to be picked up?

docs/custom-implementation.md Outdated Show resolved Hide resolved

This will prompt you for several key variables for your implementation:

* **distributionName:** A user-friendly name for your distribution. For example, an Ozone implementation for the country of Gruzinia might use "Gruzinia" as the distribution name.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest that archetype doesn't add the Ozone word to the distribution name as below.

image

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is why I suggested using "Grunzinia" or, in this case, "Haiti". It seemed nicer to ask the user for the part that changes instead of requiring someone type "Ozone" everytime.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not always.

When distributions don't have a proper product name, yes we should put Ozone in front. When they do, then they should be able to not have to have Ozone.
KenyaHMIS distro for instance is named KenyaHMIS not Ozone KenyaHMIS.
But for Haiti, well, we don't have a good product name for it, so it's just Ozone Haiti

distributionName: A user-friendly name for your distribution. For example, an Ozone implementation for the country of Gruzinia might use "Ozone Gruzinia" as the distribution name.

@ibacher
Copy link
Author

ibacher commented Feb 27, 2024

How should I set up my archetype repositories for it to be picked up?

You need to have the standard OpenMRS Maven setup, so that the "archetype" server resolves to "https://mavenrepo.openmrs.org/public".

@rbuisson
Copy link
Contributor

Regarding this

You need to have the standard OpenMRS Maven setup, so that the "archetype" server resolves to "https://mavenrepo.openmrs.org/public".

@ibacher , could you add this to the doc itself, as well as a link to the OpenMRS documentation to set that up?

@rbuisson
Copy link
Contributor

rbuisson commented Mar 5, 2024

Thanks @ibacher . I've made another PR that I could easily amend, which largely reuses your instructions.
#4
Closing this one.

@rbuisson rbuisson closed this Mar 5, 2024
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.

3 participants