kubernetes / website

Kubernetes website and documentation repo:
https://kubernetes.io
Creative Commons Attribution 4.0 International
4.6k stars 14.49k forks source link

Advice on technical writing style for Google Cloud #31615

Closed mafaulkner closed 2 years ago

mafaulkner commented 2 years ago

I'm editing a training course (Architecting Hybrid and Multi-Cloud Infrastructure with Anthos v2.0) that uses many GKE terms, but I can't find an authoritative source for issues like capitalization and initialisms. For example, I'm seeing "Multi-cluster Gateways (MCG)" and "Multi-cluster Services (MCS)."

Any information would be appreciated.

k8s-ci-robot commented 2 years ago

@mafaulkner: This issue is currently awaiting triage.

SIG Docs takes a lead on issue triage for this website, but any Kubernetes member can accept issues by applying the triage/accepted label.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.
jihoon-seo commented 2 years ago

You might have seen these already, but:

jatinTyagi98 commented 2 years ago

@mafaulkner can you elaborate what specifically is the yield. Are you looking for a format or some documents around the topics you mentioned ?

sftim commented 2 years ago

/kind support

/retitle Advice on technical writing style for Google Cloud

sftim commented 2 years ago

This is the Kubernetes project. Google Cloud documentation, and the related style guide, are not part of Kubernetes.

mafaulkner commented 2 years ago

Ji-hoon Seo's comment was helpful. We want to match the style of any product/service we're writing about. Thank you.