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

DOC: Rework documentation #11

Merged
merged 2 commits into from
Sep 15, 2023
Merged

DOC: Rework documentation #11

merged 2 commits into from
Sep 15, 2023

Conversation

DavidFair
Copy link
Collaborator

Clarifies multiple things based on feedback from someone else setting up:

  • Make it clear the readme in each level has the details
  • Actually make those readme files useful
  • ^ rework the capi-image-builders readme to be clearer and include setup
  • Add a link on to manually upload the resulting image
  • Add the PACKER_GH_API_TOKEN env var for rate limit problems

I've also renamed bin to scripts, as the automatic image uploader will end back up in scripts anyway

Clarifies multiple things based on feedback from someone else setting
up:

- Make it clear the readme in each level has the details
- Actually make those readme files useful
- ^ rework the capi-image-builders readme to be clearer and include
  setup
- Add a link on to manually upload the resulting image
- Add the PACKER_GH_API_TOKEN env var for rate limit problems
@DavidFair DavidFair added the documentation Improvements or additions to documentation label Sep 14, 2023
cluster-api/README.md Outdated Show resolved Hide resolved
Rework the doc comment from a non-code block with a comment to just
using regular brackets
@meoflynn meoflynn merged commit de61f54 into main Sep 15, 2023
7 checks passed
@DavidFair DavidFair deleted the Doc_tweaks_for_setup branch September 18, 2023 16:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants