Skip to content

Commit f1a12fd

Browse files
authored
[docs] Updated screenshots and GIFs #633
Closes #633
1 parent c0f554c commit f1a12fd

11 files changed

+11
-11
lines changed

README.rst

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ openwisp-controller
2929
:target: https://pypi.org/project/black/
3030
:alt: code style: black
3131

32-
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/master/docs/controller_demo.gif
33-
:target: https://github.com/openwisp/openwisp-controller/tree/master/docs/controller_demo.gif
32+
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/controller_demo.gif
33+
:target: https://github.com/openwisp/openwisp-controller/tree/docs/docs/controller_demo.gif
3434
:alt: Feature Highlights
3535

3636
------------
@@ -488,7 +488,7 @@ simply rename the templates by prefixing them with numbers, eg:
488488
Required Templates
489489
~~~~~~~~~~~~~~~~~~
490490

491-
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/master/docs/required-templates.png
491+
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/required-templates.png
492492
:alt: Required template example
493493

494494
Required templates are similar to `Default templates <#default-templates>`__
@@ -531,7 +531,7 @@ In the device configuration section you can find a section named
531531
"Configuration variables" where it is possible to define the configuration
532532
variables and their values, as shown in the example below:
533533

534-
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/master/docs/device-context.png
534+
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/device-context.png
535535
:alt: context
536536

537537
Template default values
@@ -552,7 +552,7 @@ These default values will be overridden by the
552552
The default values of variables can be manipulated from the section
553553
"configuration variables" in the edit template page:
554554

555-
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/master/docs/template-default-values.png
555+
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/template-default-values.png
556556
:alt: default values
557557

558558
Global variables
@@ -569,7 +569,7 @@ are automatically managed by the system (eg: when using templates of
569569
type VPN-client) are displayed in the admin UI as *System Defined Variables*
570570
in read-only mode.
571571

572-
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/master/docs/system-defined-variables.png
572+
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/system-defined-variables.png
573573
:alt: system defined variables
574574

575575
Example usage of variables
@@ -655,7 +655,7 @@ Store the content of these files in a secure location.
655655
2. Save SSH private key in OpenWISP (access credentials)
656656
########################################################
657657

658-
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/master/docs/add-ssh-credentials-private-key.png
658+
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/add-ssh-credentials-private-key.png
659659
:alt: add SSH private key as access credential in OpenWISP
660660

661661
From the first page of OpenWISP click on "Access credentials", then click
@@ -674,7 +674,7 @@ The credentials just created will be automatically enabled for all the devices i
674674
3. Add the public key to your devices
675675
#####################################
676676

677-
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/master/docs/add-authorized-ssh-keys-template.png
677+
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/add-authorized-ssh-keys-template.png
678678
:alt: Add authorized SSH public keys template to OpenWISP (OpenWRT)
679679

680680
Now we need to instruct your devices to allow OpenWISP accessing via SSH,
@@ -909,7 +909,7 @@ Device Groups provide the following features:
909909
information across all groups using `"OPENWISP_CONTROLLER_DEVICE_GROUP_SCHEMA" <#openwisp-controller-device-group-schema>`_
910910
setting.
911911

912-
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/master/docs/device-groups.png
912+
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/device-groups.png
913913
:alt: Device Group example
914914

915915
How to setup WireGuard tunnels
@@ -1276,14 +1276,14 @@ REST API Reference
12761276
Live documentation
12771277
~~~~~~~~~~~~~~~~~~
12781278

1279-
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/master/docs/live-docu-api.png
1279+
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/live-docu-api.png
12801280

12811281
A general live API documentation (following the OpenAPI specification) at ``/api/v1/docs/``.
12821282

12831283
Browsable web interface
12841284
~~~~~~~~~~~~~~~~~~~~~~~
12851285

1286-
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/master/docs/browsable-api-ui.png
1286+
.. image:: https://raw.githubusercontent.com/openwisp/openwisp-controller/docs/docs/browsable-api-ui.png
12871287

12881288
Additionally, opening any of the endpoints `listed below <#list-of-endpoints>`_
12891289
directly in the browser will show the `browsable API interface of Django-REST-Framework
-121 KB
Binary file not shown.
-206 KB
Binary file not shown.

docs/browsable-api-ui.png

-74.1 KB
Binary file not shown.

docs/controller_demo.gif

-4.01 MB
Binary file not shown.

docs/device-context.png

-39 KB
Binary file not shown.

docs/device-groups.png

-41 KB
Binary file not shown.

docs/live-docu-api.png

-78.5 KB
Binary file not shown.

docs/required-templates.png

-12.2 KB
Binary file not shown.

docs/system-defined-variables.png

-287 KB
Binary file not shown.

0 commit comments

Comments
 (0)