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.

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

Add style guide and basic contribution section #3651

Merged
merged 74 commits into from
Jan 11, 2024
Merged

Conversation

theletterf
Copy link
Member

@theletterf theletterf commented Dec 5, 2023

@theletterf theletterf requested a review from a team December 5, 2023 12:22
@theletterf theletterf self-assigned this Dec 5, 2023
@theletterf theletterf added the enhancement New feature or request label Dec 5, 2023
@theletterf theletterf marked this pull request as draft December 5, 2023 12:22
Copy link
Contributor

@hdost hdost left a comment

Choose a reason for hiding this comment

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

I know it's only in draft but left some comments to call out a couple ideas.

Thank you for taking this on!

content/en/docs/Contribute/style-guide.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/style-guide.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/style-guide.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/style-guide.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/style-guide.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/style-guide.md Outdated Show resolved Hide resolved
@svrnm
Copy link
Member

svrnm commented Dec 6, 2023

I know it's only in draft but left some comments to call out a couple ideas.

Thank you for engaging in this conversation!

Also, to have this here, copying @chalin's comment (open-telemetry/community#1828 (comment)):

There is a /site section that I created. For now, it contains site-build info, but I've been wanting to use it to host our "site docs". The style guide would fit under there. Just an idea.

@svrnm
Copy link
Member

svrnm commented Dec 6, 2023

Initial structure and a good chunk of the style guide are taken from the Kubernetes docs site, with adaptations.

So, the structure works for me, although I am not 100% sure about the content of each page:

  • We have some content in CONTRIBUTING.md already, so this would need to be migrated as well then and then reduced to something similar to this: https://github.com/kubernetes/website/blob/main/CONTRIBUTING.md
  • Some of those pages are fairly extensive already, so we need to go through them 1:1 and decide what we want to carry over and what we want to change, or what we don't want to have (e.g. we have no localization yet, so we need to phrase this differently)
  • Especially for the style guide, I would prefer to make this page referencing the K8s documentation and then we add everything that is OTel specific

@chalin
Copy link
Contributor

chalin commented Dec 6, 2023

I strongly second what @svrnm has shared (in the previous comment #3651 (comment)).

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Btw, you can probably just replace the mermaid shortcodes by plain fenced code blocks:

```mermaid
...
```

@theletterf
Copy link
Member Author

@chalin Thanks! I'm open to moving the guide, etc. to /site, though right now it doesn't have a menu item. Also, it wouldn't be visible from the docs (unlike K8s), and semantically speaking it seems more concerned with technical aspects than a /docs/contribute directory.

@theletterf theletterf marked this pull request as ready for review December 12, 2023 09:06
@theletterf
Copy link
Member Author

@svrnm Applied most changes and fixed linter issues. This should now serve as a base for further changes.

Copy link
Member

@svrnm svrnm left a comment

Choose a reason for hiding this comment

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

Thank you for the time and effort to write this down @theletterf , here are some suggestions

content/en/docs/Contribute/_index.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/_index.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/_index.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/_index.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/_index.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/_index.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/_index.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/blogs-case-studies.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/style-guide.md Outdated Show resolved Hide resolved
content/en/docs/Contribute/style-guide.md Outdated Show resolved Hide resolved
theletterf and others added 3 commits December 13, 2023 11:02
Co-authored-by: Severin Neumann <neumanns@cisco.com>
Co-authored-by: Severin Neumann <neumanns@cisco.com>
Co-authored-by: Severin Neumann <neumanns@cisco.com>
@theletterf
Copy link
Member Author

Thanks @chalin! I hope we're not letting through anything egregious, copy wise — we've undergone several review rounds already. Fully agree on iterating afterwards.

Re: contribution-guidelines.md, I've chosen to keep it there, as it's not visible in the ToC anyway. I've made some edits to add a link to the new contribution section. What's the purpose of this hidden doc, if I may ask?

On gerunds in headings and such, this PR already aims to apply Google Style Guide's guidance. It's slightly different for file names and directories though, so I've renamed the main folder.

Note: The concurrent mode for link checking is working well!

@theletterf theletterf requested a review from chalin January 10, 2024 09:48
@chalin
Copy link
Contributor

chalin commented Jan 10, 2024

Re: contribution-guidelines.md, I've chosen to keep it there, as it's not visible in the ToC anyway. I've made some edits to add a link to the new contribution section. What's the purpose of this hidden doc, if I may ask?

That page was created way-back because Docsy requires that file to exist if we use it's default community page content. IIRC, we didn't want to have to fuss with the file, given that #897 had been filed, and so we chose to simply not show it in the left nav.

My preference would be that you remove that file (and ensure that the content is covered elsewhere), though we can do that later if y'all prefer.

There are a few of my originally suggested changes that remain to be done:

image

Note: The concurrent mode for link checking is working well!

Yes, I'm so glad it works so well 😄

@theletterf
Copy link
Member Author

@chalin Thanks! Comments addressed. Let's remove that file in a later update.

@theletterf
Copy link
Member Author

theletterf commented Jan 11, 2024

@svrnm There seem to be an error with links in main related to some spec links. This wasn't in my branch.

Edit: Updated main now and the error disappeared. Thanks!

Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

@chalin Thanks! Comments addressed.

Thanks for following through with those suggested updates.

Let's remove that file in a later update.

Ok, in that case:

You'll need to rebase and push (I can't from the web UI):

