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

Docs: Creation of OpenIM Community Documentation #666

Closed
cubxxw opened this issue Jul 26, 2023 — with Slack · 6 comments
Closed

Docs: Creation of OpenIM Community Documentation #666

cubxxw opened this issue Jul 26, 2023 — with Slack · 6 comments
Assignees
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.
Milestone

Comments

Copy link
Contributor

cubxxw commented Jul 26, 2023

Issue Overview

To assist others in quickly and comprehensively understanding OpenIM, we need to create a thorough community documentation. This documentation will provide essential information to novices, contributors, and collaborators, including but not limited to product features, project structure, contribution guidelines, and community code of conduct.

Related Tasks

  1. Refer to the structure and content of Kubernetes community documentation, and create the OpenIM community documentation based on this model.
  2. Use Hugo for web development and choose a suitable theme to optimize user experience.
  3. Ensure that the documentation structure is clear, the content comprehensive, and is easy to search and navigate.

Action Items

  1. Choose and set up a suitable Hugo theme.
  2. Create the basic structure of the documentation, including but not limited to the following sections: Introduction, Quick Start Guide, User Guide, API Documentation, Contribution Guide, Community Code of Conduct, Developer Guide, FAQ, Changelog, and Contact Information.
  3. Based on the Kubernetes community documentation, gradually fill in relevant content about OpenIM.
  4. Review and test the documentation to ensure all links and content are working properly.

Expected Outcome

Upon completion, we will have a complete, easy-to-understand OpenIM community documentation that can help users, contributors, and collaborators to quickly and comprehensively understand OpenIM.

Reference Resources

@cubxxw cubxxw added the good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. label Jul 26, 2023 — with Slack
@cubxxw cubxxw added this to the v3.1 milestone Jul 26, 2023 — with Slack
@kubbot
Copy link
Contributor

kubbot commented Jul 26, 2023

This issue is available for anyone to work on. Make sure to reference this issue in your pull request. ✨ Thank you for your contribution! ✨
Join slack 🤖 to connect and communicate with our developers.
If you wish to accept this assignment, please leave a comment in the comments section: /accept.🎯

@kubbot
Copy link
Contributor

kubbot commented Sep 25, 2023

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@cubxxw cubxxw modified the milestones: v3.1, v3.4 Sep 25, 2023
@cubxxw
Copy link
Contributor Author

cubxxw commented Sep 25, 2023

openim.io
https://github.com.openim/website
Link: #1103

@kubbot
Copy link
Contributor

kubbot commented Dec 5, 2023

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.

@kubbot
Copy link
Contributor

kubbot commented Mar 2, 2024

This issue was closed because it has been stalled for 7 days with no activity.

@kubbot kubbot closed this as not planned Won't fix, can't repro, duplicate, stale Mar 2, 2024
@cubxxw cubxxw reopened this Mar 2, 2024
@cubxxw cubxxw self-assigned this Mar 2, 2024
@kubbot
Copy link
Contributor

kubbot commented May 20, 2024

This issue is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 7 days.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines.
Projects
None yet
Development

No branches or pull requests

3 participants