Skip to content

Commit

Permalink
[qa] Reformatted text
Browse files Browse the repository at this point in the history
  • Loading branch information
nemesifier committed Jul 25, 2024
1 parent 7a42dc8 commit 5aa0373
Show file tree
Hide file tree
Showing 9 changed files with 903 additions and 862 deletions.
198 changes: 104 additions & 94 deletions developer/google-code-in.rst

Large diffs are not rendered by default.

611 changes: 302 additions & 309 deletions developer/gsoc-ideas-2021.rst

Large diffs are not rendered by default.

482 changes: 252 additions & 230 deletions developer/gsoc-ideas-2022.rst

Large diffs are not rendered by default.

373 changes: 193 additions & 180 deletions developer/gsoc-ideas-2023.rst

Large diffs are not rendered by default.

76 changes: 39 additions & 37 deletions developer/hacktoberfest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,55 +4,57 @@ Hacktoberfest
=============

.. image:: ../images/hacktoberfest/hacktoberfest-openwisp.png
:align: center
:align: center

.. note::
OpenWISP participates in `Hacktoberfest 2021
<https://hacktoberfest.digitalocean.com/>`_!

If you are reading this page you are probably considering OpenWISP
as a possible organization to contribute for `Hacktoberfest
OpenWISP participates in `Hacktoberfest 2021
<https://hacktoberfest.digitalocean.com/>`_!

If you are reading this page you are probably considering OpenWISP as a
possible organization to contribute for `Hacktoberfest
<https://hacktoberfest.digitalocean.com/>`_, welcome!

If you are looking for a **friendly community** where **your contribution
will have a very tangible positive effect from the first day of your
participation** and where **you can grow your tech skills at 360°**,
then **CONGRATULATIONS!** OpenWISP is the right organization for you.
participation** and where **you can grow your tech skills at 360°**, then
**CONGRATULATIONS!** OpenWISP is the right organization for you.

How to get started
------------------

1. Read the contributing guidelines
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Avoid common pitfalls by reading our
:doc:`Contributing guidelines <../developer/contributing>`.
Avoid common pitfalls by reading our :doc:`Contributing guidelines
<../developer/contributing>`.

This will result in **your pull requests being merged faster**
and less overhead for maintainers.
This will result in **your pull requests being merged faster** and less
overhead for maintainers.

2. Project Board
~~~~~~~~~~~~~~~~

Look for issues labeled **hacktoberfest** in the
`OpenWISP Hacktoberfest Contributor's Board <https://github.com/orgs/openwisp/projects/3?card_filter_query=label%3Ahacktoberfest>`_..
Look for issues labeled **hacktoberfest** in the `OpenWISP Hacktoberfest
Contributor's Board
<https://github.com/orgs/openwisp/projects/3?card_filter_query=label%3Ahacktoberfest>`_..

Feel free to ask question regarding points which are not clear, but
please **ensure your questions are specific**.
Feel free to ask question regarding points which are not clear, but please
**ensure your questions are specific**.

3. Announce you're working on something
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

When you are working on an issue you think you are going to solve,
please **let everyone know** by leaving a comment on the Github issue
so we can **avoid wasted efforts** from multiple contributors working
on the same patch.
When you are working on an issue you think you are going to solve, please
**let everyone know** by leaving a comment on the Github issue so we can
**avoid wasted efforts** from multiple contributors working on the same
patch.

However, **if you stop working on it, please also let us know**.

If you find somebody else has announced they're working on an issue you
would like to do, you may want to double check they're still working on
it by leaving a comment on the issue.
would like to do, you may want to double check they're still working on it
by leaving a comment on the issue.

4. Join the general chat
~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -66,11 +68,11 @@ coordinate with the community.
Caring for Open Source also means helping its communities grow.

Growing is important because it will allow us to have more mentors in the
future so **we will able to help out more contributors to
advance their skills**.
future so **we will able to help out more contributors to advance their
skills**.

**Hint**: try to do some of the easiest actions described in :doc:`Help
us to grow <../general/help-us>`.
**Hint**: try to do some of the easiest actions described in :doc:`Help us
to grow <../general/help-us>`.

Main Rules
----------
Expand All @@ -83,30 +85,30 @@ open source meaningfully, which for us means contributing to our mission
and end goals. Since new contributors are not suited to work on critical
tasks due to their inherent complexity, we prepared a list of easier and
well defined issues that can be used to get started, please refer to our
`OpenWISP Hacktoberfest Contributor's Board <https://github.com/orgs/openwisp/projects/3?card_filter_query=label%3Ahacktoberfest>`_.
`OpenWISP Hacktoberfest Contributor's Board
<https://github.com/orgs/openwisp/projects/3?card_filter_query=label%3Ahacktoberfest>`_.

