Skip to content

Commit

Permalink
[Docs] Add some additional documentation in preparation for RuboCop 1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
bbatsov committed Oct 19, 2020
1 parent 203d531 commit 9b8af4d
Show file tree
Hide file tree
Showing 6 changed files with 69 additions and 0 deletions.
6 changes: 6 additions & 0 deletions docs/modules/ROOT/nav.adoc
Expand Up @@ -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]
7 changes: 7 additions & 0 deletions 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].
13 changes: 13 additions & 0 deletions 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).
10 changes: 10 additions & 0 deletions 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.
7 changes: 7 additions & 0 deletions 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].
26 changes: 26 additions & 0 deletions 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]

0 comments on commit 9b8af4d

Please sign in to comment.