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

Documentation for opentelemetry.io #405

Closed
Tracked by #833
bobstrecansky opened this issue Sep 1, 2021 · 7 comments
Closed
Tracked by #833

Documentation for opentelemetry.io #405

bobstrecansky opened this issue Sep 1, 2021 · 7 comments
Assignees
Labels
bite sized This is a small chunk of work (good for new or time limited contributors!) documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted This issue is looking for someone to work on it small small sized task

Comments

@bobstrecansky
Copy link
Collaborator

We'd like to add some documentation to the opentelemetry.io website.

the website_docs folder pushes all of its contents to https://opentelemetry.io/docs/php/

We should include our documentation in there in order to make it easier for end users to adopt our library.

@bobstrecansky bobstrecansky added bite sized This is a small chunk of work (good for new or time limited contributors!) documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted This issue is looking for someone to work on it release:required-for-beta small small sized task labels Sep 1, 2021
@chalin
Copy link
Contributor

chalin commented Sep 25, 2021

The docs might move: for details, see #423. /cc @austinlparker

@bobstrecansky
Copy link
Collaborator Author

Yes! I think we could use a lot more documentation. That documentation is built here:
https://github.com/open-telemetry/opentelemetry-php/blob/main/website_docs/getting-started.md
Our documentation is unorganized and not complete. Using other languages as a template would probably help a lot.

@chalin
Copy link
Contributor

chalin commented Feb 16, 2022

Yes! I think we could use a lot more documentation.

Great. It would help enormously if the PHP docs were in the website repo. Note that other SIGs have made the choice to move their docs to the website repo since we last exchanged on the topic in September, including:

@cartermp has been driving much of the documentation improvement efforts across languages, and it is much easier for him to do so when the docs are in the website repo before he starts reworking and enhancing the docs. Might you be willing to reconsider your decision for #423

/cc @austinlparker

@bobstrecansky
Copy link
Collaborator Author

@yuktea mentioned she would like to work on this.

@chalin
Copy link
Contributor

chalin commented Mar 4, 2022

Thanks @yuktea! Maybe the best would be to coordinate with @cartermp, who has a better idea of what work needs to be done, unless you (@bobstrecansky et all) have specific pages you'd like @yuktea to start working on?

@yuktea - by the way, the website/communications team meets every other week. For details, see our Meeting doc. Our next meeting is on March 10.

@yuktea
Copy link
Contributor

yuktea commented Mar 4, 2022

Thanks @yuktea! Maybe the best would be to coordinate with @cartermp, who has a better idea of what work needs to be done, unless you (@bobstrecansky et all) have specific pages you'd like @yuktea to start working on?

@yuktea - by the way, the website/communications team meets every other week. For details, see our Meeting doc. Our next meeting is on March 10.

Yes, I'll coordinate with them 👍

@tidal
Copy link
Member

tidal commented Jul 9, 2022

Closing this issue in favor of #758 , since the website docs are not maintained in this repo anymore.

@tidal tidal closed this as completed Jul 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bite sized This is a small chunk of work (good for new or time limited contributors!) documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers help wanted This issue is looking for someone to work on it small small sized task
Projects
None yet
Development

No branches or pull requests

4 participants