diff --git a/README.md b/README.md index 7fd4482c..6b8888ae 100644 --- a/README.md +++ b/README.md @@ -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). diff --git a/mkdocs.yml b/mkdocs.yml index 0eca7b43..2c54b288 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -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. @@ -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