Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhancement Proposal: Create an Adoptium Documentation Index that covers all projects #253

Open
adamfarley opened this issue Dec 20, 2023 · 1 comment

Comments

@adamfarley
Copy link
Contributor

adamfarley commented 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:

  1. 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.
  1. A complete index of existing documentation, grouped by category (build, test, etc).

The first point of expansion (after MVP creation) should be:

  1. 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?
@adamfarley 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
@CarmenDelgadoEclipse
Copy link

Hello, there are some documentation avaiable:

Please do not forget to mention all the existing projects by adding a link to https://projects.eclipse.org/projects/adoptium or

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants