From 255f0ef70cb45a18043d3c75f68c745d60206b5f Mon Sep 17 00:00:00 2001 From: Ignacio Van Droogenbroeck Date: Fri, 4 Sep 2020 15:44:47 -0300 Subject: [PATCH] re orders of folders and versions --- docs/index.md | 30 +++++++++++++++++++----------- docs/portainerce2.0.md | 0 mkdocs.yml | 10 ++++++---- v1.24.1/docs/index.md | 17 ----------------- v1.24.1/mkdocs.yml | 35 ----------------------------------- v2.0/docs/index.md | 17 ----------------- v2.0/mkdocs.yml | 35 ----------------------------------- 7 files changed, 25 insertions(+), 119 deletions(-) delete mode 100644 docs/portainerce2.0.md delete mode 100644 v1.24.1/docs/index.md delete mode 100644 v1.24.1/mkdocs.yml delete mode 100644 v2.0/docs/index.md delete mode 100644 v2.0/mkdocs.yml diff --git a/docs/index.md b/docs/index.md index 0b60926..8300859 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,17 +1,25 @@ # Welcome to Portainer Documentation -Welcome, in this Admin Guide / Help Documentation, you will find [mkdocs.org](https://www.mkdocs.org). +Welcome, in this Admin Guide / Help Documentation. -## Commands +This documentation is a Open Source project. You're welcome and encourage to contribute. -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. +## About Portainer -## Project layout +Portainer is a management tool simplifies container management in Docker, Swarm, Kubernetes, ACI and Edge environments. It's used by software engineers to speed up software deployments, troubleshoot problems and simplify migrations. - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. +Portainer works by hiding the complexity that makes managing contains hard behind an easy to use GUI. By negating the need for users to use CLI, write YAML or understand manifests, Portainer makes deploying apps and troubleshooting problems so simple, anyone can do it. + +The Portainer development team is here to assist you on your container journey; you can engage with them any time through our community-based support channels. + +## Support Channels + +You can find support in our [Slack Channel](https://portainer.slack.com/), [Forums](https://forums.portainer.io/) and [Discord](https://discord.com/invite/j8fVken). + +## Contributing +We welcome and encourage community contributions. +For information about contributing to the Portainer documentation, see [Contribution +guidelines](https://github.com/portainer/portainer-docs/blob/master/contributing.md). + +The [issues](https://github.com/portainer/portainer-docs/issues) of this repo is the place +manage our To Do. We encourage you to see what has to be done, take a task and contribute. \ No newline at end of file diff --git a/docs/portainerce2.0.md b/docs/portainerce2.0.md deleted file mode 100644 index e69de29..0000000 diff --git a/mkdocs.yml b/mkdocs.yml index 5077bcc..65fc02d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,9 +1,11 @@ site_name: Portainer Documentation nav: - Home: index.md - - Portainer 1.24.1 : /v1.24.1/ - - Portainer CE 2.0 : /v2.0/ - - Portainer Business: /be/ + - Portainer CE 2.0 : + - Deploying Portainer: + - 'Requirements' : '/v2.0/requirements.md' + - 'CLI options' : /v2.0/clioptions.md + - Portainer Business: portainer_business.md theme: features: - instant @@ -24,4 +26,4 @@ extra: - icon: fontawesome/brands/facebook link: https://twitter.com/squidfunk - icon: fontawesome/brands/reddit - link: https://twitter.com/squidfunk \ No newline at end of file + link: https://twitter.com/squidfunk diff --git a/v1.24.1/docs/index.md b/v1.24.1/docs/index.md deleted file mode 100644 index 000ea34..0000000 --- a/v1.24.1/docs/index.md +++ /dev/null @@ -1,17 +0,0 @@ -# Welcome to MkDocs - -For full documentation visit [mkdocs.org](https://www.mkdocs.org). - -## Commands - -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. - -## Project layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. diff --git a/v1.24.1/mkdocs.yml b/v1.24.1/mkdocs.yml deleted file mode 100644 index adb3c99..0000000 --- a/v1.24.1/mkdocs.yml +++ /dev/null @@ -1,35 +0,0 @@ -site_name: Portainer Documentation -nav: - - Home: index.md - - 'Portainer CE 2.0' : - - 'Deploying Portainer' : 'deployce.md' - - 'Adding Endpoints' : 'addingendpointsce.md' - - 'Adding Authentication Sources' : 'authenticationce.md' - - 'Creating and Managing users' : 'usersce.md' - - 'Creating and Managing Teams' : 'teamsce.md' - - 'Configuring Registries' : 'registriesce.md' - - 'Configuring Portainer Settings' : 'settingsce.md' - - 'Advanced Deployments' : 'adeploymentsce.md' - - 'Portainer Deployment Troubleshooting' : 'troubleshootingce.md' - - Portainer Business: portainer_business.md -theme: - features: - - instant - logo: assets/logo.png - name: material - palette: - primary: light-blue -repo_name: portainer/portainer -repo_url: https://github.com/portainer/portainer -extra: - social: - - icon: fontawesome/brands/twitter - link: https://twitter.com/squidfunk - - icon: fontawesome/brands/linkedin - link: https://twitter.com/squidfunk - - icon: fontawesome/brands/youtube - link: https://twitter.com/squidfunk - - icon: fontawesome/brands/facebook - link: https://twitter.com/squidfunk - - icon: fontawesome/brands/reddit - link: https://twitter.com/squidfunk \ No newline at end of file diff --git a/v2.0/docs/index.md b/v2.0/docs/index.md deleted file mode 100644 index 000ea34..0000000 --- a/v2.0/docs/index.md +++ /dev/null @@ -1,17 +0,0 @@ -# Welcome to MkDocs - -For full documentation visit [mkdocs.org](https://www.mkdocs.org). - -## Commands - -* `mkdocs new [dir-name]` - Create a new project. -* `mkdocs serve` - Start the live-reloading docs server. -* `mkdocs build` - Build the documentation site. -* `mkdocs -h` - Print help message and exit. - -## Project layout - - mkdocs.yml # The configuration file. - docs/ - index.md # The documentation homepage. - ... # Other markdown pages, images and other files. diff --git a/v2.0/mkdocs.yml b/v2.0/mkdocs.yml deleted file mode 100644 index 1631291..0000000 --- a/v2.0/mkdocs.yml +++ /dev/null @@ -1,35 +0,0 @@ -site_name: Portainer Documentation -nav: - - Home: index.md - - 'Portainer CE 2.0' : - - 'Deploying Portainer' : 'deployce.md' - - 'Adding Endpoints' : 'addingendpointsce.md' - - 'Adding Authentication Sources' : 'authenticationce.md' - - 'Creating and Managing users' : 'usersce.md' - - 'Creating and Managing Teams' : 'teamsce.md' - - 'Configuring Registries' : 'registriesce.md' - - 'Configuring Portainer Settings' : 'settingsce.md' - - 'Advanced Deployments' : 'adeploymentsce.md' - - 'Portainer Deployment Troubleshooting' : 'troubleshootingce.md' - - Portainer Business: portainer_business.md -theme: - features: - - instant - logo: assets/logo.png - name: material - palette: - primary: light-blue -repo_name: portainer/portainer -repo_url: https://github.com/portainer/portainer-docs -extra: - social: - - icon: fontawesome/brands/twitter - link: https://twitter.com/squidfunk - - icon: fontawesome/brands/linkedin - link: https://twitter.com/squidfunk - - icon: fontawesome/brands/youtube - link: https://twitter.com/squidfunk - - icon: fontawesome/brands/facebook - link: https://twitter.com/squidfunk - - icon: fontawesome/brands/reddit - link: https://twitter.com/squidfunk