diff --git a/docs/application/description.md b/docs/application/description.md index 78af641d658e80709b4f8a5568d23635cad507e7..f9ae077498a80a1b87d00b6ba37910536e3a8940 100644 --- a/docs/application/description.md +++ b/docs/application/description.md @@ -1,3 +1,5 @@ !!! info "" :construction: Section under Construction :construction: +Ecolyo is a [Cozy](https://docs.cozy.io/en/) application that allows users to connect their energy accounts such as **EGL**, **ENEDIS** and **GRDF**, using cozy [konnectors](https://docs.cozy.io/en/cozy-stack/konnectors/) + diff --git a/docs/application/gitflow.md b/docs/application/gitflow.md index 2f4f692dba5c6228a0130fccce621b4c7e2d7452..c8d8c657929b4fc6d0382659ef3865652cb13c5d 100644 --- a/docs/application/gitflow.md +++ b/docs/application/gitflow.md @@ -1,2 +1,78 @@ !!! info "" - :construction: Section under Construction :construction: \ No newline at end of file + :construction: Section under Construction :construction: + +## Initialize +- Create a new projet in gitlab and take note of its url + +### Protecting Master Branch + +On the gitlab page of your project go to *Settings/Repository* in the *Protected Branches* section. +Select the **Master** branch and set **allow to merge** to ***Master*** and **allow to push** to **No one** +This will prevent anyone to push on the master branch, the only way to add code to the branch will be using merge requests. + +### Setting Development Branch +- Retrieve the project on your computer, open a command line and execute. + +``` +git clone https://forge.grandlyon.com/web-et-numerique/llle.git +``` +- Create the development branch + +``` +git checkout -b dev +``` + +- Init your project and then type any time you want to commit changes: + +``` +git add . +git commit -m "Commit changes" +git push origin dev +``` + +## Start Developing +For any other development you should create a branch from the development branch. + +First make sure to be on the ***dev*** branch, type: +``` +git branch +``` +> to see your current branch + +### Conventional Commits + +The commit contains the following structural **types**: +- fix +- feature + +In our team organisation we are using IceScrum to keep track of our User Stories (US). Each US is identified by a number. In order to easily identify the commit that refers to the US, a `feature` branch name should follow this structure: + +- *features/<number of the User Story\>-<title_of_the_user_story\>* + +You can create the branch by typing: +``` +git checkout -b features/<number of the User Story>-<title_of_the_user_story> +``` + +> Note that the **feature** type is the only one with a dedicated folder (features/-US). + +Each fix branch should be named as the following *fix-\<title_of_the_fix\>*. + +You can create the branch by typing: +``` +git checkout -b fix-<title_of_the_fix> +``` + +**Breaking Change** +Appends a `!` before the title of the commit to notify that a breaking change has happened. Give a solid description of the changes as well. + + +**Types** other than fix and feature are allowed, for example *build*, *chore*, *ci*, *docs*, *style*, *refactor*, *perf*, *test* and others. + +**add tag** +``` +git tag -a 1.0.0 -m "complementary message" +``` +### Gitflow Scheme + + \ No newline at end of file diff --git a/docs/application/scaffolding.md b/docs/application/scaffolding.md new file mode 100644 index 0000000000000000000000000000000000000000..f4cc03a8a29092db1f8d4d95bb73e38313d7d84e --- /dev/null +++ b/docs/application/scaffolding.md @@ -0,0 +1,35 @@ +In this section, you will find information about the project file structure and the purpose of the main folders. + +##Source Files + +Folder/File | Purpose +------------ | ------------- +assets | The application's assets, contains fonts, svg and png files +components/CommonKit | In this folder you'll find global components such as Buttons, Cards, Icons, etc... Many of these components are overrided material-ui components +components/ContainerComponents | In this folder you'll find parent components which calls chlidren **Content Components** +components/ContentComponents | In this folder you'll find every content component that are called by **Container Components** +components/Contexts | This folder contains the component used to set the context of the application +components/Hooks | This folder contains the hooks of the application +App.jsx | The root component, it calls the Container component '**ViewContainer**' which is our main component +db | In this folder, you'll find JSON data used for challenges, ecogestures, and the FAQ. +doctypes| This folder contains the **cozy** doctypes, you can see more on [Cozy Documentation](https://github.com/cozy/cozy-doctypes) +enum| This folder contains enums for Fluid types, Screen types, and Timesteps. +locales| This folder contains JSON data used by the translation system i18n provided by [Cozy-ui](https://github.com/cozy/cozy-ui) +services| Here you'll find all the services +styles | The styles folder you'll find a **base** folder that contains our variables and a **components** folder that contains components styles +targets | +utils | In this folder you'll find utilitaries methods + +##Configuration Files + +Folder/File | Purpose +------------ | ------------- +.eslintrc.js | Config file for ESLint +gitlab-ci.yml | Config file used for Gitlab continuous integration +.prettierrc | Config file for Prettier extension +config.json | Config file for fluid types +jest.config.js | Config file used by Jest for testing the application +manifest.webapp | Manifest of the application, used by cozy for the managment of permissions, you can add permissions for doctypes there +tsconfig.json | Config file for TypeScript + + diff --git a/docs/img/gitflow.png b/docs/img/gitflow.png new file mode 100644 index 0000000000000000000000000000000000000000..a24cca82e8db634170e318600eaa36a6483f749e Binary files /dev/null and b/docs/img/gitflow.png differ diff --git a/mkdocs.yml b/mkdocs.yml index 6bdca619494655d6b54d486cb91c2553f3fa1e79..6b0f046da5e3ec934e01f10a58fabe8e4c4b4cad 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,41 +1,42 @@ site_name: LLLE-Ecolyo Technical Docs site_description: LLLE Project Documentation with Markdown. site_author: LLLE Team -repo_name: 'Clone the Project' -repo_url: 'https://forge.grandlyon.com/web-et-numerique/llle_project/llle_docs' +repo_name: "Clone the Project" +repo_url: "https://forge.grandlyon.com/web-et-numerique/llle_project/llle_docs" theme: - name: 'material' - # logo: 'assets/favicon.ico' - # favicon: 'assets/favicon.ico' - palette: - primary: 'black' - accent: 'Deep Orange' + name: "material" + # logo: 'assets/favicon.ico' + # favicon: 'assets/favicon.ico' + palette: + primary: "black" + accent: "Deep Orange" markdown_extensions: - - admonition - - attr_list - - plantuml_markdown: - server: http://www.plantuml.com/plantuml - - pymdownx.emoji + - admonition + - attr_list + - plantuml_markdown: + server: http://www.plantuml.com/plantuml + - pymdownx.emoji nav: - - Home: index.md - - Getting started: - - Setup your environment: getting_started/setup_your_environment.md - - Launch the application on local : getting_started/launch_local_application.md - - Launch a konnector on local : getting_started/launch_local_konnector.md - - Project Architecture: - - Architecture : project_architecture/architecture.md - - Cozy : project_architecture/cozy.md - - Environments : project_architecture/environments.md - - DocTypes : project_architecture/doctypes.md - - Application: - - Description: application/description.md - - Gitflow: application/gitflow.md - - Konnectors: - - Enedis: konnectors/enedis.md - - GRDF: konnectors/grdf.md - - Eau du Grand Lyon: konnectors/egl.md - - Proxy: - - Description: proxy/description.md + - Home: index.md + - Getting started: + - Setup your environment: getting_started/setup_your_environment.md + - Launch the application on local: getting_started/launch_local_application.md + - Launch a konnector on local: getting_started/launch_local_konnector.md + - Project Architecture: + - Architecture: project_architecture/architecture.md + - Cozy: project_architecture/cozy.md + - Environments: project_architecture/environments.md + - DocTypes: project_architecture/doctypes.md + - Application: + - Description: application/description.md + - Scaffolding: application/scaffolding.md + - Gitflow: application/gitflow.md + - Konnectors: + - Enedis: konnectors/enedis.md + - GRDF: konnectors/grdf.md + - Eau du Grand Lyon: konnectors/egl.md + - Proxy: + - Description: proxy/description.md diff --git a/site/404.html b/site/404.html index 3d6412470645b99530e4c0c7bb5cda381dec3920..e2c8f90bb4fb32419cb99a4e8b44a8fac86aeff9 100644 --- a/site/404.html +++ b/site/404.html @@ -1,482 +1,469 @@ +<!DOCTYPE html> +<html lang="en" class="no-js"> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width,initial-scale=1" /> + <meta http-equiv="x-ua-compatible" content="ie=edge" /> + <meta + name="description" + content="LLLE Project Documentation with Markdown." + /> + <meta name="author" content="LLLE Team" /> + <meta name="lang:clipboard.copy" content="Copy to clipboard" /> -<!doctype html> -<html lang="en" class="no-js"> - <head> - - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width,initial-scale=1"> - <meta http-equiv="x-ua-compatible" content="ie=edge"> - - <meta name="description" content="LLLE Project Documentation with Markdown."> - - - - <meta name="author" content="LLLE Team"> - - - <meta name="lang:clipboard.copy" content="Copy to clipboard"> - - <meta name="lang:clipboard.copied" content="Copied to clipboard"> - - <meta name="lang:search.language" content="en"> - - <meta name="lang:search.pipeline.stopwords" content="True"> - - <meta name="lang:search.pipeline.trimmer" content="True"> - - <meta name="lang:search.result.none" content="No matching documents"> - - <meta name="lang:search.result.one" content="1 matching document"> - - <meta name="lang:search.result.other" content="# matching documents"> - - <meta name="lang:search.tokenizer" content="[\s\-]+"> - - <link rel="shortcut icon" href="/assets/images/favicon.png"> - <meta name="generator" content="mkdocs-1.1, mkdocs-material-4.6.3"> - - - - <title>LLLE-Ecolyo Technical Docs</title> - - - - <link rel="stylesheet" href="/assets/stylesheets/application.adb8469c.css"> - - <link rel="stylesheet" href="/assets/stylesheets/application-palette.a8b3c06d.css"> - - - - - <meta name="theme-color" content="#757575"> - - - - <script src="/assets/javascripts/modernizr.86422ebf.js"></script> - - - - <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> - <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback"> - <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style> - - - <link rel="stylesheet" href="/assets/fonts/material-icons.css"> - - - - - - + <meta name="lang:clipboard.copied" content="Copied to clipboard" /> + + <meta name="lang:search.language" content="en" /> + + <meta name="lang:search.pipeline.stopwords" content="True" /> + + <meta name="lang:search.pipeline.trimmer" content="True" /> + + <meta name="lang:search.result.none" content="No matching documents" /> + + <meta name="lang:search.result.one" content="1 matching document" /> + + <meta name="lang:search.result.other" content="# matching documents" /> + + <meta name="lang:search.tokenizer" content="[\s\-]+" /> + + <link rel="shortcut icon" href="/assets/images/favicon.png" /> + <meta name="generator" content="mkdocs-1.1, mkdocs-material-4.6.3" /> + + <title>LLLE-Ecolyo Technical Docs</title> + + <link + rel="stylesheet" + href="/assets/stylesheets/application.adb8469c.css" + /> + + <link + rel="stylesheet" + href="/assets/stylesheets/application-palette.a8b3c06d.css" + /> + + <meta name="theme-color" content="#757575" /> + + <script src="/assets/javascripts/modernizr.86422ebf.js"></script> + + <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin /> + <link + rel="stylesheet" + href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback" + /> + <style> + body, + input { + font-family: "Roboto", "Helvetica Neue", Helvetica, Arial, sans-serif; + } + code, + kbd, + pre { + font-family: "Roboto Mono", "Courier New", Courier, monospace; + } + </style> + + <link rel="stylesheet" href="/assets/fonts/material-icons.css" /> </head> - - - - <body dir="ltr" data-md-color-primary="grey" data-md-color-accent="deep-orange"> - + + <body + dir="ltr" + data-md-color-primary="grey" + data-md-color-accent="deep-orange" + > <svg class="md-svg"> - <defs> - - - </defs> + <defs></defs> </svg> - <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> - <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> - <label class="md-overlay" data-md-component="overlay" for="__drawer"></label> - - - <header class="md-header" data-md-component="header"> - <nav class="md-header-nav md-grid"> - <div class="md-flex"> - <div class="md-flex__cell md-flex__cell--shrink"> - <a href="/." title="LLLE-Ecolyo Technical Docs" aria-label="LLLE-Ecolyo Technical Docs" class="md-header-nav__button md-logo"> - - <i class="md-icon">î Œ</i> - - </a> - </div> - <div class="md-flex__cell md-flex__cell--shrink"> - <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> - </div> - <div class="md-flex__cell md-flex__cell--stretch"> - <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> - - <span class="md-header-nav__topic"> - LLLE-Ecolyo Technical Docs - </span> - <span class="md-header-nav__topic"> - - - - </span> - - </div> - </div> - <div class="md-flex__cell md-flex__cell--shrink"> - - <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> - -<div class="md-search" data-md-component="search" role="dialog"> - <label class="md-search__overlay" for="__search"></label> - <div class="md-search__inner" role="search"> - <form class="md-search__form" name="search"> - <input type="text" class="md-search__input" aria-label="search" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> - <label class="md-icon md-search__icon" for="__search"></label> - <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> -  - </button> - </form> - <div class="md-search__output"> - <div class="md-search__scrollwrap" data-md-scrollfix> - <div class="md-search-result" data-md-component="result"> - <div class="md-search-result__meta"> - Type to start searching + <input + class="md-toggle" + data-md-toggle="drawer" + type="checkbox" + id="__drawer" + autocomplete="off" + /> + <input + class="md-toggle" + data-md-toggle="search" + type="checkbox" + id="__search" + autocomplete="off" + /> + <label + class="md-overlay" + data-md-component="overlay" + for="__drawer" + ></label> + + <header class="md-header" data-md-component="header"> + <nav class="md-header-nav md-grid"> + <div class="md-flex"> + <div class="md-flex__cell md-flex__cell--shrink"> + <a + href="/." + title="LLLE-Ecolyo Technical Docs" + aria-label="LLLE-Ecolyo Technical Docs" + class="md-header-nav__button md-logo" + > + <i class="md-icon">î Œ</i> + </a> </div> - <ol class="md-search-result__list"></ol> - </div> - </div> - </div> - </div> -</div> - - </div> - - <div class="md-flex__cell md-flex__cell--shrink"> - <div class="md-header-nav__source"> - - - - - -<a href="https://forge.grandlyon.com/web-et-numerique/llle_project/llle_docs" title="Go to repository" class="md-source" data-md-source=""> - - <div class="md-source__repository"> - llle_docs - </div> -</a> + <div class="md-flex__cell md-flex__cell--shrink"> + <label + class="md-icon md-icon--menu md-header-nav__button" + for="__drawer" + ></label> + </div> + <div class="md-flex__cell md-flex__cell--stretch"> + <div + class="md-flex__ellipsis md-header-nav__title" + data-md-component="title" + > + <span class="md-header-nav__topic"> + LLLE-Ecolyo Technical Docs + </span> + <span class="md-header-nav__topic"> </span> + </div> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <label + class="md-icon md-icon--search md-header-nav__button" + for="__search" + ></label> + + <div class="md-search" data-md-component="search" role="dialog"> + <label class="md-search__overlay" for="__search"></label> + <div class="md-search__inner" role="search"> + <form class="md-search__form" name="search"> + <input + type="text" + class="md-search__input" + aria-label="search" + name="query" + placeholder="Search" + autocapitalize="off" + autocorrect="off" + autocomplete="off" + spellcheck="false" + data-md-component="query" + data-md-state="active" + /> + <label class="md-icon md-search__icon" for="__search"></label> + <button + type="reset" + class="md-icon md-search__icon" + data-md-component="reset" + tabindex="-1" + > +  + </button> + </form> + <div class="md-search__output"> + <div class="md-search__scrollwrap" data-md-scrollfix> + <div class="md-search-result" data-md-component="result"> + <div class="md-search-result__meta"> + Type to start searching + </div> + <ol class="md-search-result__list"></ol> + </div> + </div> + </div> + </div> + </div> + </div> + + <div class="md-flex__cell md-flex__cell--shrink"> + <div class="md-header-nav__source"> + <a + href="https://forge.grandlyon.com/web-et-numerique/llle_project/llle_docs" + title="Go to repository" + class="md-source" + data-md-source="" + > + <div class="md-source__repository"> + llle_docs + </div> + </a> + </div> </div> </div> - - </div> - </nav> -</header> - + </nav> + </header> + <div class="md-container"> - - - - <main class="md-main" role="main"> <div class="md-main__inner md-grid" data-md-component="container"> - - - <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> - <div class="md-sidebar__scrollwrap"> - <div class="md-sidebar__inner"> - <nav class="md-nav md-nav--primary" data-md-level="0"> - <label class="md-nav__title md-nav__title--site" for="__drawer"> - <a href="/." title="LLLE-Ecolyo Technical Docs" class="md-nav__button md-logo"> - - <i class="md-icon">î Œ</i> - - </a> - LLLE-Ecolyo Technical Docs - </label> - - <div class="md-nav__source"> - - - - - -<a href="https://forge.grandlyon.com/web-et-numerique/llle_project/llle_docs" title="Go to repository" class="md-source" data-md-source=""> - - <div class="md-source__repository"> - llle_docs - </div> -</a> - </div> - - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - <li class="md-nav__item"> - <a href="/." title="Home" class="md-nav__link"> - Home - </a> - </li> - - - - - - - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2"> - - <label class="md-nav__link" for="nav-2"> - Project Architecture - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> - <label class="md-nav__title" for="nav-2"> - Project Architecture - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - - <li class="md-nav__item"> - <a href="/architecture/architecture-home/" title="Introduction" class="md-nav__link"> - Introduction - </a> - </li> - - - - - - - - <li class="md-nav__item"> - <a href="/architecture/client/client.md" title="Client" class="md-nav__link"> - Client - </a> - </li> - - - - - - - - <li class="md-nav__item"> - <a href="/architecture/cozy/cozy.md" title="Cozy" class="md-nav__link"> - Cozy - </a> - </li> - - - - - - - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2-4" type="checkbox" id="nav-2-4"> - - <label class="md-nav__link" for="nav-2-4"> - Konnectors - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> - <label class="md-nav__title" for="nav-2-4"> - Konnectors - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - - <li class="md-nav__item"> - <a href="/architecture/konnectors/konnectors-intro/" title="Introduction" class="md-nav__link"> - Introduction - </a> - </li> - - - - - - - - <li class="md-nav__item"> - <a href="/architecture/konnectors/enedis/" title="Enedis" class="md-nav__link"> - Enedis - </a> - </li> - - - - - - - - <li class="md-nav__item"> - <a href="/architecture/konnectors/egl/" title="EGL" class="md-nav__link"> - EGL - </a> - </li> - - - - - - - - <li class="md-nav__item"> - <a href="/architecture/konnectors/gdrf.md" title="GDRF - Celery" class="md-nav__link"> - GDRF - Celery - </a> - </li> - - - </ul> - </nav> - </li> - - - </ul> - </nav> - </li> - - - - - - - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3"> - - <label class="md-nav__link" for="nav-3"> - About - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> - <label class="md-nav__title" for="nav-3"> - About - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - - <li class="md-nav__item"> - <a href="/miscellaneous/gitflow/" title="Gitflow" class="md-nav__link"> - Gitflow - </a> - </li> - - - - - - - - <li class="md-nav__item"> - <a href="/miscellaneous/glossary/" title="Glossary" class="md-nav__link"> - Glossary - </a> - </li> - - - - - - - - <li class="md-nav__item"> - <a href="/miscellaneous/tools/" title="Tools" class="md-nav__link"> - Tools - </a> - </li> - - - - - - - - <li class="md-nav__item"> - <a href="/miscellaneous/devenv/" title="Environment" class="md-nav__link"> - Environment - </a> - </li> - - - - - - - - <li class="md-nav__item"> - <a href="/miscellaneous/vscode-settings/" title="VSCode" class="md-nav__link"> - VSCode - </a> - </li> - - - </ul> - </nav> - </li> - - - </ul> -</nav> + <div + class="md-sidebar md-sidebar--primary" + data-md-component="navigation" + > + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + <nav class="md-nav md-nav--primary" data-md-level="0"> + <label + class="md-nav__title md-nav__title--site" + for="__drawer" + > + <a + href="/." + title="LLLE-Ecolyo Technical Docs" + class="md-nav__button md-logo" + > + <i class="md-icon">î Œ</i> + </a> + LLLE-Ecolyo Technical Docs + </label> + + <div class="md-nav__source"> + <a + href="https://forge.grandlyon.com/web-et-numerique/llle_project/llle_docs" + title="Go to repository" + class="md-source" + data-md-source="" + > + <div class="md-source__repository"> + llle_docs + </div> + </a> </div> - </div> + + <ul class="md-nav__list" data-md-scrollfix> + <li class="md-nav__item"> + <a href="/." title="Home" class="md-nav__link"> + Home + </a> + </li> + + <li class="md-nav__item md-nav__item--nested"> + <input + class="md-toggle md-nav__toggle" + data-md-toggle="nav-2" + type="checkbox" + id="nav-2" + /> + + <label class="md-nav__link" for="nav-2"> + Project Architecture + </label> + <nav + class="md-nav" + data-md-component="collapsible" + data-md-level="1" + > + <label class="md-nav__title" for="nav-2"> + Project Architecture + </label> + <ul class="md-nav__list" data-md-scrollfix> + <li class="md-nav__item"> + <a + href="/architecture/architecture-home/" + title="Introduction" + class="md-nav__link" + > + Introduction + </a> + </li> + + <li class="md-nav__item"> + <a + href="/architecture/client/client.md" + title="Client" + class="md-nav__link" + > + Client + </a> + </li> + + <li class="md-nav__item"> + <a + href="/architecture/cozy/cozy.md" + title="Cozy" + class="md-nav__link" + > + Cozy + </a> + </li> + + <li class="md-nav__item md-nav__item--nested"> + <input + class="md-toggle md-nav__toggle" + data-md-toggle="nav-2-4" + type="checkbox" + id="nav-2-4" + /> + + <label class="md-nav__link" for="nav-2-4"> + Konnectors + </label> + <nav + class="md-nav" + data-md-component="collapsible" + data-md-level="2" + > + <label class="md-nav__title" for="nav-2-4"> + Konnectors + </label> + <ul class="md-nav__list" data-md-scrollfix> + <li class="md-nav__item"> + <a + href="/architecture/konnectors/konnectors-intro/" + title="Introduction" + class="md-nav__link" + > + Introduction + </a> + </li> + + <li class="md-nav__item"> + <a + href="/architecture/konnectors/enedis/" + title="Enedis" + class="md-nav__link" + > + Enedis + </a> + </li> + + <li class="md-nav__item"> + <a + href="/architecture/konnectors/egl/" + title="EGL" + class="md-nav__link" + > + EGL + </a> + </li> + + <li class="md-nav__item"> + <a + href="/architecture/konnectors/gdrf.md" + title="GDRF - Celery" + class="md-nav__link" + > + GDRF - Celery + </a> + </li> + </ul> + </nav> + </li> + </ul> + </nav> + </li> + + <li class="md-nav__item md-nav__item--nested"> + <input + class="md-toggle md-nav__toggle" + data-md-toggle="nav-3" + type="checkbox" + id="nav-3" + /> + + <label class="md-nav__link" for="nav-3"> + About + </label> + <nav + class="md-nav" + data-md-component="collapsible" + data-md-level="1" + > + <label class="md-nav__title" for="nav-3"> + About + </label> + <ul class="md-nav__list" data-md-scrollfix> + <li class="md-nav__item"> + <a + href="/miscellaneous/gitflow/" + title="Gitflow" + class="md-nav__link" + > + Gitflow + </a> + </li> + + <li class="md-nav__item"> + <a + href="/miscellaneous/glossary/" + title="Glossary" + class="md-nav__link" + > + Glossary + </a> + </li> + + <li class="md-nav__item"> + <a + href="/miscellaneous/tools/" + title="Tools" + class="md-nav__link" + > + Tools + </a> + </li> + + <li class="md-nav__item"> + <a + href="/miscellaneous/devenv/" + title="Environment" + class="md-nav__link" + > + Environment + </a> + </li> + + <li class="md-nav__item"> + <a + href="/miscellaneous/vscode-settings/" + title="VSCode" + class="md-nav__link" + > + VSCode + </a> + </li> + </ul> + </nav> + </li> + </ul> + </nav> </div> - - - + </div> + </div> + <div class="md-content"> <article class="md-content__inner md-typeset"> - - <h1>404 - Not found</h1> - - - - - - + <h1>404 - Not found</h1> </article> </div> </div> </main> - - -<footer class="md-footer"> - - <div class="md-footer-meta md-typeset"> - <div class="md-footer-meta__inner md-grid"> - <div class="md-footer-copyright"> - - powered by - <a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a> - and - <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> - Material for MkDocs</a> - </div> - - </div> - </div> -</footer> - + + <footer class="md-footer"> + <div class="md-footer-meta md-typeset"> + <div class="md-footer-meta__inner md-grid"> + <div class="md-footer-copyright"> + powered by + <a href="https://www.mkdocs.org" target="_blank" rel="noopener" + >MkDocs</a + > + and + <a + href="https://squidfunk.github.io/mkdocs-material/" + target="_blank" + rel="noopener" + > + Material for MkDocs</a + > + </div> + </div> + </div> + </footer> </div> - - <script src="/assets/javascripts/application.c33a9706.js"></script> - - <script>app.initialize({version:"1.1",url:{base:"/"}})</script> - - + + <script src="/assets/javascripts/application.c33a9706.js"></script> + + <script> + app.initialize({ version: "1.1", url: { base: "/" } }); + </script> </body> -</html> \ No newline at end of file +</html> diff --git a/site/index.html b/site/index.html index 845ad5a04b28322d8c02731e0eb67d5c6690b7f3..a9a0d65b686177fd41b30f139fa4692e6f9dbc49 100644 --- a/site/index.html +++ b/site/index.html @@ -1,597 +1,581 @@ - - - - -<!doctype html> +<!DOCTYPE html> <html lang="en" class="no-js"> <head> - - <meta charset="utf-8"> - <meta name="viewport" content="width=device-width,initial-scale=1"> - <meta http-equiv="x-ua-compatible" content="ie=edge"> - - <meta name="description" content="LLLE Project Documentation with Markdown."> - - - - <meta name="author" content="LLLE Team"> - - - <meta name="lang:clipboard.copy" content="Copy to clipboard"> - - <meta name="lang:clipboard.copied" content="Copied to clipboard"> - - <meta name="lang:search.language" content="en"> - - <meta name="lang:search.pipeline.stopwords" content="True"> - - <meta name="lang:search.pipeline.trimmer" content="True"> - - <meta name="lang:search.result.none" content="No matching documents"> - - <meta name="lang:search.result.one" content="1 matching document"> - - <meta name="lang:search.result.other" content="# matching documents"> - - <meta name="lang:search.tokenizer" content="[\s\-]+"> - - <link rel="shortcut icon" href="assets/images/favicon.png"> - <meta name="generator" content="mkdocs-1.1, mkdocs-material-4.6.3"> - - - - <title>LLLE-Ecolyo Technical Docs</title> - - - - <link rel="stylesheet" href="assets/stylesheets/application.adb8469c.css"> - - <link rel="stylesheet" href="assets/stylesheets/application-palette.a8b3c06d.css"> - - - - - <meta name="theme-color" content="#757575"> - - - - <script src="assets/javascripts/modernizr.86422ebf.js"></script> - - - - <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin> - <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback"> - <style>body,input{font-family:"Roboto","Helvetica Neue",Helvetica,Arial,sans-serif}code,kbd,pre{font-family:"Roboto Mono","Courier New",Courier,monospace}</style> - - - <link rel="stylesheet" href="assets/fonts/material-icons.css"> - - - - - - - </head> - - - - <body dir="ltr" data-md-color-primary="grey" data-md-color-accent="deep-orange"> - - <svg class="md-svg"> - <defs> - - - </defs> - </svg> - <input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off"> - <input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off"> - <label class="md-overlay" data-md-component="overlay" for="__drawer"></label> - - <a href="#description" tabindex="0" class="md-skip"> - Skip to content - </a> - - - <header class="md-header" data-md-component="header"> - <nav class="md-header-nav md-grid"> - <div class="md-flex"> - <div class="md-flex__cell md-flex__cell--shrink"> - <a href="." title="LLLE-Ecolyo Technical Docs" aria-label="LLLE-Ecolyo Technical Docs" class="md-header-nav__button md-logo"> - - <i class="md-icon">î Œ</i> - - </a> - </div> - <div class="md-flex__cell md-flex__cell--shrink"> - <label class="md-icon md-icon--menu md-header-nav__button" for="__drawer"></label> - </div> - <div class="md-flex__cell md-flex__cell--stretch"> - <div class="md-flex__ellipsis md-header-nav__title" data-md-component="title"> - - <span class="md-header-nav__topic"> - LLLE-Ecolyo Technical Docs - </span> - <span class="md-header-nav__topic"> - - Home - - </span> - - </div> - </div> - <div class="md-flex__cell md-flex__cell--shrink"> - - <label class="md-icon md-icon--search md-header-nav__button" for="__search"></label> - -<div class="md-search" data-md-component="search" role="dialog"> - <label class="md-search__overlay" for="__search"></label> - <div class="md-search__inner" role="search"> - <form class="md-search__form" name="search"> - <input type="text" class="md-search__input" aria-label="search" name="query" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="query" data-md-state="active"> - <label class="md-icon md-search__icon" for="__search"></label> - <button type="reset" class="md-icon md-search__icon" data-md-component="reset" tabindex="-1"> -  - </button> - </form> - <div class="md-search__output"> - <div class="md-search__scrollwrap" data-md-scrollfix> - <div class="md-search-result" data-md-component="result"> - <div class="md-search-result__meta"> - Type to start searching - </div> - <ol class="md-search-result__list"></ol> - </div> - </div> - </div> - </div> -</div> - - </div> - - <div class="md-flex__cell md-flex__cell--shrink"> - <div class="md-header-nav__source"> - - - - - -<a href="https://forge.grandlyon.com/web-et-numerique/llle_project/llle_docs" title="Go to repository" class="md-source" data-md-source=""> - - <div class="md-source__repository"> - llle_docs - </div> -</a> - </div> - </div> - - </div> - </nav> -</header> - - <div class="md-container"> - - - - - <main class="md-main" role="main"> - <div class="md-main__inner md-grid" data-md-component="container"> - - - <div class="md-sidebar md-sidebar--primary" data-md-component="navigation"> - <div class="md-sidebar__scrollwrap"> - <div class="md-sidebar__inner"> - <nav class="md-nav md-nav--primary" data-md-level="0"> - <label class="md-nav__title md-nav__title--site" for="__drawer"> - <a href="." title="LLLE-Ecolyo Technical Docs" class="md-nav__button md-logo"> - - <i class="md-icon">î Œ</i> - - </a> - LLLE-Ecolyo Technical Docs - </label> - - <div class="md-nav__source"> - + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width,initial-scale=1" /> + <meta http-equiv="x-ua-compatible" content="ie=edge" /> + <meta + name="description" + content="LLLE Project Documentation with Markdown." + /> - + <meta name="author" content="LLLE Team" /> -<a href="https://forge.grandlyon.com/web-et-numerique/llle_project/llle_docs" title="Go to repository" class="md-source" data-md-source=""> - - <div class="md-source__repository"> - llle_docs - </div> -</a> - </div> - - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - - - <li class="md-nav__item md-nav__item--active"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="toc" type="checkbox" id="__toc"> - - - <label class="md-nav__link md-nav__link--active" for="__toc"> - Home - </label> - - <a href="." title="Home" class="md-nav__link md-nav__link--active"> - Home - </a> - - -<nav class="md-nav md-nav--secondary"> - - - - <label class="md-nav__title" for="__toc">Table of contents</label> - <ul class="md-nav__list" data-md-scrollfix> - - <li class="md-nav__item"> - <a href="#description" class="md-nav__link"> - Description - </a> - -</li> - - <li class="md-nav__item"> - <a href="#contact" class="md-nav__link"> - Contact - </a> - -</li> - - - - - - </ul> - -</nav> - - </li> - - - - - - - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2" type="checkbox" id="nav-2"> - - <label class="md-nav__link" for="nav-2"> - Project Architecture - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> - <label class="md-nav__title" for="nav-2"> - Project Architecture - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - - <li class="md-nav__item"> - <a href="architecture/architecture-home/" title="Introduction" class="md-nav__link"> - Introduction - </a> - </li> + <meta name="lang:clipboard.copy" content="Copy to clipboard" /> - - - - + <meta name="lang:clipboard.copied" content="Copied to clipboard" /> + <meta name="lang:search.language" content="en" /> - <li class="md-nav__item"> - <a href="architecture/client/client.md" title="Client" class="md-nav__link"> - Client - </a> - </li> + <meta name="lang:search.pipeline.stopwords" content="True" /> - - - - + <meta name="lang:search.pipeline.trimmer" content="True" /> + <meta name="lang:search.result.none" content="No matching documents" /> - <li class="md-nav__item"> - <a href="architecture/cozy/cozy.md" title="Cozy" class="md-nav__link"> - Cozy - </a> - </li> - - - - - - - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-2-4" type="checkbox" id="nav-2-4"> - - <label class="md-nav__link" for="nav-2-4"> - Konnectors - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="2"> - <label class="md-nav__title" for="nav-2-4"> - Konnectors - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - - <li class="md-nav__item"> - <a href="architecture/konnectors/konnectors-intro/" title="Introduction" class="md-nav__link"> - Introduction - </a> - </li> - - - - - - - - <li class="md-nav__item"> - <a href="architecture/konnectors/enedis/" title="Enedis" class="md-nav__link"> - Enedis - </a> - </li> - - - - - - - - <li class="md-nav__item"> - <a href="architecture/konnectors/egl/" title="EGL" class="md-nav__link"> - EGL - </a> - </li> - - - - - + <meta name="lang:search.result.one" content="1 matching document" /> + <meta name="lang:search.result.other" content="# matching documents" /> - <li class="md-nav__item"> - <a href="architecture/konnectors/gdrf.md" title="GDRF - Celery" class="md-nav__link"> - GDRF - Celery - </a> - </li> - - - </ul> - </nav> - </li> - - - </ul> - </nav> - </li> - - - - - - - - <li class="md-nav__item md-nav__item--nested"> - - <input class="md-toggle md-nav__toggle" data-md-toggle="nav-3" type="checkbox" id="nav-3"> - - <label class="md-nav__link" for="nav-3"> - About - </label> - <nav class="md-nav" data-md-component="collapsible" data-md-level="1"> - <label class="md-nav__title" for="nav-3"> - About - </label> - <ul class="md-nav__list" data-md-scrollfix> - - - - - - - - <li class="md-nav__item"> - <a href="miscellaneous/gitflow/" title="Gitflow" class="md-nav__link"> - Gitflow - </a> - </li> - - - - - + <meta name="lang:search.tokenizer" content="[\s\-]+" /> + <link rel="shortcut icon" href="assets/images/favicon.png" /> + <meta name="generator" content="mkdocs-1.1, mkdocs-material-4.6.3" /> - <li class="md-nav__item"> - <a href="miscellaneous/glossary/" title="Glossary" class="md-nav__link"> - Glossary - </a> - </li> + <title>LLLE-Ecolyo Technical Docs</title> - - - - + <link rel="stylesheet" href="assets/stylesheets/application.adb8469c.css" /> + <link + rel="stylesheet" + href="assets/stylesheets/application-palette.a8b3c06d.css" + /> - <li class="md-nav__item"> - <a href="miscellaneous/tools/" title="Tools" class="md-nav__link"> - Tools - </a> - </li> + <meta name="theme-color" content="#757575" /> - - - - + <script src="assets/javascripts/modernizr.86422ebf.js"></script> + <link href="https://fonts.gstatic.com" rel="preconnect" crossorigin /> + <link + rel="stylesheet" + href="https://fonts.googleapis.com/css?family=Roboto:300,400,400i,700%7CRoboto+Mono&display=fallback" + /> + <style> + body, + input { + font-family: "Roboto", "Helvetica Neue", Helvetica, Arial, sans-serif; + } + code, + kbd, + pre { + font-family: "Roboto Mono", "Courier New", Courier, monospace; + } + </style> - <li class="md-nav__item"> - <a href="miscellaneous/devenv/" title="Environment" class="md-nav__link"> - Environment - </a> - </li> - - - - - - + <link rel="stylesheet" href="assets/fonts/material-icons.css" /> + </head> - <li class="md-nav__item"> - <a href="miscellaneous/vscode-settings/" title="VSCode" class="md-nav__link"> - VSCode + <body + dir="ltr" + data-md-color-primary="grey" + data-md-color-accent="deep-orange" + > + <svg class="md-svg"> + <defs></defs> + </svg> + <input + class="md-toggle" + data-md-toggle="drawer" + type="checkbox" + id="__drawer" + autocomplete="off" + /> + <input + class="md-toggle" + data-md-toggle="search" + type="checkbox" + id="__search" + autocomplete="off" + /> + <label + class="md-overlay" + data-md-component="overlay" + for="__drawer" + ></label> + + <a href="#description" tabindex="0" class="md-skip"> + Skip to content </a> - </li> - - </ul> - </nav> - </li> - - - </ul> -</nav> + <header class="md-header" data-md-component="header"> + <nav class="md-header-nav md-grid"> + <div class="md-flex"> + <div class="md-flex__cell md-flex__cell--shrink"> + <a + href="." + title="LLLE-Ecolyo Technical Docs" + aria-label="LLLE-Ecolyo Technical Docs" + class="md-header-nav__button md-logo" + > + <i class="md-icon">î Œ</i> + </a> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <label + class="md-icon md-icon--menu md-header-nav__button" + for="__drawer" + ></label> + </div> + <div class="md-flex__cell md-flex__cell--stretch"> + <div + class="md-flex__ellipsis md-header-nav__title" + data-md-component="title" + > + <span class="md-header-nav__topic"> + LLLE-Ecolyo Technical Docs + </span> + <span class="md-header-nav__topic"> + Home + </span> + </div> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <label + class="md-icon md-icon--search md-header-nav__button" + for="__search" + ></label> + + <div class="md-search" data-md-component="search" role="dialog"> + <label class="md-search__overlay" for="__search"></label> + <div class="md-search__inner" role="search"> + <form class="md-search__form" name="search"> + <input + type="text" + class="md-search__input" + aria-label="search" + name="query" + placeholder="Search" + autocapitalize="off" + autocorrect="off" + autocomplete="off" + spellcheck="false" + data-md-component="query" + data-md-state="active" + /> + <label class="md-icon md-search__icon" for="__search"></label> + <button + type="reset" + class="md-icon md-search__icon" + data-md-component="reset" + tabindex="-1" + > +  + </button> + </form> + <div class="md-search__output"> + <div class="md-search__scrollwrap" data-md-scrollfix> + <div class="md-search-result" data-md-component="result"> + <div class="md-search-result__meta"> + Type to start searching + </div> + <ol class="md-search-result__list"></ol> + </div> </div> </div> </div> - - - <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> - <div class="md-sidebar__scrollwrap"> - <div class="md-sidebar__inner"> - -<nav class="md-nav md-nav--secondary"> - - - - <label class="md-nav__title" for="__toc">Table of contents</label> - <ul class="md-nav__list" data-md-scrollfix> - - <li class="md-nav__item"> - <a href="#description" class="md-nav__link"> - Description - </a> - -</li> - - <li class="md-nav__item"> - <a href="#contact" class="md-nav__link"> - Contact - </a> - -</li> - - - - - - </ul> - -</nav> - </div> + </div> + </div> + + <div class="md-flex__cell md-flex__cell--shrink"> + <div class="md-header-nav__source"> + <a + href="https://forge.grandlyon.com/web-et-numerique/llle_project/llle_docs" + title="Go to repository" + class="md-source" + data-md-source="" + > + <div class="md-source__repository"> + llle_docs </div> + </a> + </div> + </div> + </div> + </nav> + </header> + + <div class="md-container"> + <main class="md-main" role="main"> + <div class="md-main__inner md-grid" data-md-component="container"> + <div + class="md-sidebar md-sidebar--primary" + data-md-component="navigation" + > + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + <nav class="md-nav md-nav--primary" data-md-level="0"> + <label + class="md-nav__title md-nav__title--site" + for="__drawer" + > + <a + href="." + title="LLLE-Ecolyo Technical Docs" + class="md-nav__button md-logo" + > + <i class="md-icon">î Œ</i> + </a> + LLLE-Ecolyo Technical Docs + </label> + + <div class="md-nav__source"> + <a + href="https://forge.grandlyon.com/web-et-numerique/llle_project/llle_docs" + title="Go to repository" + class="md-source" + data-md-source="" + > + <div class="md-source__repository"> + llle_docs + </div> + </a> + </div> + + <ul class="md-nav__list" data-md-scrollfix> + <li class="md-nav__item md-nav__item--active"> + <input + class="md-toggle md-nav__toggle" + data-md-toggle="toc" + type="checkbox" + id="__toc" + /> + + <label + class="md-nav__link md-nav__link--active" + for="__toc" + > + Home + </label> + + <a + href="." + title="Home" + class="md-nav__link md-nav__link--active" + > + Home + </a> + + <nav class="md-nav md-nav--secondary"> + <label class="md-nav__title" for="__toc" + >Table of contents</label + > + <ul class="md-nav__list" data-md-scrollfix> + <li class="md-nav__item"> + <a href="#description" class="md-nav__link"> + Description + </a> + </li> + + <li class="md-nav__item"> + <a href="#contact" class="md-nav__link"> + Contact + </a> + </li> + </ul> + </nav> + </li> + + <li class="md-nav__item md-nav__item--nested"> + <input + class="md-toggle md-nav__toggle" + data-md-toggle="nav-2" + type="checkbox" + id="nav-2" + /> + + <label class="md-nav__link" for="nav-2"> + Project Architecture + </label> + <nav + class="md-nav" + data-md-component="collapsible" + data-md-level="1" + > + <label class="md-nav__title" for="nav-2"> + Project Architecture + </label> + <ul class="md-nav__list" data-md-scrollfix> + <li class="md-nav__item"> + <a + href="architecture/architecture-home/" + title="Introduction" + class="md-nav__link" + > + Introduction + </a> + </li> + + <li class="md-nav__item"> + <a + href="architecture/client/client.md" + title="Client" + class="md-nav__link" + > + Client + </a> + </li> + + <li class="md-nav__item"> + <a + href="architecture/cozy/cozy.md" + title="Cozy" + class="md-nav__link" + > + Cozy + </a> + </li> + + <li class="md-nav__item md-nav__item--nested"> + <input + class="md-toggle md-nav__toggle" + data-md-toggle="nav-2-4" + type="checkbox" + id="nav-2-4" + /> + + <label class="md-nav__link" for="nav-2-4"> + Konnectors + </label> + <nav + class="md-nav" + data-md-component="collapsible" + data-md-level="2" + > + <label class="md-nav__title" for="nav-2-4"> + Konnectors + </label> + <ul class="md-nav__list" data-md-scrollfix> + <li class="md-nav__item"> + <a + href="architecture/konnectors/konnectors-intro/" + title="Introduction" + class="md-nav__link" + > + Introduction + </a> + </li> + + <li class="md-nav__item"> + <a + href="architecture/konnectors/enedis/" + title="Enedis" + class="md-nav__link" + > + Enedis + </a> + </li> + + <li class="md-nav__item"> + <a + href="architecture/konnectors/egl/" + title="EGL" + class="md-nav__link" + > + EGL + </a> + </li> + + <li class="md-nav__item"> + <a + href="architecture/konnectors/gdrf.md" + title="GDRF - Celery" + class="md-nav__link" + > + GDRF - Celery + </a> + </li> + </ul> + </nav> + </li> + </ul> + </nav> + </li> + + <li class="md-nav__item md-nav__item--nested"> + <input + class="md-toggle md-nav__toggle" + data-md-toggle="nav-3" + type="checkbox" + id="nav-3" + /> + + <label class="md-nav__link" for="nav-3"> + About + </label> + <nav + class="md-nav" + data-md-component="collapsible" + data-md-level="1" + > + <label class="md-nav__title" for="nav-3"> + About + </label> + <ul class="md-nav__list" data-md-scrollfix> + <li class="md-nav__item"> + <a + href="miscellaneous/gitflow/" + title="Gitflow" + class="md-nav__link" + > + Gitflow + </a> + </li> + + <li class="md-nav__item"> + <a + href="miscellaneous/glossary/" + title="Glossary" + class="md-nav__link" + > + Glossary + </a> + </li> + + <li class="md-nav__item"> + <a + href="miscellaneous/tools/" + title="Tools" + class="md-nav__link" + > + Tools + </a> + </li> + + <li class="md-nav__item"> + <a + href="miscellaneous/devenv/" + title="Environment" + class="md-nav__link" + > + Environment + </a> + </li> + + <li class="md-nav__item"> + <a + href="miscellaneous/vscode-settings/" + title="VSCode" + class="md-nav__link" + > + VSCode + </a> + </li> + </ul> + </nav> + </li> + </ul> + </nav> </div> - - + </div> + </div> + + <div class="md-sidebar md-sidebar--secondary" data-md-component="toc"> + <div class="md-sidebar__scrollwrap"> + <div class="md-sidebar__inner"> + <nav class="md-nav md-nav--secondary"> + <label class="md-nav__title" for="__toc" + >Table of contents</label + > + <ul class="md-nav__list" data-md-scrollfix> + <li class="md-nav__item"> + <a href="#description" class="md-nav__link"> + Description + </a> + </li> + + <li class="md-nav__item"> + <a href="#contact" class="md-nav__link"> + Contact + </a> + </li> + </ul> + </nav> + </div> + </div> + </div> + <div class="md-content"> <article class="md-content__inner md-typeset"> - - - - <h1>Home</h1> - - <h2 id="description">Description</h2> -<p>LLLE - Ecolyo is a multi-fluid application solution towards users of grand lyon metropolis to monitor and optimize the energy consumption of their home. It is a multi-device application with a mobile first approach.</p> -<div class="admonition info"> -<p>If you are a new developper tasked to work on this project, check the <a href="miscellaneous/tools/">recommended tools</a> and setup your <a href="miscellaneous/devenv/">environment</a>. Then we also suggest you to get familiar with the <a href="miscellaneous/glossary/">vocabulary</a> used to build this app.</p> -</div> -<h2 id="contact">Contact</h2> - - - - - - - - - - + <h1>Home</h1> + + <h2 id="description">Description</h2> + <p> + LLLE - Ecolyo is a multi-fluid application solution towards + users of grand lyon metropolis to monitor and optimize the + energy consumption of their home. It is a multi-device + application with a mobile first approach. + </p> + <div class="admonition info"> + <p> + If you are a new developper tasked to work on this project, + check the + <a href="miscellaneous/tools/">recommended tools</a> and setup + your <a href="miscellaneous/devenv/">environment</a>. Then we + also suggest you to get familiar with the + <a href="miscellaneous/glossary/">vocabulary</a> used to build + this app. + </p> + </div> + <h2 id="contact">Contact</h2> </article> </div> </div> </main> - - -<footer class="md-footer"> - - <div class="md-footer-nav"> - <nav class="md-footer-nav__inner md-grid"> - - - <a href="architecture/architecture-home/" title="Introduction" class="md-flex md-footer-nav__link md-footer-nav__link--next" rel="next"> - <div class="md-flex__cell md-flex__cell--stretch md-footer-nav__title"> - <span class="md-flex__ellipsis"> - <span class="md-footer-nav__direction"> - Next + + <footer class="md-footer"> + <div class="md-footer-nav"> + <nav class="md-footer-nav__inner md-grid"> + <a + href="architecture/architecture-home/" + title="Introduction" + class="md-flex md-footer-nav__link md-footer-nav__link--next" + rel="next" + > + <div + class="md-flex__cell md-flex__cell--stretch md-footer-nav__title" + > + <span class="md-flex__ellipsis"> + <span class="md-footer-nav__direction"> + Next + </span> + Introduction </span> - Introduction - </span> - </div> - <div class="md-flex__cell md-flex__cell--shrink"> - <i class="md-icon md-icon--arrow-forward md-footer-nav__button"></i> + </div> + <div class="md-flex__cell md-flex__cell--shrink"> + <i + class="md-icon md-icon--arrow-forward md-footer-nav__button" + ></i> + </div> + </a> + </nav> + </div> + + <div class="md-footer-meta md-typeset"> + <div class="md-footer-meta__inner md-grid"> + <div class="md-footer-copyright"> + powered by + <a href="https://www.mkdocs.org" target="_blank" rel="noopener" + >MkDocs</a + > + and + <a + href="https://squidfunk.github.io/mkdocs-material/" + target="_blank" + rel="noopener" + > + Material for MkDocs</a + > </div> - </a> - - </nav> - </div> - - <div class="md-footer-meta md-typeset"> - <div class="md-footer-meta__inner md-grid"> - <div class="md-footer-copyright"> - - powered by - <a href="https://www.mkdocs.org" target="_blank" rel="noopener">MkDocs</a> - and - <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener"> - Material for MkDocs</a> - </div> - - </div> - </div> -</footer> - + </div> + </div> + </footer> </div> - - <script src="assets/javascripts/application.c33a9706.js"></script> - - <script>app.initialize({version:"1.1",url:{base:"."}})</script> - - + + <script src="assets/javascripts/application.c33a9706.js"></script> + + <script> + app.initialize({ version: "1.1", url: { base: "." } }); + </script> </body> -</html> \ No newline at end of file +</html>