Re-organize repo

CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [email protected]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,56 @@
+# How to contribute
+
+Polyaxon project would love to welcome your contributions. There are several ways to help out:
+
+* Create an [issue](https://github.com/polyaxon/polyaxon/issues) on GitHub, if you have found a bug
+* Write test cases for open bug issues
+* Write patches for open bug/feature issues, preferably with test cases included
+* Contribute to the documentation
+* Blog about different ways you are using Polyaxon
+
+There are a few guidelines that we need contributors to follow so that we have a chance of keeping on top of things.
+
+## Reporting issues
+
+Polyaxon has probably many issues and bugs, a great way to contribute to the project is to send a detailed report when you encounter an issue. We always appreciate a well-written, thorough bug report, and will thank you for it!
+
+Sometimes  Polyaxon is missing a feature you need, and we encourage our users to create and contribute such features.
+
+Check the current [issues](https://github.com/polyaxon/polyaxon/issues) if doesn't already include that problem or suggestion before submitting an issue.
+If you find a match, add a quick "+1", Doing this helps prioritize the most common problems and requests.
+
+When reporting issues, please include your host OS (Ubuntu 14.04, CentOS 7, etc), and the version of the libraries you are using.
+
+Please also include the steps required to reproduce the problem if possible and applicable. This information will help us review and fix your issue faster.
+
+## Contributing
+
+Before you contribute to Polyaxon, there are a few things that you'll need to do
+
+* Make sure you have a [GitHub account](https://github.com/signup/free).
+* Submit an [issue](https://github.com/polyaxon/polyaxon/issues), assuming one does not already exist.
+  * Clearly describe the issue including steps to reproduce when it is a bug.
+  * Make sure you fill in the earliest version that you know has the issue.
+* Fork the repository on GitHub.
+
+### Making Changes
+
+* Create a topic branch from where you want to base your work.
+  * This is usually the master branch.
+  * Only target an existing branch if you are certain your fix must be on that branch.
+  * To quickly create a topic branch based on master; `git checkout -b my_contribution origin/master`.
+    It is best to avoid working directly on the `master` branch. Doing so will help avoid conflicts if you pull in updates from origin.
+* Make commits of logical units. Implementing a new function and calling it in
+  another file constitute a single logical unit of work.
+  * A majority of submissions should have a single commit, so if in doubt, squash your commits down to one commit.
+* Use descriptive commit messages and reference the #issue number.
+* Core test cases should continue to pass. (Test are in progress)
+* Pull requests must be cleanly rebased on top of master without multiple branches mixed into the PR.
+
+### Which branch to base the work
+
+All changes should be be based on the latest master commit.
+
+## Questions
+
+If you need help with how to use this library, please check the list of examples, if it is still unclear you can also open an issue.

README.md

@@ -1,22 +1,28 @@
 [![License: Apache 2](https://img.shields.io/badge/License-apache2-green.svg)](LICENSE)
 [![Slack](https://img.shields.io/badge/chat-on%20slack-aadada.svg?logo=slack&longCache=true)](https://polyaxon.com/slack/)
 [![Docs](https://img.shields.io/badge/docs-stable-brightgreen.svg?style=flat)](https://polyaxon.com/docs/)
-[![GitHub](https://img.shields.io/badge/issue_tracker-github-blue?logo=github)](https://github.com/polyaxon/polyaxon/issues)
 [![GitHub](https://img.shields.io/badge/roadmap-github-blue?style=flat&logo=github&longCache=true)](https://github.com/orgs/polyaxon/projects/5)
 
-# polyaxon-examples
+# Community
 
-Code for polyaxon tutorials and examples.
+We're opening up this project as a place for our community users to interact with each other and Polyaxon' contributors.
+
+We are also using this project to submit FAQs that we answer multiple times on our slack channel.
+
+We've historically used Slack as the place to ask questions, and we would like to try a new experiment with discussion as the new default place to ask repeatable questions about how to use a specific feature.
 
-This is the code used for [latest version of Polyaxon](https://polyaxon.com/docs/intro/quick_start/)
+This repo also contains our examples as well as examples contributed from other users in the community.
 
+# polyaxon-examples
+
+Code for polyaxon tutorials and examples.
 
 This repository contains examples of using Polyaxon with all major Machine Learning and Deep Learning libraries, 
 including fastai, torch, sklearn, chainer, caffe, keras, tensorflow, mxnet, and Jupyter notebooks.
 
-If you don't see something you need, Don't hesitate to contact us.
+If you don't see something you need, Don't hesitate to open an issue, make a pull request, or contact us.
 
-## Examples Structure
+### Examples Structure
 
 This repository has 2 main directories containing examples for running experiments in-cluster, i.e. scheduled and managed by a Polyaxon Deployment, 
 as well as experiment running on different platforms and tracked by Polyaxon, i.e. experiments running on laptops, spark, other platforms.
@@ -31,7 +37,7 @@ If you are new to Polyaxon we recommend reading our [quick-start](https://polyax
 
 Please check our [documentation](https://polyaxon.com/docs/) to learn about how to deploy Polyaxon.
 
-All examples (in-cluster and on other examples running on other platforms) require our [client](https://github.com/polyaxon/polyaxon-client) to track and add instrumentation to the experiments.
+All examples (in-cluster and on other examples running on other platforms) require our library `pip instal polyaxon` to track and add instrumentation to the experiments.
 
 ### in-cluster Examples
 
@@ -40,3 +46,68 @@ In order to run these examples, you need to deploy a Polyaxon with a scheduling
 ### Tracking Examples
 
 These examples should can run outside of a Polyaxon cluster.
+
+# discussions, Q&A, Ideation, and feature requests
+
+The `discussions` tab is a place to answer frequently asked questions and to organize community users interaction.
+This is a great place to:
+
+- Ask questions about Polyaxon
+- Request features from our team
+- Share ideas and projects you are working on
+
+If you've found a bug, it is best to file an issue. If the issue is repeatable we will re-share it as an FAQ discussions.
+
+### Code of Conduct
+
+In addition to the [Code of Conduct](CODE_OF_CONDUCT.md) guide line, we have a couple of rules we would like you to follow:
+ * Be nice, always!
+ * Be respectful; we assume positive intent from you and we ask the same in return
+ * Avoid posting sensitive information
+ * Don’t abuse tagging other users
+ * Don’t advertise material unrelated to Polyaxon
+ * Explicit is better than implicit: be as precise as you can.
+ * It’s OK to disagree but disagree politely and constructively.
+    * Avoid absolutes: absolute statements do not provide room for a conversation to grow
+    * Never attack: being defensive about your own ideas, or running offense on another person’s ideas will always result in shutting down collaboration
+    * Stay humble: disagreements are learning opportunities
+ * Before creating a new topic, search if someone posted a similar issue before to avoid duplication.
+ * Each topic should be well-scoped (focused on one thing), non-duplicated and specific to problematic we are solving in one of our repos or with our solution.
+
+
+### Organizing FAQs and discussions
+
+ * Title: try to specify the problem rather than the feature or solution you tried.
+ * If you have multiple issues, please break them down to multiple discussions.
+ * Use labels to categorize the new discussion.
+ * Provide as much information as you can to help us identify the root cause of the issue:
+   * What environment are you using, e.g. Python version when for CLI/Library issues?
+   * What infrastructure are you using, e.g. an on-premise deployment, a specific cloud provider (AWS, GCP, Azure).
+   * What version are you using?
+   * Did you check the docs and search bar?
+   * Did you check the discussions and github search?
+   * Did you try upgrading before asking?
+   * If the issue is related to operations on k8s, can you please use the inpsection button and copy/paste the YAML results as an attachement (you can replace sensitive info with `xxx`).
+   * Can you share logs or code snippets that can make it easier to reproduce your issue?
+ * As a discussion creator, you will have a button that allows you to accept an answer. If some user responds to your question with a great answer, mark it as the accepted solution. Doing that helps others quickly navigate to the answer that helped you solve the problem.
+
+### Categories
+
+ * **Announcements**: a category for general-purpose category for announcing new releases and blog posts.
+ * **FAQ**: a category for frequently asked questions not strictly falling into any other mentioned category.
+ * **Q&A**: a category to ask for help.
+ * **General**: a category for discussing anything related to Polyaxon.
+ * **Show and tell**: a category for links to various resources that can help you get started and learn about Polyaxon as we as a place for sharing blog posts, walkthroughs, or simply sharing how to solve a specific problem.
+ * **Ideas**: a category to share ideas for new features.
+
+### Labels
+
+You can use labels to further categories new discussions, here are some helpful labels:
+ * experimenation: jobs, tracking, visualizations, dashboards, logs, cli
+ * automation: orchestrating, scheduling, hyperparameter tuning, DAGs, mapping, dependency management, events, actions, hooks, triggers, backfills
+ * termination: retries, restarts
+ * setup
+ * CI/CD 
+ * environments (development, staging, production, etc.)
+ * integrations
+ * ui