improving docs

mlcommons · Aug 20, 2020 · cf97145 · cf97145
1 parent ba39bbc
commit cf97145
Show file tree

Hide file tree

Showing 4 changed files with 45 additions and 35 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -1,28 +1,6 @@
 # General guidelines
 
-Collective Knowledge framework (CK) uses standard 3-clause (new) BSD license. 
-Contributions are very welcome to improve the existing functionality 
-of the CK framework, CK modules, and CK components.
-
-You can easily contribute to CK and all related repositories by forking them 
-on GitHub and then submitting a pull request. We strongly suggest you 
-to discuss your PR with the community using the public CK google group:
-* https://groups.google.com/forum/#!forum/collective-knowledge
-
-Since most CK modules and components are reused in different projects, 
-please make sure that you thoroughly tested your contributions 
-and they are backward compatible!
-
-When sending PRs, please briefly explain why they are needed,
-how their work, and how you tested backward compatibility
-to make sure that dependent projects continue working correctly.
-
-Please submit bug reports, feedback, and ideas here:
-* https://github.com/ctuning/ck/issues
-
-*Note that we plan to rewrite CK and make it more pythonic and user-friendly
-when we have more resources! Feel free to [get in touch](https://cKnowledge.org/contacts.html)
-if you would like to know more about our future R&D plans.*
+Please see https://ck.readthedocs.io/en/latest/guide/how-to-contribute.html
 
 **Thank you very much for supporting this community project!**
 
@@ -31,7 +9,7 @@ if you would like to know more about our future R&D plans.*
 ```
 N: Grigori Fursin (alias: FGG)
 E: Grigori.Fursin@cTuning.org
-H: http://fursin.net
+H: https://fursin.net
 O: cTuning foundation, France
 C: original concept and prototyping, real-world use cases, development of https://cKnowledge.org and https://cKnowledge.io
 W: since Nov.1, 2014 

diff --git a/README.md b/README.md
@@ -68,11 +68,17 @@ CK supports the following platforms:
 | Windows       | ✓ | ✓ |
 | Android       | ± | ✓ |
 | iOS           | TBD | TBD |
+| Bare-metal (edge devices)   | - | ± |
 
 ## Documentation
 
-* [Online CK documentation](https://ck.readthedocs.io) 
+* [Online CK documentation (under construction)](https://ck.readthedocs.io) 
+* [Open CK portal with all CK components, workflows, and live dashboards](https://cKnowledge.io) 
 
 
 * [CK Basics](https://michel-steuwer.github.io/About-CK)
-* [Older Wiki](https://github.com/ctuning/ck/wiki)
+* [CK Wiki](https://github.com/ctuning/ck/wiki)
+
+## Author
+
+* [Grigori Fursin](https://cKnowledge.io/@gfursin) ([cTuning foundation](https://cTuning.org) and [cKnowledge SAS](https://www.linkedin.com/company/cknowledge))
diff --git a/docs/guide/how-to-contribute.md b/docs/guide/how-to-contribute.md
@@ -1,11 +1,31 @@
 # How to contribute
 
-* This is an ongoing community project and there is a lot to be improved - 
-  don't hesitate to [get in touch](https://cKnowledge.org/contacts.html)
-  using our slack, mailing list, twitter and email
-  if you have any feedback or would like to collaborate.
-
-* Check this [outdated guide](https://github.com/ctuning/ck/wiki) to add your workflows and components. 
-  We are gradually rewriting [this guide](https://cKnowledge.io/docs) with our limited resources
-  and developing [cBench](https://github.com/ctuning/cbench) to simplify
-  the user experience and provide a CK GUI at the [open cKnowledge.io platform](https://cKnowledge.io).
+Collective Knowledge framework (CK) uses standard 3-clause (new) BSD license. 
+Contributions are very welcome to improve the existing functionality 
+of the CK framework, CK modules, and CK components.
+
+You can easily contribute to CK and all related repositories by forking them 
+on GitHub and then submitting a pull request. We strongly suggest you 
+to discuss your PR with the community using the public CK google group:
+* https://groups.google.com/forum/#!forum/collective-knowledge
+
+Since most CK modules and components are reused in different projects, 
+please make sure that you thoroughly tested your contributions 
+and they are backward compatible!
+
+When sending PRs, please briefly explain why they are needed,
+how their work, and how you tested backward compatibility
+to make sure that dependent projects continue working correctly.
+
+Please submit bug reports, feedback, and ideas here:
+* https://github.com/ctuning/ck/issues
+
+Check this [outdated guide](https://github.com/ctuning/ck/wiki) to add your workflows and components. 
+We are gradually rewriting this guide and developing [cBench](https://github.com/ctuning/cbench) to simplify
+the user experience and provide a CK GUI at the [open cKnowledge.io platform](https://cKnowledge.io).
+
+*Note that we plan to rewrite CK and make it more pythonic and user-friendly
+when we have more resources! Feel free to [get in touch](https://cKnowledge.org/contacts.html)
+if you would like to know more about our future R&D plans.*
+
+**Thank you very much for supporting this community project!**
diff --git a/docs/intro/introduction.md b/docs/intro/introduction.md
@@ -107,3 +107,9 @@ Older wiki-based documentation (we gradually move it to the above Sphinx-based d
 * [CK basics](https://michel.steuwer.info/About-CK)
 * [CK Getting Started Guide](https://github.com/ctuning/ck/wiki/First-steps)
 * [Contributing to CK](https://github.com/ctuning/ck/wiki/Adding-new-workflows)
+
+
+
+## Author
+
+* [Grigori Fursin](https://cKnowledge.io/@gfursin) ([cTuning foundation](https://cTuning.org) and [cKnowledge SAS](https://www.linkedin.com/company/cknowledge))