You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This issue covers the creation of a single location that contains a new-starter-friendly index of all primary documentation sources for all Adoptium projects.
Note: If this already exists, this issue will cover raising the visibility of it.
Details
MVP for this issue should include:
A starter's guide to adoptium, complete with key links to project area summaries.
This should be the entry point, with a pinned link in General.
If a general-purpose NSG already exists, we should summarise it and link to it.
Key links to include links to summaries for build, test, trss, pipeline, and website.
A complete index of existing documentation, grouped by category (build, test, etc).
The first point of expansion (after MVP creation) should be:
Something that draws the community's attention to any .md file created without an entry in the Index, to keep it from growing stale.
Notes
Braindump of crowdsourced ideas relevant to this topic:
That the location of this Index can also be used as a location for resources relevant to the documentation of multiple repositories.
E.g. Shared images.
Stretch goal concepts:
An FAQ with key terms for easy ctrl-f.
A chatbot that expands on the faq. Regexs? AI?
The text was updated successfully, but these errors were encountered:
adamfarley
changed the title
Enhancement Proposal: Create a Documentation Index for All Adoptium WG Projects
Enhancement Proposal: Create an Adoptium Documentation Index that covers all projects
Dec 20, 2023
Summary
This issue covers the creation of a single location that contains a new-starter-friendly index of all primary documentation sources for all Adoptium projects.
Note: If this already exists, this issue will cover raising the visibility of it.
Details
MVP for this issue should include:
The first point of expansion (after MVP creation) should be:
Notes
Braindump of crowdsourced ideas relevant to this topic:
The text was updated successfully, but these errors were encountered: