Add docs for PIO Account

This commit is contained in:
Ivan Kravets
2016-10-26 21:07:43 +03:00
parent c2bf38f873
commit 4247f448a8
9 changed files with 329 additions and 97 deletions

View File

@@ -0,0 +1,42 @@
.. Copyright 2014-present PlatformIO <contact@platformio.org>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.. _cmd_account_forgot:
platformio account forgot
=========================
.. contents::
Usage
-----
.. code-block:: bash
platformio account forgot [OPTIONS]
Description
-----------
Allows you to reset password for :ref:`userguide_account` using E-Mail that
was specified for registration.
Options
~~~~~~~
.. program:: platformio account forgot
.. option::
--username, -u
User name (E-Mail). You can omit this option and enter E-Mail in Forgot
Wizard later.

View File

@@ -0,0 +1,46 @@
.. Copyright 2014-present PlatformIO <contact@platformio.org>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.. _cmd_account_login:
platformio account login
=========================
.. contents::
Usage
-----
.. code-block:: bash
platformio account login [OPTIONS]
Description
-----------
Log in to :ref:`userguide_account`.
Options
~~~~~~~
.. program:: platformio account login
.. option::
--username, -u
User name (E-Mail). You can omit this option and enter E-Mail in Login Wizard
later.
.. option::
--password, -p
You can omit this option and enter securely password in Login Wizard later.

View File

@@ -0,0 +1,30 @@
.. Copyright 2014-present PlatformIO <contact@platformio.org>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.. _cmd_account_logout:
platformio account logout
=========================
.. contents::
Usage
-----
.. code-block:: bash
platformio account logout
Description
-----------
Log out of :ref:`userguide_account`.

View File

@@ -0,0 +1,30 @@
.. Copyright 2014-present PlatformIO <contact@platformio.org>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.. _cmd_account_password:
platformio account password
===========================
.. contents::
Usage
-----
.. code-block:: bash
platformio account password
Description
-----------
Change password for :ref:`userguide_account`.

View File

@@ -0,0 +1,41 @@
.. Copyright 2014-present PlatformIO <contact@platformio.org>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.. _cmd_account_register:
platformio account register
===========================
.. contents::
Usage
-----
.. code-block:: bash
platformio account register [OPTIONS]
Description
-----------
Log in to :ref:`userguide_account`.
Options
~~~~~~~
.. program:: platformio account register
.. option::
--username, -u
User name (E-Mail). You can omit this option and enter E-Mail in Register
Wizard later.

View File

@@ -0,0 +1,37 @@
.. Copyright 2014-present PlatformIO <contact@platformio.org>
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
.. _userguide_account:
PIO Account
===========
Having **PIO Account** allows you to use extra professional features from
`PlatformIO Plus <https://pioplus.com/>`__:
* :ref:`unit_testing`
To print all available commands and options use:
.. code-block:: bash
platformio account --help
platformio account COMMAND --help
.. toctree::
:maxdepth: 2
cmd_forgot
cmd_login
cmd_logout
cmd_password
cmd_register