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

fix: Updating docs for mkcert #832

Merged
merged 6 commits into from
Nov 27, 2024
Merged

fix: Updating docs for mkcert #832

merged 6 commits into from
Nov 27, 2024

Conversation

konstructcarrie
Copy link
Contributor

@konstructcarrie konstructcarrie commented Nov 26, 2024

Description

Adding mkcert details to install instructions for all clouds and updating current 2.7 version with these changes
Added these details for Azure for vNext
Fixes instances of kubefirst for capitalization (other branding updates)

Related Issue(s)

None found

How to test

Validate that content appears where expected before this step https://kubefirst.konstruct.io/docs/aws/quick-start/install/cli#create-your-new-kubefirst-cluster for each cloud

@fharper
Copy link
Contributor

fharper commented Nov 26, 2024

Since it's not in the commit message, for history, there is also a lot of correction of branding naming in this commit.

@konstructcarrie there is also the addition of Azure in 2.7, is it wanted also? Just want to be sure as this PR was just for mkcert from my understanding. If so you'll need to fix the 2.7 docs menu that point to Azure v.next, and it would be nice to also update this commit title to reflect all the changes once you squash this PR.

@konstructcarrie
Copy link
Contributor Author

Since it's not in the commit message, for history, there is also a lot of correction of branding naming in this commit.

@konstructcarrie there is also the addition of Azure in 2.7, is it wanted also? Just want to be sure as this PR was just for mkcert from my understanding. If so you'll need to fix the 2.7 docs menu that point to Azure v.next, and it would be nice to also update this commit title to reflect all the changes once you squash this PR.

I removed the Azure directory from the 2.7 version. I wasn't thinking about the fact that it was on hold until 2.8

fharper
fharper previously approved these changes Nov 26, 2024
@fharper fharper self-requested a review November 26, 2024 21:05
@fharper
Copy link
Contributor

fharper commented Nov 26, 2024

@konstructcarrie you also need to remove Azure references in the sidebar for 2.7

@konstructcarrie
Copy link
Contributor Author

@konstructcarrie you also need to remove Azure references in the sidebar for 2.7

Yeah I did that but there are also imports/references that I'm not sure how to remove that are killing the build.

@mrsimonemms
If you're able to help me sort that out ☝️ I can remove the Azure bits from this PR and we can chat about how you want to go about publishing that (given that it's available and we have no specific ETA on a 2.8 release). Let's catch up tomorrow :D

@fharper
Copy link
Contributor

fharper commented Nov 26, 2024

I can give a look tomorrow to fix the build if Simon doesn't have time, let me know.

Even if we release 2.8 tomorrow, Azure is now available in 2.7, so the docs should be in 2.7 also @mrsimonemms :)

@mrsimonemms
Copy link
Contributor

I've created a PR to add the fix into this PR - please take a look and see if you're happy adding into this PR.

Copy link
Contributor

@mrsimonemms mrsimonemms left a comment

Choose a reason for hiding this comment

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

Approved.

It might be worth making a common component that contains all the "we use mkcert" paragraph so that we only have to actually write it once. We can do this afterwards though

@konstructcarrie konstructcarrie merged commit 0894999 into main Nov 27, 2024
13 checks passed
@konstructcarrie konstructcarrie deleted the update-mkcert branch November 27, 2024 14:26
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.

3 participants