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

Commit bd58cf22 authored by Romain Hunault's avatar Romain Hunault 💻
Browse files

First fixes

parent b8cd1e25
Loading
Loading
Loading
Loading

.markdownlint.json

0 → 100644
+3 −0
Original line number Diff line number Diff line
{
    "MD013": false
}
 No newline at end of file
+11 −8
Original line number Diff line number Diff line
# General information
# e Foundation wiki

## General information

The current documentation uses [Jekyll](https://jekyllrb.com/docs) as the static site generator. [Docker](https://www.docker.com/) is required to run the project.

# How to run
## How to run

## Jekyll container only
### Jekyll container only

For faster development process, the following command is recommended:

@@ -28,7 +31,7 @@ Or you could use:
docker run --rm --volume="$PWD/htdocs:/srv/jekyll" -p 4000:4000 -it jekyll/jekyll:4.2.0 jekyll serve
```

## Full compose stack (search)
### Full compose stack (search)

Add `edocs.local` to your `/etc/hosts` or customize `NGINX_HOST` in .env as desired.

@@ -38,7 +41,7 @@ docker-compose up -d
docker-compose exec -T bridge_server python main.py /public_html
```

## Update dependencies
### Update dependencies

```bash
docker run --rm -v="$PWD/htdocs:/srv"-it ruby:3.3.0 /bin/bash bundle update
@@ -46,14 +49,14 @@ docker run --rm -v="$PWD/htdocs:/srv"-it ruby:3.3.0 /bin/bash bundle update

Then, commit and push

# How to test
## How to test

## [Markdown Lint](https://github.com/markdownlint/markdownlint)
### [Markdown Lint](https://github.com/markdownlint/markdownlint)

```bash
docker run --rm -v="$PWD/htdocs:/srv" -it ruby:2.7.1 /bin/bash bundle update && mdl *
```

# Deployment
## Deployment

Since this project depends on [ElasticSearch](https://www.elastic.co/), the deployment should follow the recommended approach and configuration as detailed in [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html)
+5 −0
Original line number Diff line number Diff line
{
    "MD041": false,
    "MD013": false,
    "MD036": false
}
 No newline at end of file
+16 −11
Original line number Diff line number Diff line
@@ -7,16 +7,21 @@ In some cases, the inactive slot can be unpopulated or contain much older firmwa
To do this, sideload the `copy-partitions-20220613-signed.zip` package by doing the following:

1. Download the `copy-partitions-20220613-signed.zip` file from [here](https://mirrorbits.lineageos.org/tools/copy-partitions-20220613-signed.zip). It should have a MD5 sum of `79f2f860830f023b7030c29bfbea7737` or a SHA-256 sum of `92f03b54dc029e9ca2d68858c14b649974838d73fdb006f9a07a503f2eddd2cd`.

{%- if device.uses_twrp %}

 2. Sideload the `copy-partitions-20220613-signed.zip` package:
1. Sideload the `copy-partitions-20220613-signed.zip` package:

* On the device, select `Advanced`, `ADB Sideload`, then swipe to begin sideload
* On the host machine, sideload the package using: `adb sideload copy-partitions-20220613-signed.zip`

{%- else %}

  2. Sideload the `copy-partitions-20220613-signed.zip` package:
1. Sideload the `copy-partitions-20220613-signed.zip` package:

* On the device, select `Apply Update`, then `Apply from ADB` to begin sideload.
* On the host machine, sideload the package using: `adb sideload copy-partitions-20220613-signed.zip`

  3. Now reboot to recovery by tapping `Advanced`, then `Reboot to recovery`.
1. Now reboot to recovery by tapping `Advanced`, then `Reboot to recovery`.

{%- endif %}
+19 −7
Original line number Diff line number Diff line
@@ -16,7 +16,6 @@ Before installing /e/OS on the {{device.vendor}} {{device.name }} {{ device.cod

- 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 %}
@@ -36,8 +35,6 @@ Before installing /e/OS on the {{device.vendor}} {{device.name }} {{ device.cod
{% include alerts/tip.html content=content %}
{% endif %}



[//]: # ( Recovery related )

{% if device.custom_recovery %}
@@ -49,10 +46,14 @@ Before installing /e/OS on the {{device.vendor}} {{device.name }} {{ device.cod
Try the /e/OS Recovery (**limited functionality**)

{% if device.build_version_stable %}

- [/e/OS Recovery for stable build](https://images.ecloud.global/stable/{{ device.codename }})

{% endif %}
{% if device.build_version_dev %}

- [/e/OS Recovery for dev build](https://images.ecloud.global/dev/{{ device.codename }})

{% endif %}

{% endif %}
@@ -60,14 +61,15 @@ Try the /e/OS Recovery (**limited functionality**)

[//]: # ( Patches related )


{% if device.additional_downloads.additional_patch %}
Additional Patches :
Flash this [patch]({{ device.additional_downloads.additional_patch }}) on your {{ device.codename }} before flashing /e/OS
{% endif %}

{% if device.additional_downloads.latest_firmware %}

- Latest [firmware zip file]({{device.additional_downloads.latest_firmware}})

{% endif %}

[//]: # ( Build type related )
@@ -78,21 +80,25 @@ Flash this [patch]({{ device.additional_downloads.additional_patch }}) on your {
{%- endif %}

{% if device.build_version_dev %}

- /e/OS build : [{{ device.build_version_dev }} dev](https://images.ecloud.global/dev/{{ device.codename }}) {{ security_patch }}
{%- endif %}

{%- endif %}

{% if device.build_version_stable %}

- /e/OS build : [{{ device.build_version_stable }} stable](https://images.ecloud.global/stable/{{ device.codename }}) {{ security_patch }}

{%- endif %}

> To understand the difference between /e/OS builds check [this guide](/build-status)

[//]: # ( Before Install related )


{% if device.before_e_install %}

- Check the **Pre-Install Instructions** section below for some additional downloads for your device.

{% endif  %}

{% if device.additional_downloads.file %}
@@ -101,11 +107,17 @@ Flash this [patch]({{ device.additional_downloads.additional_patch }}) on your {
{% endif %}

{% if device.additional_downloads.stockupgrade %}

- Stock ROM : [here]({{ device.additional_downloads.stockupgrade }})

{% if device.additional_downloads.stockupgrade_tool %}

- Stock flashing tool : [here]({{ device.additional_downloads.stockupgrade_tool }})

{% if device.additional_downloads.stockupgrade_toolver %}

- Tool version tested {{ device.additional_downloads.stockupgrade_toolver }}

{% endif %}
{% endif %}

Loading