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

Improve documentation #1863

Merged
merged 7 commits into from
Nov 4, 2024

Conversation

lumarel
Copy link
Contributor

@lumarel lumarel commented Oct 3, 2024

Hi there!
After the last code PR I thought it's time to take a day and try to improve the Forklift documentation 🙂
And this is the result from it.
This includes:

  • General formatting changes to get to a common standard between the individual files
  • Make some formatting compatible with mkdocs
  • Fix some broken links
  • Implement learnings and add new content

I have this changed version running here, if this makes checking it easier: https://gh.clmdn.eu/forklift/

If there is anything that needs further work I sure can do some more fixes!

Cheers, lumarel

- formatting
- make some formatting compatible with mkdocs
- broken links
- implement learnings and add new content
Copy link
Contributor

@ianballou ianballou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the improvements here, I speed-read the changes and things seem to look consistent, with updates focusing on formatting + modernizing versions and links (thanks especially for the new vagrant/hashicorp links!)

Since this is a widespread Forklift docs change we'll probably want an ack from @evgeni or @ekohl , but I haven't found anything off yet.

docs/troubleshooting.md Outdated Show resolved Hide resolved
docs/development.md Outdated Show resolved Hide resolved
Copy link
Contributor

@ianballou ianballou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking good, just one main comment:

docs/development.md Outdated Show resolved Hide resolved
docs/development.md Show resolved Hide resolved
@maximiliankolb
Copy link

cc @Thorben-D

Copy link
Contributor

@ianballou ianballou left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looking great to me, let me wait a little bit in case someone else wants to comment since it's a big change.

Copy link
Member

@ekohl ekohl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for taking this on. Some minor notes, but it largely looks good to me.

docs/vagrant.md Outdated Show resolved Hide resolved
docs/provision.md Outdated Show resolved Hide resolved
docs/provision.md Outdated Show resolved Hide resolved
@ianballou ianballou merged commit 5108816 into theforeman:master Nov 4, 2024
8 checks passed
@ianballou
Copy link
Contributor

Thanks @lumarel !

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

Successfully merging this pull request may close these issues.

5 participants