8000 feat: add v4 docs to main branch by fsbraun · Pull Request #7722 · django-cms/django-cms · GitHub
[go: up one dir, main page]
Skip to content

feat: add v4 docs to main branch #7722

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

Merged
merged 5 commits into from
Dec 21, 2023
Merged

feat: add v4 docs to main branch #7722

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
2044a9d
Add docs
fsbraun Dec 19, 2023
75b03f9
Improve formatting
fsbraun Dec 19, 2023
95da2e0
Update formatting
fsbraun Dec 19, 2023
902e2c0
Update changelog for 4.0 from git logs
fsbraun Dec 19, 2023
37f8505
Fix typos
fsbraun Dec 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update formatting
  • Loading branch information
@fsbraun
fsbraun committed Dec 19, 2023
commit 95da2e02ea31a8b5f79991c2757afdfcde6ba049
32 changes: 14 additions & 18 deletions docs/contributing/code_of_conduct.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,30 +1,26 @@
###############
Code of Conduct
###############
===============

Participation in the django CMS project is governed by a code of conduct.

The django CMS community is a pleasant one to be involved in for everyone, and
we wish to keep it that way. Participants are expected to behave and
communicate with others courteously and respectfully, whether online or in
person, and to be welcoming, friendly and polite.
The django CMS community is a pleasant one to be involved in for everyone, and we wish
to keep it that way. Participants are expected to behave and communicate with others
courteously and respectfully, whether online or in person, and to be welcoming, friendly
and polite.

We will not tolerate abusive behaviour or language or any form of harassment.

Individuals whose behaviour is a cause for concern will be given a warning, and
if necessary will be excluded from participation in official django CMS
channels (Slack group, email lists, etc) and
events. The `Django Software Foundation
Individuals whose behaviour is a cause for concern will be given a warning, and if
necessary will be excluded from participation in official django CMS channels (Slack
group, email lists, etc) and events. The `Django Software Foundation
<http://djangoproject.com/foundation/>`_ will also be informed of the issue.

*****************
Raising a concern
*****************
-----------------

If you have a concern about the behaviour of any member of the django CMS
community, please contact us via info@django-cms.org and our Community Manager
will reach out to you.
If you have a concern about the behaviour of any member of the django CMS community,
please contact us via info@django-cms.org and our Community Manager will reach out to
you.

Your concerns will be taken seriously, treated as confidential and
investigated. You will be informed, in writing and as promptly as possible, of
the outcome.
Your concerns will be taken seriously, treated as confidential and investigated. You
will be informed, in writing and as promptly as possible, of the outcome.
140 changes: 73 additions & 67 deletions docs/contributing/development-community.rst
View file
Open in desktop
8000
Original file line number Diff line number Diff line change
@@ -1,106 +1,112 @@
.. _development-community:

##################################
Contribute to django CMS
##################################
========================

As an open source project, django CMS is only as strong as its community.
Without the donation of time and skill of our contributors and the financial
support of our `association members <https://www.django-cms.org/en/our-members/>`_
it would not be possible to maintain the django CMS project.
The community is the backbone of django CMS.
As an open source project, django CMS is only as strong as its community. Without the
donation of time and skill of our contributors and the financial support of our
`association members <https://www.django-cms.org/en/our-members/>`_ it would not be
possible to maintain the django CMS project. The community is the backbone of django
CMS.

Our contributors come from all over the world and have different
levels of skills and expertise. No matter if you are a developer, usability
enthusiast, designer or copywriter. Young or old. Experienced or inexperienced.
Every contribution, however small, is valued.
Our contributors come from all over the world and have different levels of skills and
expertise. No matter if you are a developer, usability enthusiast, designer or
copywriter. Young or old. Experienced or inexperienced. Every contribution, however
small, is valued.

You don’t need to be an expert developer to make a valuable contribution - all you need
is a little knowledge of the system, and a willingness to follow the contribution guidelines.
is a little knowledge of the system, and a willingness to follow the contribution
guidelines.

Open source contribution can include taking part in discussions,
filing bug reports, proposing improvements, contributing code or writing documentation.
Open source contribution can include taking part in discussions, filing bug reports,
proposing improvements, contributing code or writing documentation.

Remember that contributions to the documentation are highly prized, and key to
the success of the django CMS project.
Remember that contributions to the documentation are highly prized, and key to the
success of the django CMS project.

All activity in the community is governed by our :doc:`code_of_conduct`.

******************************************
3 Reasons Why You Should Contribute
******************************************

-----------------------------------

1. Boost your reputation
=========================
Through your involvement as a contributor, other people become aware of your work.
In this way, you make a name for yourself in the community and your reputation grows. This
can also help you in your professional career. Add your contribution to your resume or LinkedIn profile.
~~~~~~~~~~~~~~~~~~~~~~~~

Through your involvement as a contributor, other people become aware of your work. In
this way, you make a name for yourself in the community and your reputation grows. This
can also help you in your professional career. Add your contribution to your resume or
LinkedIn profile.

2. Find a mentor and improve your skills
==================================================
When you join a workgroup, you will receive guidance and support from the workgroup leader.
Our working group leaders are professionals in their field and often in leading positions in
their respective companies. Take advantage of this unique opportunity for personal development!
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When you join a workgroup, you will receive guidance and support from the workgroup
leader. Our working group leaders are professionals in their field and often in leading
positions in their respective companies. Take advantage of this unique opportunity for
personal development!

