Skip to content

Commit

Permalink
Add communication details (#400)
Browse files Browse the repository at this point in the history
* add communication details

* update bullhorn url

* rm compat tag

* add forum link to mkdocs theme

* update RTD url
  • Loading branch information
oraNod authored Sep 6, 2024
1 parent c2862c4 commit 5fcf78a
Show file tree
Hide file tree
Showing 2 changed files with 32 additions and 3 deletions.
29 changes: 27 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,37 @@
# ansible-compat

[![pypi](https://img.shields.io/pypi/v/ansible-compat.svg)](https://pypi.org/project/ansible-compat/)
[![docs](https://readthedocs.org/projects/ansible-compat/badge/?version=latest)](https://ansible-compat.readthedocs.io/)
[![docs](https://readthedocs.org/projects/ansible-compat/badge/?version=latest)](https://ansible.readthedocs.io/projects/compat/)
[![gh](https://github.com/ansible/ansible-compat/actions/workflows/tox.yml/badge.svg)](https://github.com/ansible/ansible-compat/actions/workflows/tox.yml)
[![codecov.io](https://codecov.io/github/ansible/ansible-compat/coverage.svg?branch=main)](https://codecov.io/github/ansible/ansible-compat?branch=main)

A python package contains functions that facilitate working with various
versions of Ansible 2.14 and newer.

## Documentation

Documentation is available at
[ansible-compat.readthedocs.io](https://ansible-compat.readthedocs.io/).
[ansible.readthedocs.io/projects/compat/](https://ansible.readthedocs.io/projects/compat/).

## Communication

Join the Ansible forum to ask questions, get help, and interact with the
community.

- [Get Help](https://forum.ansible.com/c/help/6): get help or help others.
Please add appropriate tags if you start new discussions.
- [Social Spaces](https://forum.ansible.com/c/chat/4): meet and interact with
fellow enthusiasts.
- [News & Announcements](https://forum.ansible.com/c/news/5): track project-wide
announcements including social events.

To get release announcements and important changes from the community, see the
[Bullhorn newsletter](https://docs.ansible.com/ansible/devel/community/communication.html#the-bullhorn).

For more information about getting in touch, see the
[Ansible communication guide](https://docs.ansible.com/ansible/devel/community/communication.html).

## Code of Conduct

Please see the official
[Ansible Community Code of Conduct](https://docs.ansible.com/ansible/latest/community/code_of_conduct.html).
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
site_name: Ansible Compat Library
site_url: https://ansible-compat.readthedocs.io/
site_url: https://ansible.readthedocs.io/projects/compat/
repo_url: https://github.com/ansible/ansible-compat
edit_uri: blob/main/docs/
copyright: Copyright © 2023 Red Hat, Inc.
Expand All @@ -26,6 +26,10 @@ extra:
social:
- icon: fontawesome/brands/github-alt
link: https://github.com/ansible/ansible-compat
name: GitHub
- icon: fontawesome/brands/discourse
link: https://forum.ansible.com/c/project/7
name: Ansible forum
nav:
- examples: index.md
- api: api.md
Expand Down

0 comments on commit 5fcf78a

Please sign in to comment.