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

/flux does not follow documentation style guide #1487

Open
dholbach opened this issue May 3, 2023 · 0 comments
Open

/flux does not follow documentation style guide #1487

dholbach opened this issue May 3, 2023 · 0 comments
Labels
area/docs Documentation related issues and pull requests

Comments

@dholbach
Copy link
Member

dholbach commented May 3, 2023

The documentation (https://fluxcd.io/flux/) does not follow the Documentation Style Guide at numerous instances. For example,

  • Reconciliation here being a new term that is introduced is not italicized (as per) .
  • The second point in the Deploy podinfo application talks about how the structure of fleet-infra repo be. It then proceeds to show the folder structure, without telling the user how to generate it, assuming a specific level of understanding.
@dholbach dholbach added the area/docs Documentation related issues and pull requests label May 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/docs Documentation related issues and pull requests
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@dholbach