Skip to content
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.

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

[docker-docs] Restructured Documentation: New Unified Documentation Website #308

Merged
merged 27 commits into from
Aug 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
aebff19
[docs] Restructured docs
pandafy Jun 10, 2024
22dc9f3
[docs] Restructured docs
pandafy Jun 10, 2024
d64e808
[docs] Added link to github repo
nemesifier Jul 8, 2024
edd03bc
[docs] Gave some love to the developer docs
nemesifier Jul 8, 2024
0810e54
[docs] Gave some love to settings
nemesifier Jul 8, 2024
084da1b
[docs] More love: merged customizations and files
nemesifier Jul 8, 2024
10d1f00
[docs] Sent more love to Docker OpenWISP
nemesifier Jul 8, 2024
60c96cf
[docs] Improved customization page
nemesifier Jul 8, 2024
3684b39
[docs] Fixed typos
embdur Jul 10, 2024
445b2d9
[docs] OpenWRT > OpenWrt
nemesifier Jul 13, 2024
4c66aaa
[skip ci] Updated docs website URL
pandafy Jul 15, 2024
8e81d56
[docs] Table of contents, consistency, fixes
nemesifier Jul 16, 2024
6068345
[skip ci] docker-compose > docker compose
pandafy Jul 24, 2024
7579d62
[docs] Updated docs
pandafy Jul 24, 2024
20ff5a3
[docs] Added architecture diagram
nemesifier Jul 24, 2024
9ad1154
[skip ci] Removed docs for Kubernetes
pandafy Jul 25, 2024
a6cfc4e
[skip ci] Added note for updating /etc/hosts file
pandafy Jul 25, 2024
d96326b
[skip ci] Fixed docs
pandafy Jul 26, 2024
04e4a9f
[skip ci] Updated screenshot in README
pandafy Jul 26, 2024
bab8952
[skip ci] Added screenshot for README
pandafy Jul 26, 2024
bf49ba3
[skip ci] Updated REAEDME
pandafy Jul 26, 2024
1274f14
[docs] More improvements to Quick Start Guide
nemesifier Jul 26, 2024
8df7de0
[docs] Reformatted settings page
nemesifier Jul 26, 2024
9f907b0
[docs] Reformatted
nemesifier Jul 27, 2024
a11160b
[qa] Reformatted files
nemesifier Jul 30, 2024
6b20906
Merge branch 'master' into reorder-docs
nemesifier Aug 3, 2024
249b7b7
[qa] Minor code reformatting
nemesifier Aug 3, 2024
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
3 changes: 2 additions & 1 deletion CONTRIBUTING.rst
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Please refer to the `OpenWISP Contributing Guidelines <http://openwisp.io/docs/developer/contributing.html>`_.
Please refer to the `OpenWISP Contributing Guidelines
<http://openwisp.io/docs/developer/contributing.html>`_.
366 changes: 0 additions & 366 deletions README.md

This file was deleted.

31 changes: 31 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
Docker-OpenWISP
===============

.. image:: https://github.com/openwisp/docker-openwisp/workflows/Automation%20Tests/badge.svg
:target: https://github.com/openwisp/docker-openwisp/actions?query=workflow%3A%22Automation+Tests%22

.. image:: https://img.shields.io/badge/registry-openwisp-blue.svg
:target: https://gitlab.com/openwisp/docker-openwisp/container_registry

.. image:: https://badges.gitter.im/openwisp/dockerize-openwisp.svg
:target: https://gitter.im/openwisp/dockerize-openwisp?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge

.. image:: https://img.shields.io/badge/support-orange.svg
:target: http://openwisp.org/support.html

.. image:: https://img.shields.io/github/license/openwisp/docker-openwisp.svg
:target: https://github.com/openwisp/docker-openwisp/blob/master/LICENSE

This repository contains official docker images of OpenWISP. Designed with
horizontal scaling, easily replicable deployments and user customization
in mind.

.. image:: https://raw.githubusercontent.com/openwisp/docker-openwisp/master/docs/images/portainer-docker-list.png
:target: https://raw.githubusercontent.com/openwisp/docker-openwisp/master/docs/images/portainer-docker-list.png

Documentation
-------------

- `Developer documentation
<https://openwisp.io/docs/dev/docker/developer/>`_
- `User documentation <https://openwisp.io/docs/dev/docker/>`_
2 changes: 1 addition & 1 deletion deploy/auto-install.sh
Original file line number Diff line number Diff line change
Expand Up @@ -300,7 +300,7 @@ init_help() {
echo -e ${NON}
}

## Parse command line arguements
## Parse command line arguments
while test $# != 0; do
case "$1" in
-i | --install) action='install' ;;
Expand Down
Loading
Loading