Skip to content

/flux does not follow documentation style guide #1487

Open
@dholbach

Description

@dholbach

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.

Activity

added
area/docsDocumentation related issues and pull requests
on May 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    area/docsDocumentation related issues and pull requests

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Development

      No branches or pull requests

        Participants

        @dholbach

        Issue actions

          /flux does not follow documentation style guide · Issue #1487 · fluxcd/website