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

Documentation Updates #5

Open
chrisdoherty4 opened this issue Dec 24, 2022 · 3 comments
Open

Documentation Updates #5

chrisdoherty4 opened this issue Dec 24, 2022 · 3 comments
Assignees
Labels
status/accepted The scope and kind of work is agreed and the item accepted to the backlog

Comments

@chrisdoherty4
Copy link
Member

chrisdoherty4 commented Dec 24, 2022

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
Copy link
Member Author

@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
Copy link
Member Author

We postponed major further doc updates until the v1alpha2 API is fully implemented. See #14.

@chrisdoherty4
Copy link
Member Author

chrisdoherty4 commented Mar 15, 2024

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

@jacobweinstock jacobweinstock moved this from Accepted to In progress in Tinkerbell Roadmap Jul 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status/accepted The scope and kind of work is agreed and the item accepted to the backlog
Projects
Status: In progress
Development

No branches or pull requests

1 participant