From 9b8af4db96e63f581b69ca2e9d7f9498b54c0864 Mon Sep 17 00:00:00 2001 From: Bozhidar Batsov Date: Mon, 19 Oct 2020 14:41:01 +0300 Subject: [PATCH] [Docs] Add some additional documentation in preparation for RuboCop 1.0 --- docs/modules/ROOT/nav.adoc | 6 +++++ docs/modules/ROOT/pages/about/changelog.adoc | 7 ++++++ docs/modules/ROOT/pages/about/history.adoc | 13 ++++++++++ docs/modules/ROOT/pages/about/license.adoc | 10 ++++++++ docs/modules/ROOT/pages/about/logo.adoc | 7 ++++++ docs/modules/ROOT/pages/about/team.adoc | 26 ++++++++++++++++++++ 6 files changed, 69 insertions(+) create mode 100644 docs/modules/ROOT/pages/about/changelog.adoc create mode 100644 docs/modules/ROOT/pages/about/history.adoc create mode 100644 docs/modules/ROOT/pages/about/license.adoc create mode 100644 docs/modules/ROOT/pages/about/logo.adoc create mode 100644 docs/modules/ROOT/pages/about/team.adoc diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc index 20b9e96683b..9841b96fe8b 100644 --- a/docs/modules/ROOT/nav.adoc +++ b/docs/modules/ROOT/nav.adoc @@ -26,3 +26,9 @@ * xref:contributing.adoc[Contributing] * xref:support.adoc[Support] * xref:versioning.adoc[Versioning] +* About +** xref:about/history.adoc[History] +** xref:about/team.adoc[Team] +** xref:about/changelog.adoc[Changelog] +** xref:about/logo.adoc[Logo] +** xref:about/license.adoc[License] diff --git a/docs/modules/ROOT/pages/about/changelog.adoc b/docs/modules/ROOT/pages/about/changelog.adoc new file mode 100644 index 00000000000..bac19429635 --- /dev/null +++ b/docs/modules/ROOT/pages/about/changelog.adoc @@ -0,0 +1,7 @@ += Changelog + +An extensive changelog is available https://github.com/rubocop-hq/rubocop/blob/master/CHANGELOG.md[here]. + +NOTE: Only user-visible changes are documented there. + +You can also peruse the release notes for individual release over at https://github.com/rubocop-hq/rubocop/releases[GitHub]. diff --git a/docs/modules/ROOT/pages/about/history.adoc b/docs/modules/ROOT/pages/about/history.adoc new file mode 100644 index 00000000000..5a7438eab6d --- /dev/null +++ b/docs/modules/ROOT/pages/about/history.adoc @@ -0,0 +1,13 @@ += History + +[quote] +You don't know where you're going until you know where you've been. + +RuboCop was created by Bozhidar Batsov in the spring of 2012, as an attempt +to make it easy to apply consistently the guidelines from the community Ruby Style Guide. + + +== Notable Milestones + +* 21 Apr 2012 - Initial commit by Bozhidar Batsov. +* 21 Oct 2020 - RuboCop 1.0 is released (exactly 7.5 years after the first commit). diff --git a/docs/modules/ROOT/pages/about/license.adoc b/docs/modules/ROOT/pages/about/license.adoc new file mode 100644 index 00000000000..1ff96db90a2 --- /dev/null +++ b/docs/modules/ROOT/pages/about/license.adoc @@ -0,0 +1,10 @@ += License & Copyright + +== License + +Use of RuboCop is granted under the terms of the MIT license. Check +out the `LICENSE.txt` file in RuboCop's code repository for more details. + +== Copyright + +Copyright (c) 2012-2020 Bozhidar Batsov and RuboCop contributors. diff --git a/docs/modules/ROOT/pages/about/logo.adoc b/docs/modules/ROOT/pages/about/logo.adoc new file mode 100644 index 00000000000..a389395285e --- /dev/null +++ b/docs/modules/ROOT/pages/about/logo.adoc @@ -0,0 +1,7 @@ += Logo + +RuboCop's logo was created by https://www.chadomoto.com/[Dimiter Petrov]. You can find the logo in various +formats https://github.com/rubocop-hq/rubocop/tree/master/logo[here]. + +The logo is licensed under a +http://creativecommons.org/licenses/by-nc/4.0/deed.en_GB[Creative Commons Attribution-NonCommercial 4.0 International License]. diff --git a/docs/modules/ROOT/pages/about/team.adoc b/docs/modules/ROOT/pages/about/team.adoc new file mode 100644 index 00000000000..795b6d7be71 --- /dev/null +++ b/docs/modules/ROOT/pages/about/team.adoc @@ -0,0 +1,26 @@ += Team + +== The Core Team + +The direction of the project and its official extensions is being +stewarded by the RuboCop core team. This group of long-term +contributors manages releases, evaluates pull-requests, and does a lot +of the groundwork on major new features. Here are the current members +of the RuboCop core team, listed in the order of joining it: + +* https://github.com/bbatsov[Bozhidar Batsov] (author & head maintainer) +* https://github.com/jonas054[Jonas Arvidsson] +* https://github.com/drenmi[Ted Johansson] +* https://github.com/pocke[Masataka Kuwabara] +* https://github.com/koic[Koichi Ito] (also head maintainer of RuboCop Rails, RuboCop Performance and RuboCop Minitest) +* https://github.com/darhazer[Maxim Krizhanovski] +* https://github.com/bquorning[Benjamin Quorning] (also head maintainer of RuboCop RSpec) +* https://github.com/marcandre[Marc-André Lafortune] (also head maintainer of RuboCop AST) + +== RuboCop Alumni + +In addition, we'd like to extend a special thanks the following retired RuboCop +core team members. Lovingly known as The Alumni: + +* https://github.com/yujinakayama[Yuji Nakayama] +* https://github.com/edzhelyov[Evgeni Dzhelyov]