Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Minor fixes on documentation pages #1719

Merged
merged 3 commits into from Sep 7, 2021
Merged

Minor fixes on documentation pages #1719

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6d4b90e
Fix typo on env var name GITHUB_WORKFLOW
pabluk Sep 7, 2021
240adf5
Fix minor typo on usage.rst
pabluk Sep 7, 2021
e12616e
Update pipx project's URL
pabluk Sep 7, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/installing.rst
View file
Open in desktop
Expand Up @@ -58,7 +58,7 @@ using ``--user`` or fixing potential conflicts if not using virtualenvs.

.. _installing_from_source:
.. _pip3: https://pypi.org/project/pip/
.. _pipx: https://pipxproject.github.io/pipx/
.. _pipx: https://pypa.github.io/pipx/

From Source
-----------
Expand Down
4 changes: 2 additions & 2 deletions docs/usage.rst
View file
Open in desktop
Expand Up @@ -30,7 +30,7 @@ As part of the execution, the linter will likely need to create a cache of
installed or mocked roles, collections and modules. This is done inside
``{project_dir}/.cache`` folder. The project directory is either given as a
command line argument, determined by location of the configuration
file, git project top-level directiory or user home directory as fallback.
file, git project top-level directory or user home directory as fallback.
In order to speed-up reruns, the linter does not clean this folder by itself.

If you are using git, you will likely want to add this folder to your
Expand All @@ -57,7 +57,7 @@ CI/CD
-----

If execution under `Github Actions`_ is detected via the presence of
``GITHUB_ACTIONS=true`` and ``GITHUB_WORFLOW=...`` variables, the linter will
``GITHUB_ACTIONS=true`` and ``GITHUB_WORKFLOW=...`` variables, the linter will
also print errors using their `annotation`_ format.

.. _GitHub Actions: https://github.com/features/actions
Expand Down