search

tinkerbell / roadmap

Official Tinkerbell Roadmap
Apache License 2.0
7 stars 3 forks source link

Documentation Updates #5

Open chrisdoherty4 opened 1 year ago

chrisdoherty4 commented 1 year ago

Significant architectural changes have happened to Tinkerbell in the last 12 months; the documentation does not reflect these changes.

To minimize documentation effort we want the following:

  1. High level documentation that helps depict the Tinkerbell system should reside on the docs website.
  2. Known setups/working hardware/supported technologies should be documented on the website.
  3. Contributing, project structure and lower level architectural detail should exist in project repositories. We expect this kind of documentation to remain volatile for some time and its easier to keep it in lock-step with the code when it lives close to the code.

Project https://github.com/orgs/tinkerbell/projects/17

Related Document how to run Tinkerbell in production Add documentation for passing cloud-init metadata Hardware Documentation - customising hardware spec

chrisdoherty4 commented 1 year ago

@jacobweinstock @displague Where are the DNS records for the Tinkerbell site and how is it hosted?

I'm humoring proposing a merger of the https://github.com/tinkerbell/tinkerbell.org and https://github.com/tinkerbell/tinkerbell-docs repositories.

chrisdoherty4 commented 7 months ago

We postponed major further doc updates until the v1alpha2 API is fully implemented. See https://github.com/tinkerbell/roadmap/issues/14.

chrisdoherty4 commented 3 months ago

@jacobweinstock Has consolidated documentation under https://github.com/tinkerbell/tinkerbell.org.