Skip to content

Editor pass - Update docs for deploying Fleet on Kubernetes#5719

Merged
noahtalerman merged 1 commit intomainfrom
Desmi-Dizney-patch-1
May 19, 2022
Merged

Editor pass - Update docs for deploying Fleet on Kubernetes#5719
noahtalerman merged 1 commit intomainfrom
Desmi-Dizney-patch-1

Conversation

@Desmi-Dizney
Copy link
Copy Markdown
Contributor

@Desmi-Dizney Desmi-Dizney requested a review from noahtalerman May 12, 2022 16:43
To deploy the Fleet server and connect to its dependencies(MySQL and Redis) we will set up a `deployment.yml` file with the following specifications:
To deploy the Fleet server and connect to its dependencies(MySQL and Redis), we will set up a `deployment.yml` file with the following specifications:

```yaml
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@noahtalerman, do we want to capitalize "yaml" and "fleet" in this section?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@Desmi-Dizney are you referring to yaml on line 429? If so, I think we do want to keep this lowercase.

We want to keep yaml lowercase because this is a keyword that GitHub uses to render the correct syntax highlighting.

@DominusKelvin do you know if there's a reason to keep fleet lowercase in the example deployment.yml file? Specifically on line 440, 444, and 447.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

@DominusKelvin, whenever you get a moment, let me know on this one.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@Desmi-Dizney @noahtalerman Just my two cents, but I think that since most of us are used to code being camelcase, it makes sense to stick with that in the code examples. If for no other reason than that fleet feels a lot more natural than Fleet in this context to type out and since it's happening multiple times there's a good chance an f would slip in there somewhere.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

And I'm sure I'm not the only one that avoids copy/paste from pretty much anywhere for blocks of code because VSC and invisible characters have burned me three too many times.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Makes sense! Thanks Kathy.

@noahtalerman noahtalerman merged commit 72d859b into main May 19, 2022
@noahtalerman noahtalerman deleted the Desmi-Dizney-patch-1 branch May 19, 2022 15:09
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