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

Define needed attributes for Asciidoc documents #7

Open hendrikebbers opened 3 years ago

hendrikebbers commented 3 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

Asciidoc supports attributes in documents. A document can contain predefined attributes or custom attributes.

We should define a list of attributes that should be specified in the document headers. A good starting point is the document metadata like the description that is be used to automatically generate HTML metadata. Next to the header attributes there will be some attributes that are the same for all documents (like copyright or orgname). Such attributes must be defined too since they will be set when rendering the documents.

📋 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.

MBoegers commented 2 years ago

I'll assemble a short list in the next days

MBoegers commented 2 years ago

PR #36 contains a first selection of document attributes. Next steps would be updating the present adoc files, but first let's agree about the attributes ;)