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: standarizing docs defaults, since, etc #3898

Merged
merged 4 commits into from
Apr 2, 2023
Merged

docs: standarizing docs defaults, since, etc #3898

merged 4 commits into from
Apr 2, 2023

Conversation

caarlos0
Copy link
Member

@caarlos0 caarlos0 commented Mar 30, 2023 •
edited

  • if the default is the zero-value for the field, do not specify
    • TODO: add a "how to read this docs" section somewhere explaining that
  • if the change was introduced in a v1.x.0, say only v1.x
  • drop trail ending . from Since, Default, etc
  • wording: always use Default: instead of Defaults to and others
  • add a note to templateable fields
  • default value of a field, if its a string, always between single quotes '

@caarlos0
docs: standarizing docs defaults, since, etc
e4fbf81 
Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
@pull-request-size pull-request-size bot added the size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. label Mar 30, 2023
@cloudflare-pages
Copy link

cloudflare-pages bot commented Mar 30, 2023 •
edited

Deploying with  Cloudflare Pages  Cloudflare Pages

Latest commit: 6e41cb9
Status: ✅  Deploy successful!
Preview URL: https://29bfcb58.goreleaser.pages.dev
Branch Preview URL: https://docss.goreleaser.pages.dev

View logs

@caarlos0
docs: update
d29a4c1 
Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
@pull-request-size pull-request-size bot added size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. and removed size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. labels Mar 31, 2023
@caarlos0
docs: more fixes
e223a5a 
Signed-off-by: Carlos A Becker <caarlos0@users.noreply.github.com>
@caarlos0
Merge branch 'main' into docss
6e41cb9
@caarlos0 caarlos0 merged commit d524d93 into main Apr 2, 2023
@caarlos0 caarlos0 deleted the docss branch April 2, 2023 20:16
@github-actions github-actions bot added this to the v1.17.0 milestone Apr 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.
Projects
None yet
Milestone
v1.17.0
Development

Successfully merging this pull request may close these issues.

None yet
1 participant
@caarlos0