Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e421bcf5 authored by Manoj Nair's avatar Manoj Nair
Browse files

Merge branch '669-add-reference-to-update-documentation-in-the-device-info-screen' into 'master'

Resolve "Add reference to update documentation in the Device Info screen"

Closes #669

See merge request e/documentation/user!729
parents 86de62e3 f8649748
Loading
Loading
Loading
Loading
+38 −0
Original line number Diff line number Diff line
## Downloads for the {{ device.codename }}

[//]: # ( Stock download related )

{%- if device.before_install_args %}

{% capture upgrade_os_version %}
Before installing /e/OS on the  {{device.vendor}} {{device.name }} {{ device.codename }} for the first time, install the latest stock OS version {{ device.before_install_args.version }} build on the device
{% endcapture%}

{% include alerts/tip.html content = upgrade_os_version  %}

{%- endif %}

{%- if device.revert_to_stock %}

- If you need to revert to stock ROM (vendor provided ROM), Please follow the instructions given in the OS specific guide linked here


{%- for guide in device.revert_to_stock %}
     - {{ guide.os | capitalize}} OS  [Guide]({{guide.url | relative_url}})
{%- endfor %}
{%- endif  %}

{%- if device.name == "FP2" %}
{% include alerts/tip.html content = "Please note that the bootloader of the FP2 is unlocked by default."%}
{%-endif %}
{% assign backup_and_restore_with_twrp_link = "/pages/backup-and-restore-with-twrp" | relative_url%}

[//]: # ( Custom recovery install related )

{% if device.uses_twrp %}
    {% capture content %}
        Installing a custom recovery or unlocking the bootloader will erase all data on your device! [Take a backup]({{ backup_and_restore_with_twrp_link }}) of your data before proceeding!!
    {% endcapture %}
{% include alerts/tip.html content=content %}
{% endif %}



[//]: # ( Recovery related )

{% if device.custom_recovery %}
+5 −34
Original line number Diff line number Diff line
# Install {%- if device.minimal_os %} /e/ minimal {%- else %} /e/ {%- endif %}  on a {{ device.vendor }} {{ device.name }} - "{{ device.codename }}" {%- if device.is_beta %} (beta) {%- endif %}

{% include alerts/tip.html content="Please read through the instructions at least once before actually following them, so as to avoid any problems later." %}

The instructions in this guide will assist you to install /e/OS on your {{ device.codename }}. Please read through the instructions at least once before actually following them, so as to avoid any problems later.
{% if device.can_rollback != true %}
{% include alerts/warning.html content="Downgrading Smartphones already on Android Q or LineageOS 17.x to Pie or other OS can cause instability or at worst brick some devices" %}
It is important that you know that downgrading Smartphones on OS versions greater than the /e/OS OS version you plan to install, can cause instability or at worst brick some devices. We recommend that you check your current OS version, before attempting the installation.
{% endif %}

{% include alerts/danger.html content="Flash your device only if you **know** what you are doing and are OK taking the **associated risk**. All builds are provided as best effort, **without any guarantee**. The /e/ project and its project members deny any and all responsibility about the consequences of using /e/ software and or /e/ services." %}
It is advisable to flash your device only if you **know** what you are doing and are ok taking the **associated risk**. 
All /e/OS builds are provided as best effort, **without any guarantee**. The /e/OS project and its project members deny any and all responsibility about the consequences of using /e/OS software and or /e/OS services.

{% assign backup_and_restore_with_twrp_link = "/pages/backup-and-restore-with-twrp" | relative_url%}
{% if device.uses_twrp %}
    {% capture content %}
        Installing a custom recovery or unlocking the bootloader will erase all data on your device! [Take a backup]({{ backup_and_restore_with_twrp_link }}) of your data before proceeding!!
    {% endcapture %}
{% include alerts/tip.html content=content %}
{% endif %}

{% assign install_adb_link = "/pages/install-adb" | relative_url%}
{% assign enable_usb_debug_link = "/pages/enable-usb-debugging" | relative_url %}
@@ -37,31 +30,9 @@
{% endif %}
- Enable USB debugging on your device. You can find the instructions [here]({{ enable_usb_debug_link }})

{%- if device.should_be_latest_version != false %}
{% include alerts/danger.html content="Do not install /e/OS on top of a higher version of stock OS.
Before installing /e/OS ensure your device has the latest stock OS of the same version as /e/OS. If only lower versions of the stock are available then install the last available lower version before installing /e/OS. " %}
{%- endif %}

{%- if device.before_install_args %}

{% capture upgrade_os_version %}
Before installing /e/OS on the  {{device.vendor}} {{device.name }} {{ device.codename }} for the first time, install the latest stock OS version {{ device.before_install_args.version }} build on the device
{% endcapture%}

{% include alerts/tip.html content = upgrade_os_version  %}

{%- endif %}

{%- if device.revert_to_stock %}

- If you need to revert to stock ROM (vendor provided ROM), Please follow the instructions given in the OS specific guide linked here

{% include templates/suggestions.md %}
{%- for guide in device.revert_to_stock %}
     - {{ guide.os | capitalize}} OS  [Guide]({{guide.url | relative_url}})
{%- endfor %}
{%- endif  %}

{%- if device.name == "FP2" %}
{% include alerts/tip.html content = "Please note that the bootloader of the FP2 is unlocked by default."%}
{%-endif %}
+2 −5
Original line number Diff line number Diff line
{% capture tip_content %}
To suggest changes to this install guide documentation, please visit the {{ device.name }} specific [topic on our community forum]({{device.community_doc_url}}). 
To report issues in the build please refer [this guide]({% tl support-topics/report-an-issue %})
{% endcapture %}
Please share your experience , suggest tips or changes to this install guide documentation by visiting the {{ device.name }} specific [topic on our community forum]({{device.community_doc_url}}). 

{% include alerts/tip.html content=tip_content %}
To report issues in /e/OS please refer [this guide]({% tl support-topics/report-an-issue %})