mirror of
https://github.com/wagtail/wagtail.git
synced 2024-11-21 18:09:02 +01:00
Documentation updates & emojis
* Extra documentation support & added emojis * Removed link to Google Group
This commit is contained in:
parent
5ff20cda8c
commit
df8349a81b
35
README.md
35
README.md
@ -31,7 +31,7 @@ Wagtail is an open source content management system built on Django, with a stro
|
||||
|
||||
![Wagtail screenshot](https://cdn.jsdelivr.net/gh/wagtail/wagtail@main/.github/wagtail-screenshot-with-browser.png)
|
||||
|
||||
### Features
|
||||
### 🔥 Features
|
||||
|
||||
- A fast, attractive interface for authors
|
||||
- Complete control over front-end design and structure
|
||||
@ -47,7 +47,7 @@ Wagtail is an open source content management system built on Django, with a stro
|
||||
|
||||
Find out more at [wagtail.org](https://wagtail.org/).
|
||||
|
||||
### Getting started
|
||||
### 👉 Getting started
|
||||
|
||||
Wagtail works with [Python 3](https://www.python.org/downloads/), on any platform.
|
||||
|
||||
@ -68,15 +68,22 @@ python manage.py runserver
|
||||
For detailed installation and setup docs, see [the getting started tutorial](https://docs.wagtail.org/en/stable/getting_started/tutorial.html).
|
||||
|
||||
|
||||
### Who’s using it?
|
||||
### 👨👩👧👦 Who’s using it?
|
||||
|
||||
Wagtail is used by [NASA](https://www.nasa.gov/), [Google](https://www.google.com/), [Oxfam](https://www.oxfam.org/en), the [NHS](https://www.nhs.uk/), [Mozilla](https://www.mozilla.org/en-US/), [MIT](https://www.mit.edu/), the [Red Cross](https://www.icrc.org/en), [Salesforce](https://www.salesforce.com/), [NBC](https://www.nbc.com/), [BMW](https://www.bmw.com/en/index.html), and the US and UK governments. Add your own Wagtail site to [madewithwagtail.org](https://madewithwagtail.org).
|
||||
|
||||
### Documentation
|
||||
### 📖 Documentation
|
||||
|
||||
[docs.wagtail.org](https://docs.wagtail.org/) is the full reference for Wagtail, and includes guides for developers, designers and editors, alongside release notes and our roadmap.
|
||||
|
||||
### Compatibility
|
||||
For those who are **new to Wagtail**, the [Zen of Wagtail](https://docs.wagtail.org/en/stable/getting_started/the_zen_of_wagtail.html) will help you understand what Wagtail is, and what Wagtail is _not_.
|
||||
|
||||
**For developers** who are ready to jump in to their first Wagtail website the [Getting Started Tutorial](https://docs.wagtail.org/en/stable/getting_started/tutorial.html) will guide you through creating and editing your first page.
|
||||
|
||||
**Do you have an existing Django project?** The [Wagtail Integration documentation](https://docs.wagtail.org/en/stable/getting_started/integrating_into_django.html) is the best place to start.
|
||||
|
||||
|
||||
### 📌 Compatibility
|
||||
|
||||
_(If you are reading this on GitHub, the details here may not be indicative of the current released version - please see [Compatible Django / Python versions](https://docs.wagtail.org/en/stable/releases/upgrading.html#compatible-django-python-versions) in the Wagtail documentation.)_
|
||||
|
||||
@ -90,11 +97,11 @@ Wagtail supports:
|
||||
|
||||
---
|
||||
|
||||
### Community Support
|
||||
### 📢 Community Support
|
||||
|
||||
There is an active community of Wagtail users and developers responding to questions on [Stack Overflow](https://stackoverflow.com/questions/tagged/wagtail). When posting questions, please read Stack Overflow's advice on [how to ask questions](https://stackoverflow.com/help/how-to-ask) and remember to tag your question "wagtail".
|
||||
|
||||
For topics and discussions that do not fit Stack Overflow's question and answer format, we have a [Slack workspace](https://github.com/wagtail/wagtail/wiki/Slack) and a [Wagtail Support mailing list](https://groups.google.com/forum/#!forum/wagtail). Please respect the time and effort of volunteers by not asking the same question in multiple places.
|
||||
For topics and discussions that do not fit Stack Overflow's question and answer format we have a [Slack workspace](https://github.com/wagtail/wagtail/wiki/Slack). Please respect the time and effort of volunteers by not asking the same question in multiple places.
|
||||
|
||||
[![Join slack community](.github/join-slack-community.png)](https://github.com/wagtail/wagtail/wiki/Slack)
|
||||
|
||||
@ -102,25 +109,25 @@ Our [Github discussion boards](https://github.com/wagtail/wagtail/discussions) a
|
||||
|
||||
We maintain a curated list of third party packages, articles and other resources at [Awesome Wagtail](https://github.com/springload/awesome-wagtail).
|
||||
|
||||
### Commercial Support
|
||||
### 🧑💼 Commercial Support
|
||||
|
||||
Wagtail is sponsored by [Torchbox](https://torchbox.com/). If you need help implementing or hosting Wagtail, please contact us: hello@torchbox.com. See also [madewithwagtail.org/developers/](https://madewithwagtail.org/developers/) for expert Wagtail developers around the world.
|
||||
|
||||
### Security
|
||||
### 🔐 Security
|
||||
|
||||
We take the security of Wagtail, and related packages we maintain, seriously. If you have found a security issue with any of our projects please email us at [security@wagtail.org](mailto:security@wagtail.org) so we can work together to find and patch the issue. We appreciate responsible disclosure with any security related issues, so please contact us first before creating a Github issue.
|
||||
|
||||
If you want to send an encrypted email (optional), the public key ID for security@wagtail.org is 0xbed227b4daf93ff9, and this public key is available from most commonly-used keyservers.
|
||||
|
||||
### Release schedule
|
||||
### 🕒 Release schedule
|
||||
|
||||
Feature releases of Wagtail are released every three months. Selected releases are designated as Long Term Support (LTS) releases, and will receive maintenance updates for an extended period to address any security and data-loss related issues. For dates of past and upcoming releases and support periods, see [Release Schedule](https://github.com/wagtail/wagtail/wiki/Release-schedule).
|
||||
|
||||
#### Nightly releases
|
||||
#### 🕛 Nightly releases
|
||||
|
||||
To try out the latest features before a release, we also create builds from `main` every night. You can find instructions on how to install the latest nightly release at https://releases.wagtail.org/nightly/index.html
|
||||
|
||||
### Contributing
|
||||
### 🙋🏽 Contributing
|
||||
|
||||
If you're a Python or Django developer, fork the repo and get stuck in! We have several developer focused channels on the [Slack workspace](https://github.com/wagtail/wagtail/wiki/Slack).
|
||||
|
||||
@ -128,11 +135,11 @@ You might like to start by reviewing the [contributing guidelines](https://docs.
|
||||
|
||||
We also welcome translations for Wagtail's interface. Translation work should be submitted through [Transifex](https://www.transifex.com/projects/p/wagtail/).
|
||||
|
||||
### License
|
||||
### 🔓 License
|
||||
|
||||
[BSD](https://github.com/wagtail/wagtail/blob/main/LICENSE) - Free to use and modify for any purpose, including both open and closed-source code.
|
||||
|
||||
### Thanks
|
||||
### 👏 Thanks
|
||||
|
||||
We thank the following organisations for their services used in Wagtail's development:
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user