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

[editorial] Move supplementary-guidelines to be under docs #1240

Closed
chalin opened this issue Jul 11, 2024 · 3 comments · Fixed by #1284
Closed

[editorial] Move supplementary-guidelines to be under docs #1240

chalin opened this issue Jul 11, 2024 · 3 comments · Fixed by #1284
Assignees

Comments

@chalin
Copy link
Contributor

chalin commented Jul 11, 2024

PR #1234 got me thinking:

  • Why not put supplementary-guidelines under docs?

If the content is non-normative, then the README of that section (and the README of docs) can just state that. By putting the section under docs, it conveniently gets published on the OTel website.

References:

Another thought: this move might be an opportunity to rename the section directory to non-normative-guidelines or just non-normative -- although you might also feel that the current name is fine.

@joaopgrassi
Copy link
Member

Why not put supplementary-guidelines under docs

Sounds like a good idea to me!

@chalin
Copy link
Contributor Author

chalin commented Jul 25, 2024

Why not put supplementary-guidelines under docs

Btw, this was actually one of the "other to-dos" from:

Sounds like a good idea to me!

Done, PTAL at:

@chalin
Copy link
Contributor Author

chalin commented Jul 25, 2024

/cc @jsuereth

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants