diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md deleted file mode 100644 index 35284f6770b..00000000000 --- a/.github/ISSUE_TEMPLATE/question.md +++ /dev/null @@ -1,9 +0,0 @@ ---- -name: Question -about: Request further information -title: '' -labels: 'question' -assignees: '' - ---- -## Question diff --git a/README.md b/README.md index 3c5a50c0dcc..23bb7889a30 100644 --- a/README.md +++ b/README.md @@ -144,7 +144,9 @@ file->import->gradle->existing gradle project ## Community -Join our [ slack channel](https://join.slack.com/t/deepjavalibrary/shared_invite/zt-ar91gjkz-qbXhr1l~LFGEIEeGBibT7w) to get in touch with the development team, for questions and discussions. +You can read our guide to [community forums, following DJL, issues, discussions, and RFCs](docs/forums.md) to figure out the best way to share and find content from the DJL community. + +Join our [ slack channel](http://tiny.cc/djl_slack) to get in touch with the development team, for questions and discussions. Follow our [ twitter](https://twitter.com/deepjavalibrary) to see updates about new content, features, and releases. diff --git a/docs/forums.md b/docs/forums.md new file mode 100644 index 00000000000..e3e6deed2c4 --- /dev/null +++ b/docs/forums.md @@ -0,0 +1,51 @@ +# Forums + +There are many forums where the DJL community interacts and ideas for DJL are discussed. Here are a list of the best ways to find what interests you in DJL: + +## Questions + +The best place to ask questions is on the [Discussions Q&A](https://github.com/awslabs/djl/discussions/categories/q-a). You can also join the [DJL Slack](http://tiny.cc/djl_slack) under the `#help` channel. + +## Ideas + +If you have an idea or a feature request for DJL, there are a few places you can share it. If it is an enhancement for DJL directly, you can open an [enhancement issue](https://github.com/awslabs/djl/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=). + +If you think that the issue requires some discussion to determine quite what to do, you may want to start a discussion before branching it out into an issue. The best places for those discussions are the [ideas forum](https://github.com/awslabs/djl/discussions/categories/ideas) if the issue might attract broader interest or the [development Forum](https://github.com/awslabs/djl/discussions/categories/development) to share it only with the more focused DJL API developers. + +Once you decide on a forum, there are two main formats your discussion might take. If you want to just raise a question, use the question as the name of your post and people can discuss the question. If you have a proposal and you are looking for input before you start making changes, you should frame it as a Request for Comments (RFC). The RFC doesn't have a template at this time, so just add `[RFC]` before your proposal title. + +Don't forget that DJL is a community project. If you have an idea, you are always welcome to implement it yourself! If you have any questions along the way or don't know how to get started, just ask for help in your issue and some friendly DJL developers will be happy to guide you on your way. + +## Bug Report + +Bugs happen. If you see something wrong with DJL or just aren't sure, you should open a [bug issue](https://github.com/awslabs/djl/issues/new?assignees=&labels=bug&template=bug_report.md&title=). Make sure to give us enough information to help figure out what is wrong and how to fix it. + +## Share projects, blog posts, talks, etc. + +If you have a cool project with DJL, wrote a blog post, or are giving a talk, we would love to hear about it! You should write a short post it on our [show-and-tell](https://github.com/awslabs/djl/discussions/categories/show-and-tell). If you mention us on [twitter](https://twitter.com/deepjavalibrary), we can also retweet it. Once we learn about it, we will also add it to our monthly news update as well. You can also use You can also join the [DJL Slack](http://tiny.cc/djl_slack) under the `#projects` channel. + +## Research + +If you like following the latest research and are looking for a place to discuss, check out our [deep learning discussions](https://github.com/awslabs/djl/discussions/categories/deep-learning). There, you can find other people interested in the theory of deep learning. You can also join the [DJL Slack](http://tiny.cc/djl_slack) under the `#deep-learning` channel. + +## Development + +If you want to talk about the development of DJL itself, look at our [development discussions](https://github.com/awslabs/djl/discussions/categories/development). You can also join the [DJL Slack](http://tiny.cc/djl_slack) under the `#development` channel. + +## Pull Request + +If you have an idea that you want to implement for changes to DJL, a bug fix, new datasets, new models, or anything else, open a new [pull request](https://github.com/awslabs/djl/compare). You can view this guide on [git and how to fork the project and make a pull request](https://guides.github.com/activities/forking/). We also have [documentation for contributors](development/README.md) that can help setup development, explain DJL coding conventions, working with DJL CI, and troubleshooting common problems. + +## Follow DJL + +To follow the latest updates and content in DJL, you can follow our [twitter](https://twitter.com/deepjavalibrary). It usually posts up to a few times a week. + +You can also find DJL updates in our monthly newsletter including all features, fixes, and community events. You can get the newsletter by joining our mailing list from the [DJL site](https://djl.ai/). We respect your email and will not overuse or share your emails with anyone. You will only receive one to two emails per month: the monthly newsletter and release announcements for new DJL releases. + +## 关注我们 + +[ 知乎专栏](https://zhuanlan.zhihu.com/c_1255493231133417472) 获取DJL最新的内容！ + +## General + +If you have read through these forums and nothing seems quite right, you can share it on [general discussions](https://github.com/awslabs/djl/discussions/categories/general). We try to keep our discussions organized so people can find what they are looking for. If you aren't sure about your choice of channel, don't worry about it and just use something that seems reasonable. You can also join the [DJL Slack](http://tiny.cc/djl_slack) under the `#random` channel. diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 9a0aba58f51..ea799a4cb2b 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -76,8 +76,8 @@ nav: - 'docs/development/inference_performance_optimization.md' - 'docs/development/benchmark_with_djl.md' - DJL Community: - - Overview: 'leaders.md' - - Development: 'https://github.com/awslabs/djl/discussions/categories/development' + - 'docs/forums.md' + - 'leaders.md' - Apache MXNet: - Overview: 'mxnet/README.md' - Import Gluon Model: 'docs/mxnet/how_to_convert_your_model_to_symbol.md' diff --git a/leaders.md b/leaders.md index ed2fd1fa23d..9813e07973d 100644 --- a/leaders.md +++ b/leaders.md @@ -1,7 +1,8 @@ # Community Leaders -DJL’s success is largely attributed to community contributions. -You can get involved and engage with us by joining our [Slack channel](deepjavalibrary.slack.com), [Wechat](https://zhuanlan.zhihu.com/p/336323550), or [Github](https://github.com/awslabs/djl) discussions. Kudos to our community leaders for helping evangelizing DJL and contributing to our Github! +DJL is a community project. It is led by AWS and the many other contributors from a variety of backgrounds, both corporate and academic, who bring their unique perspectives to help make DJL and the Java deep learning ecosystem the best it can be. To recognize the great people helping us build this community, we created the **DJL Community Leaders** to help steer the project. + +The community leaders are those who are the most active members of our community. They help give back to it by sharing projects, writing blog posts, giving talks, answering questions, contributing ideas, reviewing pull requests, and writing code in DJL. Like the project itself, the community leaders are a growing group and we are always looking to invite more people who show passion, dedication, and commitment to join. | | | | | | |-------|----------------|---------|------------| ----------- | @@ -40,11 +41,15 @@ Frank Liu is a Software Engineer for AWS Deep Learning. He focuses on building i Jake is one of core developers in the AWS DJL team. He graduated from CMU with MS degree in Software Engineering. He loves to learn things about Deep Learning in particular Deep Learning System. Outside of work, Jake enjoys watching movie, TV series, and anime. -#### Keerthan Vasist | [github](https://github.com/keerthanvasist) +#### Keerthan Vasist + +[github](https://github.com/keerthanvasist) Keerthan is a software engineer in AWS Deep Engines Org. His current work focuses on explainability and bias in machine learning. Outside of work, he enjoys playing Ultimate Frisbee, and badminton. -#### Kimi Ma | [github](https://github.com/kimim) +#### Kimi Ma + +[github](https://github.com/kimim) Kimi Ma is Industrial Internet director of Wanxiang Group, responsible for Wanxiang industrial digital platform development, business model innovation, and global partnerships. His primary interests in 2021 include energy internet, distributed intelligence and smart city. Before joining Wanxiang, Kimi was the R&D Manager of ABB control technology platform and Nokia Siemens Network. Meantime, he is a board member in the Alliance of Industrial Internet and contributes to Clojure DJL: [clj-djl](https://github.com/kimim/clj-djl).