2. Spammy pull requests won't be accepted
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Spammy pull requests containing minor changes (fixing typos, grammars,
etc.) that are aimed simply at increasing your Hacktoberfest score will
be flagged as invalid.
etc.) that are aimed simply at increasing your Hacktoberfest score will be
flagged as invalid.

This behavior is not compatible with the spirit of the program, if you
are doing this you are missing the point of Hacktoberfest, Open Source
and you are just wasting everyone's time (including yours, because you
could be learning something new instead of trying to naively trick the
system).
This behavior is not compatible with the spirit of the program, if you are
doing this you are missing the point of Hacktoberfest, Open Source and you
are just wasting everyone's time (including yours, because you could be
learning something new instead of trying to naively trick the system).

3. Be constructive
~~~~~~~~~~~~~~~~~~

Please try to be constructive and patient when interacting with
maintainers and contributors.

If you feel you're not treated fairly, please refer to the
instructions for reporting unacceptable behavior in our
:doc:`Code of Conduct <../general/code-of-conduct>`.
If you feel you're not treated fairly, please refer to the instructions
for reporting unacceptable behavior in our :doc:`Code of Conduct
<../general/code-of-conduct>`.

.. image:: ../images/hacktoberfest/hacktoberfest-openwisp-dark.png
:align: center
:align: center
5 changes: 2 additions & 3 deletions general/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
Glossary
========

The contents of these page were obsolete and have been merged
in the following page:
:doc:`Architecture, Modules, Technologies
The contents of these page were obsolete and have been merged in the
following page: :doc:`Architecture, Modules, Technologies
<../general/architecture>`.
1 change: 0 additions & 1 deletion general/technologies.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
:orphan:

======================
Main Technologies Used
======================

Expand Down
15 changes: 9 additions & 6 deletions user/configure-device.rst
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,8 @@ Download them onto your device from `downloads.openwisp.io
Once the agents are installed on your OpenWrt device, let's ensure they
can connect to OpenWISP successfully.

Edit the config file located at ``/etc/config/openwisp``, which should look like the following sample:
Edit the config file located at ``/etc/config/openwisp``, which should
look like the following sample:

::

Expand Down Expand Up @@ -104,7 +105,9 @@ Edit the config file located at ``/etc/config/openwisp``, which should look like

Uncomment and update the following lines:

- ``url``: Set this to the hostname of your OpenWISP instance (e.g., if your OpenWISP server is at "192.168.56.2", set the url to ``https://192.168.56.2``).
- ``url``: Set this to the hostname of your OpenWISP instance (e.g., if
your OpenWISP server is at "192.168.56.2", set the url to
``https://192.168.56.2``).
- ``verify_ssl``: Set to ``'0'`` if your controller's SSL certificate is
self-signed; in production, use a valid SSL certificate to ensure
security.
Expand All @@ -115,8 +118,8 @@ Uncomment and update the following lines:

.. hint::

For more details on the configuration options, refer to :doc:`OpenWrt Config Agent Settings
</openwrt-config-agent/user/settings>`.
For more details on the configuration options, refer to :doc:`OpenWrt
Config Agent Settings </openwrt-config-agent/user/settings>`.

.. note::

Expand All @@ -138,8 +141,8 @@ Save the file and restart the agent:
default settings work for most cases, and the agent restarts itself
when the config agent is restarted.

For more details on its configuration options, refer to :doc:`OpenWrt Monitoring Agent Settings
</openwrt-monitoring-agent/user/settings>`.
For more details on its configuration options, refer to :doc:`OpenWrt
Monitoring Agent Settings </openwrt-monitoring-agent/user/settings>`.

Your OpenWrt device should now be able to register with OpenWISP.

Expand Down
4 changes: 2 additions & 2 deletions user/radius.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ RADIUS
OpenWISP RADIUS is available since OpenWISP 22.05 and provides many
features aimed at public WiFi services.

The following diagram illustrates the role of the RADIUS
module within the OpenWISP architecture.
The following diagram illustrates the role of the RADIUS module within the
OpenWISP architecture.

.. figure:: /images/architecture/v2/architecture-v2-openwisp-radius.png
:target: ../_images/architecture-v2-openwisp-radius.png
Expand Down

0 comments on commit 5aa0373

Please sign in to comment.