image

Comment on lines +22 to +32
<!-- prettier-ignore-start -->
| Term | Usage |
| --- | --- |
| OpenTelemetry | OpenTelemetry should always be capitalized. Don't use Open-Telemetry. |
| OTel | OTel is the accepted short form of OpenTelemetry. Don't use OTEL. |
| Collector | When referring to the OpenTelemetry Collector, always capitalize Collector. |
| Repository | Code repository, lowercase when in the middle of a sentence. Don't use "repo" or "repos". |
| OTEP | OpenTelemetry Enhancement Proposal. Write "OTEPs" as plural form. Don't write "OTep" or "otep". |
| OpAMP | Open Agent Management Protocol. Don't write "OPAMP" or "opamp" in descriptions or instructions. |
| OTLP | OpenTelemetry Protocol. Don't write "OTlP" or "otlp" in descriptions or instructions. |
<!-- prettier-ignore-end -->
Copy link
Contributor

Choose a reason for hiding this comment

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

A comment for later: I don't think that we should duplicate here in the form of a table any checks that the tools do. IMHO, we should just mention the tools and how to invoke them so that contributors know if they're using the proper spelling and capitalization.

Copy link
Member Author

@theletterf theletterf Jan 11, 2024

Choose a reason for hiding this comment

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

I think there's a strong educational value in having our terminology presented as reference. This is not too different from what style guides do with their wordlists:

Having a place that explains, for humans, what the proper capitalization or spelling is for OTel terminology also has the potential of ending discussions and preventing headaches during editing.

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for the links. I agree that it can make sense for both the terms OpenTelemetry and OTel, but not e.g. for Repository or simple cases of all caps for acronyms. But we can discuss these finer points later.

Also, if we can automate the creation of such a table somehow, that would satisfy my need to keep things DRY.

Copy link
Member Author

@theletterf theletterf Jan 11, 2024

Choose a reason for hiding this comment

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

Agree on the generic terminology! Automation would be great, too.

In general, while deeply imperfect, I see this initial PR as the foundation for deeper discussions around our contribution guidelines and style. We'll get to a great point soon, I'm sure!

Copy link
Member Author

Choose a reason for hiding this comment

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

See #3846

@theletterf theletterf requested a review from a team January 11, 2024 13:02
@theletterf
Copy link
Member Author

@chalin

@theletterf theletterf requested a review from chalin January 11, 2024 13:15
Copy link
Contributor

@chalin chalin left a comment

Choose a reason for hiding this comment

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

Stellar! 🚀

CONTRIBUTING.md Outdated Show resolved Hide resolved
@theletterf
Copy link
Member Author

@svrnm Seems like we can go live! :)

@svrnm svrnm merged commit 243aa95 into main Jan 11, 2024
16 checks passed
@svrnm svrnm deleted the theletterf-add-style-guide branch January 11, 2024 15:54
@svrnm
Copy link
Member

svrnm commented Jan 11, 2024

🎉 https://opentelemetry.io/docs/contributing/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
6 participants