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.

Sign up for GitHub

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

Jump to bottom

docs: improve documentation #76

Merged
merged 4 commits into from
Aug 2, 2024
Merged

docs: improve documentation #76

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
82e2cfb
docs: fix font-family loading style
dcoa Jul 19, 2024
964508e
docs: enhance plugin documentation according with current tutor version
dcoa Jul 19, 2024
98beadc
docs: add indentation to code in list
dcoa Jul 23, 2024
4d69de6
docs: add badges status
dcoa Jul 23, 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
9 changes: 6 additions & 3 deletions README.md
View file
Open in desktop
BryanttV marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ TVM is a tool that allows you to manage several Tutor development environments s

TVM is also the acronym for:

- Tutor Version Manager: manages the version of Tutor.
- Tutor enVironment Manager: for creating project-based environments with Tutor.
- **Tutor Version Manager:** Handle the Tutor versions.
- **Tutor enVironment Manager:** Create project-based environments with Tutor.

# Installing TVM

Expand Down Expand Up @@ -58,9 +58,12 @@ source .tvm/bin/activate
5. Run your project.

```bash
BryanttV marked this conversation as resolved.
Show resolved Hide resolved
tutor local quickstart
tutor local launch
```

> [!NOTE]
> For Tutor versions <15, init a project with `tutor local quickstart`

You can start configuring and using your Tutor instance.

## Next steps
Expand Down
7 changes: 2 additions & 5 deletions docs/source/_static/css/custom.css
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
@font-face {
font-family: "PoppinsRegular";
src: url("https://energiasrenovables.edunext.io/asset-v1:energiasrenovables+er01+2022_T1+type@[email protected]") format('truetype');
}
@import url('https://fonts.googleapis.com/css2?family=Poppins&display=swap');


body {
padding-top: 0!important;
font-family: "PoppinsRegular", serif;
font-family: "Poppins", sans-serif;
width: 112% !important;
}

Expand Down
6 changes: 3 additions & 3 deletions docs/source/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
TVM
####

TVM is a tool that allows you to manage several Tutor development environments so that they work in isolation, and you can work on different projects with independent Tutor versions and configurations.
TVM is a tool that allows you to manage several Tutor development environments so that they work in isolation, and you can work on different projects with independent Tutor version and configurations.

User Guide
-----------
Expand All @@ -17,7 +17,7 @@ User Guide
Releases
---------

The Releases are listed on the `Github release page <https://github.com/eduNEXT/tvm/releases>`_. And all notable changes to this project are documented in the `CHANGELOG <https://github.com/eduNEXT/tvm/blob/main/CHANGELOG.md>`_ file.
The Releases are listed on the `Github release page <https://github.com/eduNEXT/tvm/releases>`_. All notable changes to this project are documented in the `CHANGELOG <https://github.com/eduNEXT/tvm/blob/main/CHANGELOG.md>`_ file.

Source code
-----------
Expand All @@ -27,7 +27,7 @@ The complete source code for TVM is available on Github: https://github.com/eduN
Support
--------

To get support, go to the TVM Github discussion forum: https://github.com/eduNEXT/tvm/discussions
Get support in the TVM Github discussion forum: https://github.com/eduNEXT/tvm/discussions

Contributing
-------------
Expand Down
4 changes: 2 additions & 2 deletions docs/source/tvm_advanced_information.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Advanced Information

TVM is the acronym for:

- Tutor Version Manager: manages the version of Tutor.
- Tutor enVironment Manager: for creating project-based environments with Tutor.
- Tutor Version Manager: handles the version of Tutor.
- Tutor enVironment Manager: creates project-based environments with Tutor.

To develop this tool, we separate the code into two apps accord the two meanings of TVM, and we use a `Hexagonal Architecture <https://en.wikipedia.org/wiki/Hexagonal_architecture_(software)>`_.
8 changes: 5 additions & 3 deletions docs/source/tvm_quickstart.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ TVM works with Tutor for that reason the Tutor requirements are also the TVM req
**Basic Requirements:**

- Software:
- `Docker <https://docs.docker.com/engine/installation/>`_: v18.06.0+
- `Docker Compose <https://docs.docker.com/compose/install/>`_: v1.22.0+
- `Docker <https://docs.docker.com/engine/installation/>`_: v24.0.5+ (with BuildKit 0.11+)
- `Docker Compose <https://docs.docker.com/compose/install/>`_: v2.0.0+
- Hardware:
- Minimum configuration: 4 GB RAM, 2 CPU, 8 GB disk space
- Recommended configuration: 8 GB RAM, 4 CPU, 25 GB disk space
Expand Down Expand Up @@ -66,7 +66,9 @@ Step by Step

