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

Split specification into one page per main section #145

Closed
chalin opened this issue May 26, 2023 · 2 comments
Closed

Split specification into one page per main section #145

chalin opened this issue May 26, 2023 · 2 comments

Comments

@chalin
Copy link
Contributor

chalin commented May 26, 2023

Might it make sense to break the single spec file into a directory with one file/page per spec section (maybe the FAQ and the "Future possibilites" can stay in the top-level README)? I'm asking the following question in the context of the following request:

That is, before we publish the spec to the OTel website for the first time, it might be good to consider its structure.

Possible sample structure:

/specification
|- README.md
|- communication-model.md
|- operation.md
...

/cc @svrnm @cartermp @tigrannajaryan

@tigrannajaryan
Copy link
Member

@chalin The one doc for the spec worked well so far for the workgroup. We also have one doc for OTLP and typically protocol RFCs also are one large doc. I suggest we keep it as is. Splitting would also require lots of link rewritting, I am not sure it is worth it.

@chalin
Copy link
Contributor Author

chalin commented May 26, 2023

👍

@chalin chalin closed this as completed May 26, 2023
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

No branches or pull requests

2 participants