adoptium / documentation-services

Apache License 2.0
6 stars 10 forks source link

Provide Factory for data model based on file system #22

Open hendrikebbers opened 2 years ago

hendrikebbers commented 2 years ago

🆕🐥 First Timers Only

This issue is reserved for people who never contributed to Open Source before. We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you 💝

🚨About the Eclipse Contributor Agreement (ECA)

Since Adoptium is a top level project of the Eclipse Foundation only people that have (digitally) signed the Eclipse Contributor Agreement (ECA) are allowed to contribute to Adoptium. This will automatically be checked in each pull request and pull requests from developers that have not signed the ECA can not be accepted. Luckily the workflow to digitally sign the ECA is very easy. All you need is an account at the Eclipse Foundation. Once you have an account you can easily sign the ECA here. It's important that the email address of the Eclipse account must fit to the email address that is used in the GitHub account and commits.

👾 Description of the issue

We have a basic data model in the net.adoptium.documentationservices.model package and need a managed factory (CDI bean) that creates such model instances based on a documentation on the file system. The documentation can be found in this repo and once this issue is done we have a clone of the repo on the local file system.

📋 Step by Step

To solve this issue and contribute a fix you should check the following step-by-step list. A more detailed documentation of the workflow can be found here.

🎉 Contribute to Hacktoberfest

Solve this issue as part of the Hacktoberfest event and get a change to receive cool goodies like a T-Shirt. 🎽

🤔❓ Questions

If you have any questions just ask us directly in this issue by adding a comment. You can join our community chat at Slack. Next to this you can find a general manual about open source contributions here.

Plexar commented 2 years ago

I´d like to work on this.

hendrikebbers commented 2 years ago

I assume that you need JAsciiDoctor functionality to get the title of a document. I created an initial service for AsciiDoctor at https://github.com/adoptium/documentation-services/pull/26. I assume it will be best to extend that service to receive the title of a document. The other needed attributes (language, id, ...) should be accessible without the use of JAsciiDoctor and should not be part of the AsciiDocService of my PR.