adoptium / documentation

The new documentation for adoptium.net will be initially created in this repo
Apache License 2.0
2 stars 10 forks source link

Document support for Icons (FontAwesome) #28

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 πŸ’

πŸ‘Ύ Description of the issue

It is really helpful to have a set of icons that can be used in documentation. AsciiDoc provides support for icons and this doc already uses some of them. We want to use vector based icons and not image / pixel based icons in our documentations. Therefore the support for font based icons in AsciiDoc sounds like a good idea. This is based on Font Awesome. We should provide a short documentation regarding the usage of such icons in the documentation. Next to this an information of the supported Font Awesome version would be good.

πŸ“‹ 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.

TSK2302 commented 2 years ago

@hendrikebbers can I work on this issue? Also, can you tell me what's expected of the documentation in terms of length and structure? Can this be considered as an example of what I'm expected to deliver in PDF/ HTML format?