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.

Sign up for GitHub

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

Jump to bottom

docs: bootstrap config reference #975

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: bootstrap config reference #975

wants to merge 2 commits into from
+5 −3

Conversation

eaudetcobello
Copy link
Contributor

  • Rename reference-bootstrap-config to example-bootstrap-config to reduce confusion
  • Change link format

@eaudetcobello eaudetcobello requested a review from a team as a code owner January 16, 2025 20:35
nhennigan
nhennigan reviewed Jan 16, 2025
View reviewed changes
Copy link
Contributor

@nhennigan nhennigan left a comment

Choose a reason for hiding this comment

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

The name change makes sense thanks for updating

docs/src/snap/reference/bootstrap-config-reference.md
@@ -15,9 +15,11 @@ by listing all available options and their details. See below for an example.
The following example configures and enables certain features, sets an external
cloud provider, marks the control plane nodes as unschedulable, changes the pod
and service CIDRs from the defaults and adds an extra SAN to the generated
certificates. It is also available to download
{download}`here </src/assets/reference-bootstrap-config.yaml>`
certificates. It is also available to download [here][example-config].
Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a reason you changed from download file to opening the link to the file here?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What do you mean?

Copy link
Contributor

Choose a reason for hiding this comment

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

The {download} directive downloads the file directly from that link. The change you made opens it in a browser. I was just wondering if you changed that on purpose for a reason?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

No, I didn't know about the download directive. Will restore.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nhennigan nhennigan nhennigan left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@eaudetcobello @nhennigan