Commit Graph

30 Commits (19082c3aa9a767a54e0adef2d4c510844701c4ee)

Author SHA1 Message Date
Jan Wille 19082c3aa9
TEMP: should the LICENCE only be a badge? 3 years ago
Jan Wille efadd32372
docs: add more badges
existing bades are moved to the top and more badges are added.
Additionaly, the bades are created using recplacement references which
allows to move all meta informations to the bottom of the file.

Badges provide quick and visual information about the projectstatus.
They are created using https://shields.io
3 years ago
Andrew Imeson e49a101160 Add rstcheck to CI to lint docs 3 years ago
Adrien Vergé a3fc64d134 End support for Python 2
As planned and advertized, yamllint drops support for Python 2 on 2021.
4 years ago
Per Lundberg 2103bd73de README.rst: fix typo 5 years ago
Adrien Vergé 1a13837e84 docs: Sunset Python 2
Keep supporting Python 2.7 for one extra year after upstream dropped it:
https://www.python.org/doc/sunset-python-2/
5 years ago
Adrien Vergé 930c8eea94 docs: Simplify installation instruction in the README 6 years ago
Mateusz Piotrowski 2a66ec2e5e Add FreeBSD installation instructions 6 years ago
Justin Foreman e4e99f0aba docs: Update README for CentOS dependency 7 years ago
Adrien Vergé 203cfc20f0 docs: Remove sudo from pip installation instructions 7 years ago
Adrien Vergé 51c30505b5 docs: Add Mac OS installation instructions
See https://github.com/adrienverge/yamllint/issues/91 and
https://github.com/Homebrew/homebrew-core/blob/af2bbe9/Formula/yamllint.rb
7 years ago
Adrien Vergé df26cc0438 feat(config): Add support to ignore paths on per-rule basis
Example of configuration to use this feature:

    # For all rules
    ignore: |
      *.dont-lint-me.yaml
      /bin/
      !/bin/*.lint-me-anyway.yaml

    rules:
      key-duplicates:
        ignore: |
          generated
          *.template.yaml
      trailing-spaces:
        ignore: |
          *.ignore-trailing-spaces.yaml
          /ascii-art/*

Closes #43.
8 years ago
Adrien Vergé 2b7f5c5e72 docs(install): Update Debian version
yamllint is now backported in Debian 8 (Jessie):
https://tracker.debian.org/pkg/yamllint
https://packages.debian.org/source/jessie-backports/yamllint
9 years ago
Adam Chainz d7c17c7e7c Doc: Convert readthedocs links from .org to .io
As per [their blog post of the 27th
April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing
subdomains’:

> Starting today, Read the Docs will start hosting projects from
> subdomains on the domain readthedocs.io, instead of on
> readthedocs.org. This change addresses some security concerns around
> site cookies while hosting user generated data on the same domain as
> our dashboard.

Test Plan: Manually visited all the links I’ve modified.
9 years ago
Adrien Vergé 09118e417c Doc: Add license information on README page 9 years ago
Adrien Vergé 71b90ae208 Doc: Add new features in README 9 years ago
Adrien Vergé 8844855353 Doc: Remove old Debian install commands from README 9 years ago
Adrien Vergé eabd349902 Config: Allow a user-global configuration file
Instead of just looking for `.yamllint` in the current working
directory, also look for `~/.config/yamllint/config` (using
`$XDG_CONFIG_HOME` or `$HOME`, see [1] and [2] for information).

[1]: https://specifications.freedesktop.org/basedir-spec/basedir-spec-0.6.html
[2]: https://wiki.archlinux.org/index.php/XDG_Base_Directory_support

Closes: #6
9 years ago
Adrien Vergé a483524b63 Doc: Update installing section
Packages are now also available in Debian and Ubuntu.
9 years ago
Adrien Vergé 41733fc7a5 Use '.yaml' extension as default, not '.yml'
As someone said [1] on the internet:

    Say ".yaml" not ".yml".
    This is not MS-DOS, and YML is a Yahoo XML dialect.

Similarly, we use '.json', not '.jsn'.

[1]: https://github.com/ceph/s3-tests/commit/e17c56a
9 years ago
Adrien Vergé 688858e639 Doc: Reference Fedora and Ubuntu packages 9 years ago
Adrien Vergé 7688567faa cli: Add the `-d` option to provide inline conf 9 years ago
Adrien Vergé 2f75e92a66 Doc: Add a configuration example in README 9 years ago
Adrien Vergé 0e04ee29e6 Doc: Update description 9 years ago
Adrien Vergé 376a6ed484 Doc: Enhance short description 9 years ago
Adrien Vergé 45538fb08a Doc: Explicit installation by adding `sudo` in README 9 years ago
Adrien Vergé 7983c66093 Doc: Clarify Python compatibility in README 9 years ago
Adrien Vergé fee72d484e Doc: Add a screenshot 9 years ago
Adrien Vergé 26b5364be4 Doc: Add Read The Docs status badge in README 9 years ago
Adrien Vergé 48589176c7 Doc: Convert README.md to README.rst 9 years ago