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

Clean up and update docs folder #4082

Open
zhihali opened this issue Jul 25, 2024 · 0 comments
Open

Clean up and update docs folder #4082

zhihali opened this issue Jul 25, 2024 · 0 comments
Assignees
Labels
doc Documentation-related

Comments

@zhihali
Copy link
Contributor

zhihali commented Jul 25, 2024

We need to perform a comprehensive cleanup and update of the docs folder in our OpenTelemetry Python repository. This task was discussed in our recent SIG meeting(JUL 25), and it's crucial for maintaining the quality and relevance of our documentation.

Current situation:

  • Some documents in the docs folder are outdated
  • There's a mix of documents used in new documentation and legacy content
  • Some Python doc files are present and tested but not published(and looks will not publish anymore)
  • Potential inconsistencies between our repo docs and opentelemetry.io documentation

Proposed actions:

  1. Thoroughly review all documents in the docs folder
  2. Compare our repo docs with the opentelemetry.io documentation
  3. Identify and retain valuable, up-to-date content
  4. Remove outdated or unused documents
  5. Ensure all published Python doc files are relevant and current

Next steps:

  1. Categorize documents as:
    • Up-to-date and in use
    • Needs updating
    • Obsolete and can be removed
    • Unpublished but potentially useful
  2. Discuss findings in upcoming SIG meetings
  3. Create follow-up issues for specific cleanup tasks or updates

This cleanup will improve the maintainability of our documentation and ensure that users have access to current, relevant information.

Note: This may require multiple steps and discussions. Follow-up issues will be created as needed to address specific aspects of this cleanup process.

And I would love to implement these.🤓

/cc @emdneto @lzchen

@emdneto emdneto added the doc Documentation-related label Jul 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation-related
Projects
None yet
Development

No branches or pull requests

2 participants