3. Meet new people and increase your network
==================================================
Let's face it: Ultimately, it's the people who bring the django CMS project to life and fill it with joy.
Through your involvement, you'll meet new people and maybe even make new friends. As a community,
it's important to us to create a pleasant atmosphere where everyone feels welcome!
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Learn more about the benefits of contributing in our `community hero program <https://www.django-cms.org/en/become-community-hero/>`_ and sign up for it.
Let's face it: Ultimately, it's the people who bring the django CMS project to life and
fill it with joy. Through your involvement, you'll meet new people and maybe even make
new friends. As a community, it's important to us to create a pleasant atmosphere where
everyone feels welcome!

Learn more about the benefits of contributing in our `community hero program
<https://www.django-cms.org/en/become-community-hero/>`_ and sign up for it.

******************************************
Are you new to django CMS?
******************************************
--------------------------

If you are new to django CMS, then we recommend you to first familiarize yourself with
the CMS and start with the `install
<https://docs.django-cms.org/en/latest/introduction/01-install.html>`_ section. After
that, you can have a go at issues on Github that are marked `Good first issue
<https://github.com/django-cms/django-cms/labels/good%20first%20issues>`_. These issues
are especially good if you're just starting out but still want to contribute. Beginners
can also contribute to the project, for example by helping to improve the documentation,
or other tasks, such as writing a blog article series about your journey of learning
django CMS (See `community tasks <https://www.django-cms.org/en/community-tasks/>`_).
After you have acquainted yourself with django CMS and maybe already created your first
website with it, you should start looking at contributing to the django CMS codebase.

If you are new to django CMS, then we recommend you to first familiarize yourself with the CMS
and start with the `install <https://docs.django-cms.org/en/latest/introduction/01-install.html>`_ section.
After that, you can have a go at issues on Github that are marked `Good first issue <https://github.com/django-cms/django-cms/labels/good%20first%20issues>`_.
These issues are especially good if you're just starting out but still want to contribute.
Beginners can also contribute to the project, for example by helping to improve the documentation,
or other tasks, such as writing a blog article series about your journey of learning django CMS
(See `community tasks <https://www.django-cms.org/en/community-tasks/>`_).
After you have acquainted yourself with django CMS and maybe already created your first website with it,
you should start looking at contributing to the django CMS codebase.


******************************************
Contributor Community
******************************************
---------------------

But before you start getting your hands dirty, you should make sure to join us online in order
to stay updated with the latest news and to connect with other users across the world.
But before you start getting your hands dirty, you should make sure to join us online in
order to stay updated with the latest news and to connect with other users across the
world.

You can join us online:

* in our `django CMS Slack channel <https://www.django-cms.org/slack>`_
* on `StackOverflow <https://stackoverflow.com/questions/tagged/django-cms>`_

You should make sure to join our Slack workspace. It is our main communication platform. Users from all over the world
use Slack to talk about django CMS and to support each other in answering support requests.
StackOverflow is a very popular, community-based space to find and contribute answers to technical challenges
- in our `django CMS Slack channel <https://www.django-cms.org/slack>`_
- on `StackOverflow <https://stackoverflow.com/questions/tagged/django-cms>`_

You should make sure to join our Slack workspace. It is our main communication platform.
Users from all over the world use Slack to talk about django CMS and to support each
other in answering support requests. StackOverflow is a very popular, community-based
space to find and contribute answers to technical challenges

You can also follow:

* the `@djangocms <https://twitter.com/djangocms>`_ Twitter account for general announcements
* the `django CMS Association LinkedIn <https://www.linkedin.com/company/django-cms-association>`_ account
- the `@djangocms <https://twitter.com/djangocms>`_ Twitter account for general
announcements
- the `django CMS Association LinkedIn
<https://www.linkedin.com/company/django-cms-association>`_ account

**********************************************************
Don't want to contribute alone? Join a working group
**********************************************************
----------------------------------------------------

Most participation in the django CMS is organized through work groups. These are small,
independent groups of volunteers who have come together to work on a project.

It is entirely up to you whether you want to join such a `work group <https://www.django-cms.org/en/join-work-group/>`_
and join other django CMS enthusiasts or if you want to work on topics on your own.
By the way, you can also create your own work group. Find out more `here <https://github.com/django-cms/django-cms-mgmt/blob/master/work%20contribution/work%20groups.md>`_.
It is entirely up to you whether you want to join such a `work group
<https://www.django-cms.org/en/join-work-group/>`_ and join other django CMS enthusiasts
or if you want to work on topics on your own. By the way, you can also create your own
work group. Find out more `here
<https://github.com/django-cms/django-cms-mgmt/blob/master/work%20contribution/work%20groups.md>`_.

Are you interested in knowledge sharing and improving your skills? Then a workgroup might be
the right choice for you. Would you rather decide for yourself when and what you work on? Then you
can choose a task from our community tasks list or contribute directly on Github
by answering issues or create Pull Requests.
Are you interested in knowledge sharing and improving your skills? Then a workgroup
might be the right choice for you. Would you rather decide for yourself when and what
you work on? Then you can choose a task from our community tasks list or contribute
directly on Github by answering issues or create Pull Requests.
Loading
0