OpenLiberty / OpenLiberty/guides-common
Need to ensure all guides properly recognize the Eclipse MicroProfile^TM
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 9
- Forks
- 6
- Avg merge
- 2h 12m
- Merged PRs (30d)
- 1
Description
@lauracowen just noticed that the sample UI was missing the initial reference to the Eclipse MicroProfile^TM trademark. This was documented in Issue #15.
A quick look shows that we have a similar issue across the MicroProfile guides that we recently created. This issue is getting created so that we can clean up all of the guides that are referencing MP features.
At a minimum, each guide should recognize the MP trademark by using the full name with the first usage -- Eclipse MicroProfile^TM. After that point, you can shorten it to just MicroProfile.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search the guide files for references to MicroProfile features, starting with the sample UI and the guides created recently. Update each guide so its first usage says “Eclipse MicroProfile^TM” and later usages may say “MicroProfile”; verify that all relevant guides follow this wording and review Issue #15 for context.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100