Skip to content

Commit

Permalink
Add documentation on Python version support (#1174)
Browse files Browse the repository at this point in the history
* Add documentation on Python version support

* Clarification
  • Loading branch information
jacobtomlinson committed Oct 21, 2019
1 parent 805b8b7 commit a67afe9
Show file tree
Hide file tree
Showing 2 changed files with 69 additions and 49 deletions.
18 changes: 18 additions & 0 deletions docs/project/supported-python-versions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Supported Python versions

In opsdroid we follow [NEP 29](https://numpy.org/neps/nep-0029-deprecation_policy.html) to decide which versions of Python to support at any given time.

NEP29 states that we should support any Python version released in the previous 42 months. This effectively covers the previous two releases of Python (the release cycle is 18 months) and includes an additional six months to account for any fluctuations in release dates. It gives the community time to adopt new releases.

In addition to this we will also endeavour to support new minor versions of Python within 6 months of their release.

## Support table

| Version | Start Support | End Support | Status |
|---------|---------------|---------------|---------------------|
| 3.5.0 | March 2016 | March 2019 | No longer supported |
| 3.6.0 | June 2017 | June 2020 | Supported |
| 3.7.0 | December 2018 | December 2021 | Supported |
| 3.8.0 | April 2019 | April 2022 | Not yet supported |

_If you think this table may be out of date please help by raising a [Pull Request](https://github.com/opsdroid/opsdroid/edit/master/docs/project/supported-python-versions.md) to fix it._
100 changes: 51 additions & 49 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,52 +3,54 @@ repo_url: https://github.com/opsdroid/opsdroid
theme: readthedocs

pages:
- 'Home': 'index.md'
- 'Configuration Reference': 'configuration-reference.md'
- 'REST API': 'rest-api.md'
- 'Tutorial':
- 'Introduction': 'tutorials/introduction.md'
- 'Create a Basic Skill': 'tutorials/basic-skill.md'
- 'Create a Weather Skill': 'tutorials/create-weather-skill.md'
- 'Introduction to Vim': 'tutorials/introduction-vim.md'
- 'Extending opsdroid':
- 'Introduction': 'extending/intro.md'
- 'Adding skills': 'extending/skills.md'
- 'Adding connectors': 'extending/connectors.md'
- 'Adding databases': 'extending/databases.md'
- 'Using Events': 'extending/events.md'
- 'Extension packaging': 'extending/packaging.md'
- 'Connectors':
- 'Facebook': 'connectors/facebook.md'
- 'GitHub': 'connectors/github.md'
- 'Gitter': 'connectors/gitter.md'
- 'Matrix': 'connectors/matrix.md'
- 'Rocket.Chat': 'connectors/rocketchat.md'
- 'Shell': 'connectors/shell.md'
- 'Slack': 'connectors/slack.md'
- 'Telegram': 'connectors/telegram.md'
- 'Webex Teams': 'connectors/webexteams.md'
- 'Websocket': 'connectors/websocket.md'
- 'Databases':
- 'MongoDB': 'databases/mongo.md'
- 'Redis': 'databases/redis.md'
- 'SQLite': 'databases/sqlite.md'
- 'Matchers':
- 'Simple':
- 'Parse Format': 'matchers/parse_format.md'
- 'Regular Expressions': 'matchers/regex.md'
- 'Third party NLU':
- 'Dialogflow (Api.ai)': 'matchers/dialogflow.md'
- 'LUIS.AI': 'matchers/luis.ai.md'
- 'Rasa NLU (local)': 'matchers/rasanlu.md'
- 'Recast.AI (SAPCAI)': 'matchers/sapcai.md'
- 'wit.ai': 'matchers/wit.ai.md'
- 'Misc':
- 'Always': 'matchers/always.md'
- 'Crontab': 'matchers/crontab.md'
- 'Event': 'matchers/event.md'
- 'Webhook': 'matchers/webhook.md'
- 'Constraints': 'constraints.md'
- 'Contributing': 'contributing.md'
- 'Releasing': 'project/making-a-release.md'
- 'Maintainers': 'maintainers.md'
- "Home": "index.md"
- "Configuration Reference": "configuration-reference.md"
- "REST API": "rest-api.md"
- "Tutorial":
- "Introduction": "tutorials/introduction.md"
- "Create a Basic Skill": "tutorials/basic-skill.md"
- "Create a Weather Skill": "tutorials/create-weather-skill.md"
- "Introduction to Vim": "tutorials/introduction-vim.md"
- "Extending opsdroid":
- "Introduction": "extending/intro.md"
- "Adding skills": "extending/skills.md"
- "Adding connectors": "extending/connectors.md"
- "Adding databases": "extending/databases.md"
- "Using Events": "extending/events.md"
- "Extension packaging": "extending/packaging.md"
- "Connectors":
- "Facebook": "connectors/facebook.md"
- "GitHub": "connectors/github.md"
- "Gitter": "connectors/gitter.md"
- "Matrix": "connectors/matrix.md"
- "Rocket.Chat": "connectors/rocketchat.md"
- "Shell": "connectors/shell.md"
- "Slack": "connectors/slack.md"
- "Telegram": "connectors/telegram.md"
- "Webex Teams": "connectors/webexteams.md"
- "Websocket": "connectors/websocket.md"
- "Databases":
- "MongoDB": "databases/mongo.md"
- "Redis": "databases/redis.md"
- "SQLite": "databases/sqlite.md"
- "Matchers":
- "Simple":
- "Parse Format": "matchers/parse_format.md"
- "Regular Expressions": "matchers/regex.md"
- "Third party NLU":
- "Dialogflow (Api.ai)": "matchers/dialogflow.md"
- "LUIS.AI": "matchers/luis.ai.md"
- "Rasa NLU (local)": "matchers/rasanlu.md"
- "Recast.AI (SAPCAI)": "matchers/sapcai.md"
- "wit.ai": "matchers/wit.ai.md"
- "Misc":
- "Always": "matchers/always.md"
- "Crontab": "matchers/crontab.md"
- "Event": "matchers/event.md"
- "Webhook": "matchers/webhook.md"
- "Constraints": "constraints.md"
- "Contributing": "contributing.md"
- "Project":
- "Supported Python Versions": "project/supported-python-versions.md"
- "Releasing": "project/making-a-release.md"
- "Maintainers Guide": "maintainers.md"

0 comments on commit a67afe9

Please sign in to comment.