An assortment of documentation updates #251
Merged
+113
−111
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for tinkerbell ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
- Correct config.toml to new hugo.toml - Remove git submodule fetch, theme is in-sourced I've also made a note of the currently supported Hugo version, as Hugo did quite a few breaking changes recently, so the page doesn't build with the newest Hugo. I also removed the section about npm usage, as those commands did not work for me locally. Signed-off-by: Michael Meier <mmeier1986@gmail.com>
mmeier86
force-pushed
the
initial-cleanup
branch
from
a1d8536 to
c007bac
Compare
mmeier86
commented
Jun 19, 2025
| @@ -40,26 +35,6 @@ hugo server -D | |||
|
|
|||
| Site can be viewed at [http://localhost:1313](http://localhost:1313) | |||
|
|
|||
| ### Generate custom css files | |||
There was a problem hiding this comment.
@jacobweinstock Short question here, I'm not enough of a web dev to really make a judgement, but the npm commands here threw errors about there not being any watch or production scripts, and the website looks fine to me with just hugo server -D. Is the removal of this section okay?
There was a problem hiding this comment.
Yeah, I don't think we need this anymore. All good to remove. Thanks!
This commit updates the name of the metadata service from Hegel to Tootles. There is one reference to Hegel left, in the example output in the Getting Started page. This will be updated later when I had a chance to replay the Getting Started page and fetch fresh output. I updated all references to the old Hegel repo to the tootles/ directory in the tinkerbell/tinkerbell repo for now. In the next step, I will port the Hegel repo's README there. Signed-off-by: Michael Meier <mmeier1986@gmail.com>
The main part of this commit is changing all links to point to the consolidated tinkerbell/tinkerbell repository where components have been moved there. Where feasible, I introduced a "latestTinkerbellVersion" variable pointing to the GitHub tree of the 0.18.3 release, and then pointed all links to files into that tree. I changed the links to the individual repos on the homepage to point to their docs pages instead, as that seems more "representative" than a directory with source code in the consolidated repo. Signed-off-by: Michael Meier <mmeier1986@gmail.com>
mmeier86
commented
Jun 19, 2025
| @@ -5,7 +5,7 @@ image: "images/table-art.png" | |||
| hidden: true | |||
| --- | |||
|
|
|||
| Tinkerbell has a few core components: a DHCP server ([Smee](https://github.com/tinkerbell/smee)), a metadata service ([Hegel](https://github.com/tinkerbell/hegel)), an in-memory operating system installation environment ([HookOS](https://github.com/tinkerbell/hook)) and a workflow engine ([Tink Server/Worker](https://github.com/tinkerbell/tink)). | |||
| Tinkerbell has a few core components: a DHCP server ([Smee](/docs/services/smee/)), a metadata service ([Tootles](/docs/services/tootles/)), an in-memory operating system installation environment ([HookOS](/docs/additionalcomponents/hookos/)) and a workflow engine ([Tink Server](/docs/services/tink-server/)/[Tink Worker](/docs/services/tink-worker/)). | |||
There was a problem hiding this comment.
@jacobweinstock This change is worth pointing out. I considered just pointing to each component's directory in the consolidated repo, but that just didn't seem very "representative", because not all those directories have their own README files, so a user clicking the link on the homepage would just land in a directory with Go code.
I gave HookOS and the cluster API a similar treatment even though they still have their own repos, just for uniformity's sake.
There was a problem hiding this comment.
Yes, this is fine for now. Thanks!
I think it makes the most sense to just link to the in-repo contribution guidelines, instead of copy+pasting them here. I've made the link to the main branch, as contribution guidelines shouldn't be different per release. Signed-off-by: Michael Meier <mmeier1986@gmail.com>
Signed-off-by: Michael Meier <mmeier1986@gmail.com>
The cluster API docs are not complete at the moment, so redirecting users to the CAPI repo for now. Signed-off-by: Michael Meier <mmeier1986@gmail.com>
Until we get around to writing some more docs for HookOS, this link to the repo is better than a near-blank page. Signed-off-by: Michael Meier <mmeier1986@gmail.com>
For now, the Smee DHCP docs are a good-enough place to point readers interested in how iPXE is used by Tinkerbell. Signed-off-by: Michael Meier <mmeier1986@gmail.com>
Pointing to the GitHub discussions and issues until we get around to writing up a proper Troubleshooting page. Signed-off-by: Michael Meier <mmeier1986@gmail.com>
There's currently no content for Packer, and I couldn't find anything in any of the active repositories. So to not have a quasi-blank page, I've put it into draft state. Signed-off-by: Michael Meier <mmeier1986@gmail.com>
Similar to the Packer page, these docs are empty and I couldn't find a good doc to link to, so setting it to draft for now. Signed-off-by: Michael Meier <mmeier1986@gmail.com>
Signed-off-by: Michael Meier <mmeier1986@gmail.com>
Signed-off-by: Michael Meier <mmeier1986@gmail.com>
There were two variables used in the full template example which were not explained in the preceding text. Signed-off-by: Michael Meier <mmeier1986@gmail.com>
Signed-off-by: Michael Meier <mmeier1986@gmail.com>
The /faq/ link lead nowhere, so I instead mentioned the GH discussions. Signed-off-by: Michael Meier <mmeier1986@gmail.com>
|
@jacobweinstock I think that's it for the really low hanging fruit. I've jotted down some more tasks to be done, but will do them in subsequent pull requests. |
jacobweinstock
approved these changes
Jun 21, 2025
There was a problem hiding this comment.
Hey @mmeier86, thank you so much for this! It has been much needed.
|
You're welcome. I will prepare more updates during the next week. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR will contain a number of documentation updates and changes and is currently a work in progress.
Currently planned changes
Why is this needed
tinkerbell/tinkerbell#208
How Has This Been Tested?
Ran the local Hugo server with
hugo server -DHow are existing users impacted? What migration steps/scripts do we need?
Hopefully, none.
Checklist:
I have: