WIP #120 (initiated vuepress doc) [skip app] [skip ios] [skip android]

.travis.yml

@@ -7,8 +7,10 @@ notifications:
     on_failure: always
 
 stages:
-- name: BUILD
+- name: APP
   if: commit_message !~ /(skip[ _-]app)/
+- name: DOC
+  if: commit_message !~ /\[skip doc\]/
 - name: ANDROID
   if: commit_message !~ /(skip[ _-]android)/
 - name: IOS
@@ -17,7 +19,7 @@ stages:
 jobs:
   include:
 
-  - stage: BUILD
+  - stage: APP
     os: linux
     language: node_js
     node_js:
@@ -29,6 +31,20 @@ jobs:
     script:
     - bash .travis.app.sh
 
+  - stage: DOC
+    os: linux
+    language: node_js
+    node_js:
+    - '12.16'
+    install: true
+    script: cd docs && yarn install && yarn build 
+    deploy:
+      provider: pages
+      local-dir: docs/.vuepress/dist
+      skip-cleanup: true
+      github-token: $GITHUB_TOKEN  # Set in the settings page of your repository, as a secure variable
+      keep-history: true
+
   - stage: ANDROID
     os: linux
     language: android

LICENSE.md

@@ -1,2 +1,21 @@
-Copyright (c) 2018-2019 Kalisio
-All rights Reserved
+MIT License
+
+Copyright (c) 2017-20xx Kalisio
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docs/.vuepress/config.js

@@ -0,0 +1,87 @@
+module.exports = {
+  base: '/aktnmap/',
+  title: `Akt'n'Map`,
+  description: 'Situational intelligence solution to inform and coordinate fieldworkers',
+  head: [
+    ['link', { rel: 'icon', href: `https://s3.eu-central-1.amazonaws.com/kalisioscope/aktnmap/aktnmap-icon-64x64.png` }],
+    ['link', { rel: 'manifest', href: '/manifest.json' }]
+  ],
+  locales: {
+    '/': {
+      lang: 'en',
+      title: `Akt'n'Map`,
+      description: 'Situational intelligence solution to inform and coordinate fieldworkers',
+    },
+    '/fr/': {
+      lang: 'fr',
+      title: `Akt'n'Map`,
+      description: `Solution d'intelligence situationnelle pour informer et coordonner les acteurs de terrain`,
+    },
+  },
+  theme: 'kalisio',
+  themeConfig: {
+    docsDir: 'docs',
+    locales: {
+      '/': {
+        label: 'English',
+        selectText: 'Languages',
+        nav: [
+          { text: 'Quickstart', link: '/quickstart/' },
+          { text: 'Go further', link: '/gofurther/' },
+          { text: 'About', link: '/about/' }
+        ],
+        sidebar: {
+          '/quickstart/': getQuickStartSidebar(),
+          '/gofurther/': getGoFurtherSidebar(),
+          '/about/': getAboutSidebar()
+        }
+      },
+      '/fr/': {
+        label: 'Français',
+        selectText: 'Langues',
+        nav: [
+          { text: 'Démarrer', link: '/fr/quickstart/' },
+          { text: 'Aller plus loin', link: '/fr/gofurther/' },
+          { text: 'A propos', link: '/fr/about/' }
+        ],
+        sidebar: {
+          '/fr/quickstart/': getQuickStartSidebar(),
+          '/fr/gofurther/': getGoFurtherSidebar(),
+          '/fr/about/': getAboutSidebar()
+        }
+      },
+    }
+  },
+  head: [
+    [
+      "link",
+      {
+        rel: "stylesheet",
+        href: "https://maxst.icons8.com/vue-static/landings/line-awesome/line-awesome/1.3.0/css/line-awesome.min.css"
+      }
+    ]
+  ]
+}
+
+function getQuickStartSidebar () {
+  return [
+    '',
+    'features',
+    'benefits'
+  ]
+}
+
+function getGoFurtherSidebar () {
+  return [
+    ''
+  ]
+}
+
+function getAboutSidebar () {
+  return [
+    '',
+    'contributing',
+    'license',
+    'contact'
+  ]
+}

docs/.vuepress/public/manifest.json

@@ -0,0 +1,25 @@
+{
+  "name": "Akt'n'Map",
+  "short_name": "Akt'n'Map",
+  "icons": [
+    {
+      "src": "https://s3.eu-central-1.amazonaws.com/kalisioscope/aktnmap/aktnmap-logo-black-128x128.png",
+      "sizes": "128x128",
+      "type": "image/png"
+    },
+    {
+      "src": "https://s3.eu-central-1.amazonaws.com/kalisioscope/aktnmap/aktnmap-logo-black-192x192.png",
+      "sizes": "192x192",
+      "type": "image/png"
+    },
+    {
+      "src": "https://s3.eu-central-1.amazonaws.com/kalisioscope/kalisio/aktnmap-logo-black-512x512.png",
+      "sizes": "512x512",
+      "type": "image/png"
+    }
+  ],
+  "start_url": "/index.html",
+  "display": "standalone",
+  "background_color": "#fff",
+  "theme_color": "#3eaf7c"
+}

docs/README.md

@@ -0,0 +1,19 @@
+---
+home: true
+heroImage: https://s3.eu-central-1.amazonaws.com/kalisioscope/aktnmap/aktnmap-icon-256x256.png
+actionText: Ready to start ?
+actionLink: /quickstart/
+features:
+- title: Customisable
+  details: Define your own organization and business processes
+- title: Smooth
+  details: Mobilize instantly, track progress in realtime and make your teams intervene with ease
+- title: Mobility oriented
+  details: Run it on any device from anywhere on the field
+footer: MIT Licensed | Copyright © 2017-20xx Kalisio
+---
+
+<p align="center">
+	<center><h3>Sponsored by</h3></center>
+	<a href="https://kalisio.com"><img src="https://s3.eu-central-1.amazonaws.com/kalisioscope/kalisio/kalisio-logo-black-256x84.png"></a>
+</p>

docs/about/README.md

@@ -0,0 +1,22 @@
+# About
+
+**Akt'n'Map** is an Open Source project available on [GitHub](https://github.com/kalisio/aktnmap).
+
+It also relies on a development and deployment stack composed of:
+* [KDK](https://kalisio.github.io/kdk/), a development kit to simplify the development of geospatial applications
+* [Kano](https://kalisio.github.io/kdk/), a powerful 2D/3D geospatial data visualizer
+* [Weacast](https://weacast.github.io/weacast-docs/), weather forecast data management platform
+* [Kargo](https://kalisio.github.io/kargo/), a solution to deploy geospatial services
+* [Kaabah](https://github.com/kalisio/kaabah), a solution to build and operate infrastructures
+
+## Roadmap
+
+The roadmap is available on [Github](https://github.com/kalisio/aktnmap/projects/1).
+
+## Milestones
+
+The milestones are available on [Github](https://github.com/kalisio/aktnmap/milestones)
+
+## Release Notes
+
+The changelog is available in [Github](https://github.com/kalisio/aktnmap/blob/master/CHANGELOG.md)

docs/about/contact.md

@@ -0,0 +1,5 @@
+# Contact
+
+End user ? Cantact us on our [website](https://aktnmap.com/).
+
+Developer ? Please feel free to join our [slack channel](https://kalisio.slack.com/).

docs/about/contributing.md

@@ -0,0 +1,95 @@
+---
+sidebarDepth: 3
+---
+
+# Contributing
+
+If you are a developer you can help us build a better Akt'n'Map !
+
+## Submission guidelines
+
+### Report a bug
+
+Before creating an issue please make sure you have checked out the docs, you might want to also try searching Github. It's pretty likely someone has already asked a similar question.
+
+Issues can be reported in the [issue tracker](https://github.com/kalisio/aktnmap/issues).
+
+### Pull Requests
+
+We love pull requests and we're continually working to make it as easy as possible for people to contribute.
+
+We prefer small pull requests with minimal code changes. The smaller they are the easier they are to review and merge. A core team member will pick up your PR and review it as soon as they can. They may ask for changes or reject your pull request. This is not a reflection of you as an engineer or a person. Please accept feedback graciously as we will also try to be sensitive when providing it.
+
+Although we generally accept many PRs they can be rejected for many reasons. We will be as transparent as possible but it may simply be that you do not have the same context or information regarding the roadmap that the core team members have. We value the time you take to put together any contributions so we pledge to always be respectful of that time and will try to be as open as possible so that you don't waste it.
+
+## Commit message guidelines
+
+We follow the [Conventional commits specifications](https://www.conventionalcommits.org/en/v1.0.0-beta.3/) which provides a set of rules to make commit messages more readable when looking through the project history. But also, we use the git commit messages to generate the change log.
+
+### Commit message format
+
+The commit message should be structured as follows:
+
+```
+<type>: <subject> [optional `breaking`]
+```
+
+Where `type` must be one of the following:
+* `build`: changes that affect the build system (external dependencies)
+* `ci`: changes to our CI configuration files and scripts
+* `chore`: changes that affect the project structure
+* `docs`: changes that affect the documentation only
+* `feat`: a new feature
+* `fix`: a bug fix
+* `perf`: a code change that improves performance
+* `refactor`: a code change that neither fixes a bug nor adds a feature
+* `revert`: revert changes
+* `style`: changes that do not affect the meaning of the code (lint issues)
+* `test`: adding missing tests or correcting existing tests
+
+Use the optional `[ breaking ]` keyword to declare a **BREAKING CHANGE**. 
+
+### Examples
+
+* Commit message with description and breaking change in body
+```
+feat: allow provided config object to extend other configs [ breaking ]
+```
+
+* Commit message with no body
+```
+docs: correct spelling in the contributing.md file
+```
+
+* Commit message for a fix using an issue number.
+```
+fix: fix minor issue in code (#12)
+```
+
+## Versioning guidelines
+
+We rely on [Semantic Versioning](https://semver.org/) for versioning a release. Indeed, given a version number `MAJOR.MINOR.PATCH`, increment the:
+* `MAJOR` version when you make a major evolution leading to breaking changes,
+* `MINOR` version when you add functionality in a backwards-compatible manner
+* `PATCH` version when you make backwards-compatible bug fixes.
+
+The command `npm run release:<type>`, where  `<type>` is either `patch`, `minor` or `major`, helps you to do the release. 
+
+It performs the following task for you:
+* increase the package version number in the `package.json` file
+* generate the change log
+* create a tag accordingly in the git repository and push it
+
+## Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

docs/about/license.md

@@ -0,0 +1,5 @@
+# License
+
+**Akt'n'Map** is, and always will be, 100% Open Source under the MIT license.
+
+<<< @/../LICENSE.md

docs/fr/README.md

@@ -0,0 +1,19 @@
+---
+home: true
+heroImage: https://s3.eu-central-1.amazonaws.com/kalisioscope/aktnmap/aktnmap-icon-256x256.png
+actionText: Prêt à démarrer ?
+actionLink: /fr/quickstart/
+features:
+- title: Personnalisable
+  details: Definissez votre organisation et vos processus métier
+- title: Fluide
+  details: Mobilisez instantanément, suivez l'évolution en temps-réel et facilitez le travail de vos équipes
+- title: Orienté mobilité
+  details: Accessible sur n'importe quel appareil et de n'importe où sur le terrain
+footer: License MIT | Copyright © 2017-20xx Kalisio
+---
+
+<p align="center">
+	<center><h3>Sponsorisé par</h3></center>
+	<a href="https://kalisio.com"><img src="https://s3.eu-central-1.amazonaws.com/kalisioscope/kalisio/kalisio-logo-black-256x84.png"></a>
+</p>

docs/fr/about/README.md

@@ -0,0 +1,22 @@
+# A propos
+
+**Akt'n'Map** est un projet libre disponible sur [GitHub](https://github.com/kalisio/aktnmap).
+
+Il repose sur un écosystème de développement et de déploiement composé de:
+* [KDK](https://kalisio.github.io/kdk/), a kit de développement pour les applications géospatiales
+* [Kano](https://kalisio.github.io/kdk/), un visualiseur 2D/3D de données géospatiales
+* [Weacast](https://weacast.github.io/weacast-docs/), une plateforme de gestion de données météorologiques,
+* [Kargo](https://kalisio.github.io/kargo/), une solution pour déployer des services géospatiaux
+* [Kaabah](https://github.com/kalisio/kaabah), une solution pour déployer et opérer des infrastructures
+
+## Feuille de route
+
+La feuille de route est disponible sur [Github](https://github.com/kalisio/aktnmap/projects/1).
+
+## Versions
+
+La liste des différentes versions est disponible sur [Github](https://github.com/kalisio/aktnmap/milestones)
+
+## Notes de version
+
+La liste des modifications apportées à chaque version est disponible sur [Github](https://github.com/kalisio/aktnmap/blob/master/CHANGELOG.md)

docs/fr/about/contact.md

@@ -0,0 +1,5 @@
+# Contact
+
+Utilisateur ? Contactez-nous via notre [site internet](https://aktnmap.com/).
+
+Développeur ? Rejoignez notre [chaine slack](https://kalisio.slack.com/).

docs/fr/about/contributing.md

@@ -0,0 +1,7 @@
+---
+sidebarDepth: 3
+---
+
+# Contribuer
+
+Contenu uniquement disponible en [Anglais](../../about/contributing.md) pour l'instant.