.. code-block:: bash

tutor local quickstart
tutor local launch

.. note:: For Tutor versions <15, init a project with ``tutor local quickstart```


Next Steps
Expand Down
10 changes: 5 additions & 5 deletions docs/source/tvm_topic_guides/environment_manager.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Remove a Project Environment
# tvm project remove v14.0.0@tvm-test


.. note:: You can use the flag --prune to remove all the project folder. Ex: `tvm project remove v14.0.0@tvm-test --prune`
.. note:: You can use the flag --prune to remove all the project folder. E.g. ``tvm project remove v14.0.0@tvm-test --prune``


Activate a Project Environment
Expand All @@ -57,7 +57,7 @@ Deactivate a Project Environment
tvmoff


.. warning:: If you also have another environment like a python virtual environment, you need to deactivate each virtual environment in order. For example, if you have `(venv) [v12.2.0@project-name]`, you need to run `deactivate` and then `tvmoff`.
.. warning:: If you also have another environment like a python virtual environment, you need to deactivate each virtual environment in order. For example, if you have ``(venv) [v12.2.0@project-name]``, you need to run ``deactivate`` and then ``tvmoff``.

List Environments and Projects
--------------------------------
Expand All @@ -67,7 +67,7 @@ List Environments and Projects
tvm list


.. note:: You can use the flag -l or --limit and an integer to limit the output. Ex: `tvm list --limit 10`
.. note:: You can use the flag -l or --limit and an integer to restrict the output. E.g. ``tvm list --limit 10``

Install Tutor Plugins
----------------------
Expand All @@ -90,7 +90,7 @@ Pip
pip install <plugin>


.. note:: If you don't already have your project environment activated, you can activate it using `source .tvm/bin/activate`, and then you will be able to use the pip command.
.. note:: If you don't already have your project environment activated, you can activate it using ``source .tvm/bin/activate``, and then you will be able to use the pip command.


Uninstall Tutor Plugins
Expand All @@ -115,7 +115,7 @@ Pip
pip uninstall <plugin>


.. note:: If you don't already have your project environment activated, you can activate it using `source .tvm/bin/activate`, and then you will be able to use the pip command.
.. note:: If you don't already have your project environment activated, you can activate it using ``source .tvm/bin/activate``, and then you will be able to use the pip command.


Related
Expand Down
6 changes: 3 additions & 3 deletions docs/source/tvm_topic_guides/version_manager.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ List Environments and Projects
tvm list


.. note:: You can use the flag -l or --limit and an integer to limit the output. Ex: `tvm list --limit 10`
.. note:: You can use the flag -l or --limit and an integer to restrict the output. E.g. ``tvm list --limit 10``


Install Tutor Plugins
Expand All @@ -108,7 +108,7 @@ Pip
pip install <plugin>


.. note:: If you don't already have your project environment activated, you can activate it using `source .tvm/bin/activate`, and then you will be able to use the pip command.
.. note:: If you don't already have your project environment activated, you can activate it using ``source .tvm/bin/activate``, and then you will be able to use the pip command.


Uninstall Tutor Plugins
Expand All @@ -133,7 +133,7 @@ Pip
pip uninstall <plugin>


.. note:: If you don't already have your project environment activated, you can activate it using `source .tvm/bin/activate`, and then you will be able to use the pip command.
.. note:: If you don't already have your project environment activated, you can activate it using ``source .tvm/bin/activate``, and then you will be able to use the pip command.


Related
Expand Down
6 changes: 3 additions & 3 deletions docs/source/tvm_tutorials/creating_two_dev_env.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Creating two development environments
######################################

At the end of this Tutorial, you will have two different TVM Projects to have two development environments.
At the end of this tutorial, you will have two different TVM projects in two separate development environments.

Step by Step
-------------
Expand Down Expand Up @@ -43,7 +43,7 @@ Step by Step

.. code-block:: bash

tutor dev quickstart
tutor dev launch

#. Stop your project.

Expand All @@ -59,7 +59,7 @@ Step by Step

#. Repeat steps 3 to 8 using the project-name and tutor-version you want.

.. note:: You can have as many projects as you want, but you can't have two projects with the same name and tutor version.
.. note:: You can have as many projects as you want, but you can not have two projects with the same name and tutor version.

Next Steps
-----------
Expand Down
Loading