From 49c28c0de540c09c49da9e3602f67152cb4d9416 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Thu, 27 May 2021 10:43:17 +0200 Subject: [PATCH 01/22] First structure and config --- _config.yml | 4 +++ docs/index.md | 0 docs/layers-update-flow.md | 70 ++++++++++++++++++++++++++++++++++++++ 3 files changed, 74 insertions(+) create mode 100644 _config.yml create mode 100644 docs/index.md create mode 100644 docs/layers-update-flow.md diff --git a/_config.yml b/_config.yml new file mode 100644 index 000000000..f83f66a38 --- /dev/null +++ b/_config.yml @@ -0,0 +1,4 @@ +title: "Remote theme example" +remote_theme: pmarsceill/just-the-docs +color_scheme: "dark" +search_enabled: false diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 000000000..e69de29bb diff --git a/docs/layers-update-flow.md b/docs/layers-update-flow.md new file mode 100644 index 000000000..58a95b7a3 --- /dev/null +++ b/docs/layers-update-flow.md @@ -0,0 +1,70 @@ +# Layers update flow. + +Adding layers to the project is just a matter of following some steps to create the proper entry in the `layersConfig` object. This config will be consumed by the code that will take care of creating and adding the layers to the globe (that is the `createLayer` and `addLayerToMap` functions on `utils/layer-manager-utils`). +In order to add a layer to the config we need to create some `constants` that will build up the needed data structure. +Lets explain the steps with an example on how we would add a layer with fishes priority data 🐟 🐠 + +- Create a new layer slug on the `constants/layers-slugs` for the layer to be added. This `slug` needs to be shared with the science team people of the project in order to add layer metadata to the metadata service. + + ```js + export const FISHES_PRIORITY = 'fishes-priority'; + ``` +- `import` the newly created slugs into `constants/layers-urls` and asign it the url string (inside the `LAYERS_URLS` object) from the ArcGIS online service. + ```js + import { + FISHES_PRIORITY + } from 'constants/layers-slugs'; + + export const LAYERS_URLS = { + [FISHES_PRIORITY]: 'https://tiles.arcgis.com/tiles/arcgis/rest/services/Global_marine_fish_prioritisation_TL/MapServer' + } + ``` +- First of all we need to know if the type of layer we want to add is already present on the `LAYER_TYPES` constant on the `constants/layers-config` file. +Find [in this link](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) the list of the available layer types on the ArcGIS js API. +These are the layer types we are currently using in the platform: + ```js + const LAYER_TYPES = { + FEATURE_LAYER: 'FeatureLayer', + TILE_LAYER: 'TileLayer', + VECTOR_TILE_LAYER: 'VectorTileLayer' + } + ``` +- Now we are ready to add the layer to the `layerConfig` on `constants/layers-config`. We first need to `import` the layer slug and layers urls to then create the entry for the layer on the config object. + ```js + import { + FISHES_PRIORITY + } from 'constants/layers-slugs'; + + export const layersConfig = { + [FISHES_PRIORITY]: { + title: FISHES_PRIORITY, + slug: FISHES_PRIORITY, + type: LAYER_TYPES.TILE_LAYER, + url: LAYERS_URLS[FISHES_PRIORITY], + bbox: null + } + } + ``` +- Note that there's a `bbox` (bounding box) key on the layer object. This field serves to tell the app that this layer is restricted to a certain area of the globe. By providing a set of coordinates to this `bbox` whenever the layer is added to the map the camera will _travel_ to the specified location. Serve as an example the _hummingbirds rarity_ layer config , restricted to the Americas: + ```js + [HUMMINGBIRDS_RARITY]: { + title: HUMMINGBIRDS_RARITY, + slug: HUMMINGBIRDS_RARITY, + type: LAYER_TYPES.TILE_LAYER, + url: LAYERS_URLS[HUMMINGBIRDS_RARITY], + bbox: [-164,-40,-35,56] + } + ``` +- The last step for a layer to be ready to be used on the platform is to add the needed configuration to be consumed by the `legend` component. Different legend configurations are created depending on the category of the layer (_biodiversity_, _human pressures_ or _protected areas_), and those are stored into the associated file in the `constants` folder. In this case, fishes priority layer, the legend config to be updated is located on the `constants/biodiversity-layers-constants` file. + ```js + import { + FISHES_PRIORITY + } from 'constants/layers-slugs'; + + export const legendConfigs = { + [FISHES_PRIORITY]: { + ...defaultGradientConfig, + title: "Fishes priority" + } + } + ``` \ No newline at end of file From d48450e85029b6e33ddf275bd57304cbe26ca459 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Mon, 31 May 2021 10:43:56 +0200 Subject: [PATCH 02/22] add wip index.md --- docs/index.md | 15 +++++++++++++++ docs/layers-update-flow.md | 3 +++ docs/releases.md | 21 +++++++++++++++++++++ 3 files changed, 39 insertions(+) create mode 100644 docs/releases.md diff --git a/docs/index.md b/docs/index.md index e69de29bb..1c6f04a3a 100644 --- a/docs/index.md +++ b/docs/index.md @@ -0,0 +1,15 @@ +## About this documentation. +Who is it for, structure... + +Target readers +devs 👩🏽‍💻 +stakeholders 🌍 + +## The Half-Earth project map. +We are living in the sixth mass extinction. Half-Earth is a call to protect half the land and sea in order to manage sufficient habitat to slow down the species extinction crisis and ensure the long-term health of our planet. The Half-Earth Project is working to safeguard global biodiversity through detailed mapping of biodiversity, protected areas, and human activities. This information is then used to identify the places and species most in need of conservation action. GIS is at the core of determining which places to protect. + +The Half-Earth Project Map provides an interactive summary of progress toward this goal, offered as a tool to help contextualize global datasets of biodiversity, human encroachment, and protection. + + +## Resources outside the docs +- [Build a 3D globe app with the ArcGIS JS API](https://learn.arcgis.com/en/projects/build-a-3d-globe-app-with-the-arcgis-api-for-javascript/) \ No newline at end of file diff --git a/docs/layers-update-flow.md b/docs/layers-update-flow.md index 58a95b7a3..d767c79e0 100644 --- a/docs/layers-update-flow.md +++ b/docs/layers-update-flow.md @@ -1,3 +1,6 @@ +_Target readers_: 👩🏽‍💻 +_What you'll get from this page_: + # Layers update flow. Adding layers to the project is just a matter of following some steps to create the proper entry in the `layersConfig` object. This config will be consumed by the code that will take care of creating and adding the layers to the globe (that is the `createLayer` and `addLayerToMap` functions on `utils/layer-manager-utils`). diff --git a/docs/releases.md b/docs/releases.md new file mode 100644 index 000000000..63cf50a59 --- /dev/null +++ b/docs/releases.md @@ -0,0 +1,21 @@ +_Target readers_: 👩🏽‍💻 | 🌍 +_What you'll get from this page_: + +# Releases and changelog + What we want to accomplish through releases and changelog (share the state of the project with stake holders, allow dev to have ) + Folowing [Keep a changelog structure](https://keepachangelog.com/en/1.0.0/) +## Semantic versioning on Half Earth +We do our own flavour of [Semantic Versioning](https://semver.org), in order to fulfill the specificities of a data intensive user facing project. +### Major +- New Features (like in Jira epics) +- New data layers +- Higher scale data layers +### Minor +- Data layers updates +- Metadata updates (in case anything needs to be deployed from the platform) +- Js API upgrades +- Chore implementation for internal use +- Design iterations on existing features +### Patch +- Bug fixes +- Typos \ No newline at end of file From a417a2b943cc68c0ef5de09e27a93832b604352b Mon Sep 17 00:00:00 2001 From: weberjavi Date: Mon, 31 May 2021 10:56:43 +0200 Subject: [PATCH 03/22] Update config --- _config.yml | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/_config.yml b/_config.yml index f83f66a38..d24239f9b 100644 --- a/_config.yml +++ b/_config.yml @@ -1,4 +1,3 @@ title: "Remote theme example" +# theme: just-the-docs remote_theme: pmarsceill/just-the-docs -color_scheme: "dark" -search_enabled: false From 1efcd110a5b465898253d9914a4df44ecbed7c55 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Mon, 31 May 2021 11:46:21 +0200 Subject: [PATCH 04/22] Add local jekyll build to git ignore --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 805bb40b3..f9d277aa1 100644 --- a/.gitignore +++ b/.gitignore @@ -8,6 +8,9 @@ # production /build +# local jekyll docs +/_site + # misc .DS_Store .env.local From 55422ff238ee1a5df86d0086a2bec46e9e1db99a Mon Sep 17 00:00:00 2001 From: weberjavi Date: Mon, 31 May 2021 11:46:55 +0200 Subject: [PATCH 05/22] Add gemfile --- GEMFILE | 30 ++++++ Gemfile.lock | 283 +++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 313 insertions(+) create mode 100644 GEMFILE create mode 100644 Gemfile.lock diff --git a/GEMFILE b/GEMFILE new file mode 100644 index 000000000..fa008af2d --- /dev/null +++ b/GEMFILE @@ -0,0 +1,30 @@ +source "https://rubygems.org" +# Hello! This is where you manage which Jekyll version is used to run. +# When you want to use a different version, change it below, save the +# file and run `bundle install`. Run Jekyll with `bundle exec`, like so: +# +# bundle exec jekyll serve +# +# This will help ensure the proper Jekyll version is running. +# Happy Jekylling! +# gem "jekyll", "~> 4.2.0" +# This is the default theme for new Jekyll sites. You may change this to anything you like. +gem "minima", "~> 2.5" +gem "just-the-docs" +# If you want to use GitHub Pages, remove the "gem "jekyll"" above and +# uncomment the line below. To upgrade, run `bundle update github-pages`. +gem "github-pages", group: :jekyll_plugins +# If you have any plugins, put them here! +group :jekyll_plugins do + gem "jekyll-feed", "~> 0.12" +end + +# Windows and JRuby does not include zoneinfo files, so bundle the tzinfo-data gem +# and associated library. +platforms :mingw, :x64_mingw, :mswin, :jruby do + gem "tzinfo", "~> 1.2" + gem "tzinfo-data" +end + +# Performance-booster for watching directories on Windows +gem "wdm", "~> 0.1.1", :platforms => [:mingw, :x64_mingw, :mswin] diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 000000000..1a31d0a56 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,283 @@ +GEM + remote: https://rubygems.org/ + specs: + activesupport (6.0.3.7) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 0.7, < 2) + minitest (~> 5.1) + tzinfo (~> 1.1) + zeitwerk (~> 2.2, >= 2.2.2) + addressable (2.7.0) + public_suffix (>= 2.0.2, < 5.0) + coffee-script (2.4.1) + coffee-script-source + execjs + coffee-script-source (1.11.1) + colorator (1.1.0) + commonmarker (0.17.13) + ruby-enum (~> 0.5) + concurrent-ruby (1.1.8) + dnsruby (1.61.5) + simpleidn (~> 0.1) + em-websocket (0.5.2) + eventmachine (>= 0.12.9) + http_parser.rb (~> 0.6.0) + ethon (0.14.0) + ffi (>= 1.15.0) + eventmachine (1.2.7) + execjs (2.8.1) + faraday (1.4.2) + faraday-em_http (~> 1.0) + faraday-em_synchrony (~> 1.0) + faraday-excon (~> 1.1) + faraday-net_http (~> 1.0) + faraday-net_http_persistent (~> 1.1) + multipart-post (>= 1.2, < 3) + ruby2_keywords (>= 0.0.4) + faraday-em_http (1.0.0) + faraday-em_synchrony (1.0.0) + faraday-excon (1.1.0) + faraday-net_http (1.0.1) + faraday-net_http_persistent (1.1.0) + ffi (1.15.1) + forwardable-extended (2.6.0) + gemoji (3.0.1) + github-pages (215) + github-pages-health-check (= 1.17.2) + jekyll (= 3.9.0) + jekyll-avatar (= 0.7.0) + jekyll-coffeescript (= 1.1.1) + jekyll-commonmark-ghpages (= 0.1.6) + jekyll-default-layout (= 0.1.4) + jekyll-feed (= 0.15.1) + jekyll-gist (= 1.5.0) + jekyll-github-metadata (= 2.13.0) + jekyll-mentions (= 1.6.0) + jekyll-optional-front-matter (= 0.3.2) + jekyll-paginate (= 1.1.0) + jekyll-readme-index (= 0.3.0) + jekyll-redirect-from (= 0.16.0) + jekyll-relative-links (= 0.6.1) + jekyll-remote-theme (= 0.4.3) + jekyll-sass-converter (= 1.5.2) + jekyll-seo-tag (= 2.7.1) + jekyll-sitemap (= 1.4.0) + jekyll-swiss (= 1.0.0) + jekyll-theme-architect (= 0.1.1) + jekyll-theme-cayman (= 0.1.1) + jekyll-theme-dinky (= 0.1.1) + jekyll-theme-hacker (= 0.1.2) + jekyll-theme-leap-day (= 0.1.1) + jekyll-theme-merlot (= 0.1.1) + jekyll-theme-midnight (= 0.1.1) + jekyll-theme-minimal (= 0.1.1) + jekyll-theme-modernist (= 0.1.1) + jekyll-theme-primer (= 0.5.4) + jekyll-theme-slate (= 0.1.1) + jekyll-theme-tactile (= 0.1.1) + jekyll-theme-time-machine (= 0.1.1) + jekyll-titles-from-headings (= 0.5.3) + jemoji (= 0.12.0) + kramdown (= 2.3.1) + kramdown-parser-gfm (= 1.1.0) + liquid (= 4.0.3) + mercenary (~> 0.3) + minima (= 2.5.1) + nokogiri (>= 1.10.4, < 2.0) + rouge (= 3.26.0) + terminal-table (~> 1.4) + github-pages-health-check (1.17.2) + addressable (~> 2.3) + dnsruby (~> 1.60) + octokit (~> 4.0) + public_suffix (>= 2.0.2, < 5.0) + typhoeus (~> 1.3) + html-pipeline (2.14.0) + activesupport (>= 2) + nokogiri (>= 1.4) + http_parser.rb (0.6.0) + i18n (0.9.5) + concurrent-ruby (~> 1.0) + jekyll (3.9.0) + addressable (~> 2.4) + colorator (~> 1.0) + em-websocket (~> 0.5) + i18n (~> 0.7) + jekyll-sass-converter (~> 1.0) + jekyll-watch (~> 2.0) + kramdown (>= 1.17, < 3) + liquid (~> 4.0) + mercenary (~> 0.3.3) + pathutil (~> 0.9) + rouge (>= 1.7, < 4) + safe_yaml (~> 1.0) + jekyll-avatar (0.7.0) + jekyll (>= 3.0, < 5.0) + jekyll-coffeescript (1.1.1) + coffee-script (~> 2.2) + coffee-script-source (~> 1.11.1) + jekyll-commonmark (1.3.1) + commonmarker (~> 0.14) + jekyll (>= 3.7, < 5.0) + jekyll-commonmark-ghpages (0.1.6) + commonmarker (~> 0.17.6) + jekyll-commonmark (~> 1.2) + rouge (>= 2.0, < 4.0) + jekyll-default-layout (0.1.4) + jekyll (~> 3.0) + jekyll-feed (0.15.1) + jekyll (>= 3.7, < 5.0) + jekyll-gist (1.5.0) + octokit (~> 4.2) + jekyll-github-metadata (2.13.0) + jekyll (>= 3.4, < 5.0) + octokit (~> 4.0, != 4.4.0) + jekyll-mentions (1.6.0) + html-pipeline (~> 2.3) + jekyll (>= 3.7, < 5.0) + jekyll-optional-front-matter (0.3.2) + jekyll (>= 3.0, < 5.0) + jekyll-paginate (1.1.0) + jekyll-readme-index (0.3.0) + jekyll (>= 3.0, < 5.0) + jekyll-redirect-from (0.16.0) + jekyll (>= 3.3, < 5.0) + jekyll-relative-links (0.6.1) + jekyll (>= 3.3, < 5.0) + jekyll-remote-theme (0.4.3) + addressable (~> 2.0) + jekyll (>= 3.5, < 5.0) + jekyll-sass-converter (>= 1.0, <= 3.0.0, != 2.0.0) + rubyzip (>= 1.3.0, < 3.0) + jekyll-sass-converter (1.5.2) + sass (~> 3.4) + jekyll-seo-tag (2.7.1) + jekyll (>= 3.8, < 5.0) + jekyll-sitemap (1.4.0) + jekyll (>= 3.7, < 5.0) + jekyll-swiss (1.0.0) + jekyll-theme-architect (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-cayman (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-dinky (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-hacker (0.1.2) + jekyll (> 3.5, < 5.0) + jekyll-seo-tag (~> 2.0) + jekyll-theme-leap-day (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-merlot (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-midnight (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-minimal (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-modernist (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-primer (0.5.4) + jekyll (> 3.5, < 5.0) + jekyll-github-metadata (~> 2.9) + jekyll-seo-tag (~> 2.0) + jekyll-theme-slate (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-tactile (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-theme-time-machine (0.1.1) + jekyll (~> 3.5) + jekyll-seo-tag (~> 2.0) + jekyll-titles-from-headings (0.5.3) + jekyll (>= 3.3, < 5.0) + jekyll-watch (2.2.1) + listen (~> 3.0) + jemoji (0.12.0) + gemoji (~> 3.0) + html-pipeline (~> 2.2) + jekyll (>= 3.0, < 5.0) + just-the-docs (0.3.3) + jekyll (>= 3.8.5) + jekyll-seo-tag (~> 2.0) + rake (>= 12.3.1, < 13.1.0) + kramdown (2.3.1) + rexml + kramdown-parser-gfm (1.1.0) + kramdown (~> 2.0) + liquid (4.0.3) + listen (3.5.1) + rb-fsevent (~> 0.10, >= 0.10.3) + rb-inotify (~> 0.9, >= 0.9.10) + mercenary (0.3.6) + minima (2.5.1) + jekyll (>= 3.5, < 5.0) + jekyll-feed (~> 0.9) + jekyll-seo-tag (~> 2.1) + minitest (5.14.4) + multipart-post (2.1.1) + nokogiri (1.11.6-x86_64-darwin) + racc (~> 1.4) + octokit (4.21.0) + faraday (>= 0.9) + sawyer (~> 0.8.0, >= 0.5.3) + pathutil (0.16.2) + forwardable-extended (~> 2.6) + public_suffix (4.0.6) + racc (1.5.2) + rake (13.0.3) + rb-fsevent (0.11.0) + rb-inotify (0.10.1) + ffi (~> 1.0) + rexml (3.2.5) + rouge (3.26.0) + ruby-enum (0.9.0) + i18n + ruby2_keywords (0.0.4) + rubyzip (2.3.0) + safe_yaml (1.0.5) + sass (3.7.4) + sass-listen (~> 4.0.0) + sass-listen (4.0.0) + rb-fsevent (~> 0.9, >= 0.9.4) + rb-inotify (~> 0.9, >= 0.9.7) + sawyer (0.8.2) + addressable (>= 2.3.5) + faraday (> 0.8, < 2.0) + simpleidn (0.2.1) + unf (~> 0.1.4) + terminal-table (1.8.0) + unicode-display_width (~> 1.1, >= 1.1.1) + thread_safe (0.3.6) + typhoeus (1.4.0) + ethon (>= 0.9.0) + tzinfo (1.2.9) + thread_safe (~> 0.1) + unf (0.1.4) + unf_ext + unf_ext (0.0.7.7) + unicode-display_width (1.7.0) + zeitwerk (2.4.2) + +PLATFORMS + x86_64-darwin-20 + +DEPENDENCIES + github-pages + jekyll + jekyll-feed (~> 0.12) + just-the-docs + minima (~> 2.5) + tzinfo (~> 1.2) + tzinfo-data + wdm (~> 0.1.1) + +BUNDLED WITH + 2.2.14 From 213cfaa73e3c2b110d432be16d502b008b8f369f Mon Sep 17 00:00:00 2001 From: weberjavi Date: Mon, 31 May 2021 12:26:32 +0200 Subject: [PATCH 06/22] Add yarn docs script --- package.json | 1 + 1 file changed, 1 insertion(+) diff --git a/package.json b/package.json index fd5b00a20..c74e61432 100644 --- a/package.json +++ b/package.json @@ -54,6 +54,7 @@ "build-service-worker": "node ./src/service-worker-build.js", "build": "react-app-rewired build && npm run build-service-worker && npm run clean-cra-sw", "cypress:open": "cypress open", + "docs": "bundle exec jekyll serve", "eject": "react-scripts eject" }, "eslintConfig": { From c129ef431ef0d94d3d56537a93943d5e6b06e566 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Mon, 31 May 2021 12:27:10 +0200 Subject: [PATCH 07/22] Add edit in github config --- _config.yml | 26 +++++++++++++++++++++++++- 1 file changed, 25 insertions(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index d24239f9b..f450e4ccb 100644 --- a/_config.yml +++ b/_config.yml @@ -1,3 +1,27 @@ -title: "Remote theme example" +title: "Half-Earth map documentation" # theme: just-the-docs remote_theme: pmarsceill/just-the-docs +# color_scheme: dark +# Aux links for the upper right navigation +aux_links: + "Production site": + - "https://www.half-earthproject.org/maps/" + "Google Drive folder": + - "https://drive.google.com/drive/folders/1wqQ80uXi9HgjmgfktnuY0xhW5n3sPFqe" +# Makes Aux links open in a new tab. Default is false +aux_links_new_tab: true + + +# Footer last edited timestamp +last_edit_timestamp: true # show or hide edit time - page must have `last_modified_date` defined in the frontmatter +last_edit_time_format: "%b %e %Y at %I:%M %p" # uses ruby's time format: https://ruby-doc.org/stdlib-2.7.0/libdoc/time/rdoc/Time.html + +# Footer "Edit this page on GitHub" link text +gh_edit_link: true # show or hide edit this page link +gh_edit_link_text: "Edit this page on GitHub." +gh_edit_repository: "https://github.com/Vizzuality/half-earth-v3" # the github URL for your repo +gh_edit_branch: "develop" # the branch that your docs is served from +# gh_edit_source: docs # the source that your files originate from +gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately + + From 1fc981806410068eeef5c797d2f3e46c776ecc82 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Mon, 31 May 2021 14:35:17 +0200 Subject: [PATCH 08/22] Add docs collection to config --- _config.yml | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index f450e4ccb..4d0937ea0 100644 --- a/_config.yml +++ b/_config.yml @@ -1,7 +1,7 @@ title: "Half-Earth map documentation" # theme: just-the-docs remote_theme: pmarsceill/just-the-docs -# color_scheme: dark +color_scheme: light # Aux links for the upper right navigation aux_links: "Production site": @@ -25,3 +25,22 @@ gh_edit_branch: "develop" # the branch that your docs is served from gh_edit_view_mode: "tree" # "tree" or "edit" if you want the user to jump into the editor immediately +collections: + # Define a collection named "docs", its documents reside in the "_docs" directory + docs: + permalink: "/:collection/:path/" + output: true + +just_the_docs: + # Define which collections are used in just-the-docs + collections: + # Reference the "docs" collection + docs: + # Give the collection a name + name: Documentation + # Exclude the collection from the navigation + # Supports true or false (default) + nav_exclude: false + # Exclude the collection from the search + # Supports true or false (default) + search_exclude: false \ No newline at end of file From feb907b68ddd775436e0a81194ff2cd11e50723c Mon Sep 17 00:00:00 2001 From: weberjavi Date: Mon, 31 May 2021 14:35:44 +0200 Subject: [PATCH 09/22] Move content to _doc folder --- _docs/layers/index.md | 6 ++++++ {docs => _docs/layers}/layers-update-flow.md | 6 ++++++ docs/releases.md => _docs/releases/index.md | 5 +++++ docs/index.md => index.md | 18 ++++++++++++++---- 4 files changed, 31 insertions(+), 4 deletions(-) create mode 100644 _docs/layers/index.md rename {docs => _docs/layers}/layers-update-flow.md (97%) rename docs/releases.md => _docs/releases/index.md (93%) rename docs/index.md => index.md (77%) diff --git a/_docs/layers/index.md b/_docs/layers/index.md new file mode 100644 index 000000000..3f9638619 --- /dev/null +++ b/_docs/layers/index.md @@ -0,0 +1,6 @@ +--- +layout: default +title: Working with layers +has_children: true +has_toc: true +--- \ No newline at end of file diff --git a/docs/layers-update-flow.md b/_docs/layers/layers-update-flow.md similarity index 97% rename from docs/layers-update-flow.md rename to _docs/layers/layers-update-flow.md index d767c79e0..d934fa822 100644 --- a/docs/layers-update-flow.md +++ b/_docs/layers/layers-update-flow.md @@ -1,3 +1,9 @@ +--- +layout: default +title: Layers update flow +parent: Working with layers +--- + _Target readers_: 👩🏽‍💻 _What you'll get from this page_: diff --git a/docs/releases.md b/_docs/releases/index.md similarity index 93% rename from docs/releases.md rename to _docs/releases/index.md index 63cf50a59..cd815d0e1 100644 --- a/docs/releases.md +++ b/_docs/releases/index.md @@ -1,3 +1,8 @@ +--- +layout: default +title: Release cycles & versioning +--- + _Target readers_: 👩🏽‍💻 | 🌍 _What you'll get from this page_: diff --git a/docs/index.md b/index.md similarity index 77% rename from docs/index.md rename to index.md index 1c6f04a3a..0e455351a 100644 --- a/docs/index.md +++ b/index.md @@ -1,3 +1,15 @@ +--- +layout: default +title: Welcome +nav_order: 1 +permalink: / +--- + +## The Half-Earth project map. +We are living in the sixth mass extinction. Half-Earth is a call to protect half the land and sea in order to manage sufficient habitat to slow down the species extinction crisis and ensure the long-term health of our planet. The Half-Earth Project is working to safeguard global biodiversity through detailed mapping of biodiversity, protected areas, and human activities. This information is then used to identify the places and species most in need of conservation action. GIS is at the core of determining which places to protect. + +The Half-Earth Project Map provides an interactive summary of progress toward this goal, offered as a tool to help contextualize global datasets of biodiversity, human encroachment, and protection. + ## About this documentation. Who is it for, structure... @@ -5,10 +17,8 @@ Target readers devs 👩🏽‍💻 stakeholders 🌍 -## The Half-Earth project map. -We are living in the sixth mass extinction. Half-Earth is a call to protect half the land and sea in order to manage sufficient habitat to slow down the species extinction crisis and ensure the long-term health of our planet. The Half-Earth Project is working to safeguard global biodiversity through detailed mapping of biodiversity, protected areas, and human activities. This information is then used to identify the places and species most in need of conservation action. GIS is at the core of determining which places to protect. - -The Half-Earth Project Map provides an interactive summary of progress toward this goal, offered as a tool to help contextualize global datasets of biodiversity, human encroachment, and protection. +## TL;DR 👩🏽‍💻 +If you just want to jump start development and fight with the code on a local version of the repo head to the README of the project to understand which are the dependencies that need to be installed to get going ## Resources outside the docs From cc9442f1ac224771e0a3157532faa13c7fbc7e58 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Mon, 31 May 2021 15:47:29 +0200 Subject: [PATCH 10/22] docs update --- _config.yml | 2 ++ _docs/external-resources/index.md | 10 ++++++++++ _docs/index.md | 27 +++++++++++++++++++++++++++ _docs/releases/index.md | 8 ++++++-- index.md | 25 ------------------------- 5 files changed, 45 insertions(+), 27 deletions(-) create mode 100644 _docs/external-resources/index.md create mode 100644 _docs/index.md delete mode 100644 index.md diff --git a/_config.yml b/_config.yml index 4d0937ea0..a82c4cc5e 100644 --- a/_config.yml +++ b/_config.yml @@ -1,6 +1,8 @@ title: "Half-Earth map documentation" # theme: just-the-docs remote_theme: pmarsceill/just-the-docs +baseurl: "/_docs" # the subpath of your site, e.g. /blog +url: "https://vizzuality.github.io/half-earth-v3/" # the base hostname & protocol for your site, e.g. http://example.com color_scheme: light # Aux links for the upper right navigation aux_links: diff --git a/_docs/external-resources/index.md b/_docs/external-resources/index.md new file mode 100644 index 000000000..7a1ecfa28 --- /dev/null +++ b/_docs/external-resources/index.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Useful Resources +nav_order: 4 +permalink: /resources +--- + + +## Resources outside the docs +- [Build a 3D globe app with the ArcGIS JS API](https://learn.arcgis.com/en/projects/build-a-3d-globe-app-with-the-arcgis-api-for-javascript/) \ No newline at end of file diff --git a/_docs/index.md b/_docs/index.md new file mode 100644 index 000000000..52f247e4f --- /dev/null +++ b/_docs/index.md @@ -0,0 +1,27 @@ +--- +layout: default +title: Welcome +nav_order: 1 +permalink: / +--- + +# __The Half-Earth project__ 🐡 🦎 🦉 🐍 🐋 🌲 🦧 🌵 +We are living in the sixth mass extinction. __Half-Earth is a call to protect half the land and sea in order to manage sufficient habitat to slow down the species extinction crisis and ensure the long-term health of our planet__. The Half-Earth Project is working to safeguard global biodiversity through detailed mapping of biodiversity, protected areas, and human activities. This information is then used to identify the places and species most in need of conservation action. +{: .fs-6 .fw-300 } + + +## __The Half-Earth Project Map__ 🌎 🌍 🌏 +It provides an interactive summary of progress toward this goal, offered as a tool to help contextualize global datasets of biodiversity, human encroachment, and protection. + +If you want to jump start into contributting to the repo go ahead and head to the __README.md__ of the project, where you'll find instructions to get started. + +Otherwise keep reading to beeter understand the context of the project and ins and outs related to its development. + +[README](https://github.com/Vizzuality/half-earth-v3/blob/master/README.md){: .btn .btn-outline } + +## About this documentation. +Who is it for, structure... + +Target readers +devs 👩🏽‍💻 +stakeholders 🌍 diff --git a/_docs/releases/index.md b/_docs/releases/index.md index cd815d0e1..f0efca7f6 100644 --- a/_docs/releases/index.md +++ b/_docs/releases/index.md @@ -1,10 +1,14 @@ --- layout: default title: Release cycles & versioning +nav_order: 2 +permalink: /changelog --- -_Target readers_: 👩🏽‍💻 | 🌍 -_What you'll get from this page_: +_Target readers_ 👩🏽‍💻 🌍 + + +[Current release](https://github.com/Vizzuality/half-earth-v3/releases){: .btn .btn-outline} # Releases and changelog What we want to accomplish through releases and changelog (share the state of the project with stake holders, allow dev to have ) diff --git a/index.md b/index.md deleted file mode 100644 index 0e455351a..000000000 --- a/index.md +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default -title: Welcome -nav_order: 1 -permalink: / ---- - -## The Half-Earth project map. -We are living in the sixth mass extinction. Half-Earth is a call to protect half the land and sea in order to manage sufficient habitat to slow down the species extinction crisis and ensure the long-term health of our planet. The Half-Earth Project is working to safeguard global biodiversity through detailed mapping of biodiversity, protected areas, and human activities. This information is then used to identify the places and species most in need of conservation action. GIS is at the core of determining which places to protect. - -The Half-Earth Project Map provides an interactive summary of progress toward this goal, offered as a tool to help contextualize global datasets of biodiversity, human encroachment, and protection. - -## About this documentation. -Who is it for, structure... - -Target readers -devs 👩🏽‍💻 -stakeholders 🌍 - -## TL;DR 👩🏽‍💻 -If you just want to jump start development and fight with the code on a local version of the repo head to the README of the project to understand which are the dependencies that need to be installed to get going - - -## Resources outside the docs -- [Build a 3D globe app with the ArcGIS JS API](https://learn.arcgis.com/en/projects/build-a-3d-globe-app-with-the-arcgis-api-for-javascript/) \ No newline at end of file From 52a7263d11d3149fa3caf42f7a7f3fa434a0a0c4 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Mon, 31 May 2021 15:57:01 +0200 Subject: [PATCH 11/22] Update baseUrl --- _config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index a82c4cc5e..7b9db794b 100644 --- a/_config.yml +++ b/_config.yml @@ -1,7 +1,7 @@ title: "Half-Earth map documentation" # theme: just-the-docs remote_theme: pmarsceill/just-the-docs -baseurl: "/_docs" # the subpath of your site, e.g. /blog +# baseurl: "/_docs" # the subpath of your site, e.g. /blog url: "https://vizzuality.github.io/half-earth-v3/" # the base hostname & protocol for your site, e.g. http://example.com color_scheme: light # Aux links for the upper right navigation From c1f4b74f7fbb97188ece8473654c24c6becfedaf Mon Sep 17 00:00:00 2001 From: weberjavi Date: Mon, 31 May 2021 16:05:15 +0200 Subject: [PATCH 12/22] testing permalink --- _docs/external-resources/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_docs/external-resources/index.md b/_docs/external-resources/index.md index 7a1ecfa28..990304042 100644 --- a/_docs/external-resources/index.md +++ b/_docs/external-resources/index.md @@ -2,7 +2,7 @@ layout: default title: Useful Resources nav_order: 4 -permalink: /resources +permalink: /_docs/resources --- From 87de7d5bea3e03b10a490e534f47204c77fc59b7 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Mon, 31 May 2021 16:08:06 +0200 Subject: [PATCH 13/22] Update ordering and permalinks --- _config.yml | 1 - _docs/layers/index.md | 2 ++ _docs/releases/index.md | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/_config.yml b/_config.yml index 7b9db794b..d32e13208 100644 --- a/_config.yml +++ b/_config.yml @@ -1,7 +1,6 @@ title: "Half-Earth map documentation" # theme: just-the-docs remote_theme: pmarsceill/just-the-docs -# baseurl: "/_docs" # the subpath of your site, e.g. /blog url: "https://vizzuality.github.io/half-earth-v3/" # the base hostname & protocol for your site, e.g. http://example.com color_scheme: light # Aux links for the upper right navigation diff --git a/_docs/layers/index.md b/_docs/layers/index.md index 3f9638619..87d7124e4 100644 --- a/_docs/layers/index.md +++ b/_docs/layers/index.md @@ -1,6 +1,8 @@ --- layout: default title: Working with layers +nav_order: 3 has_children: true has_toc: true +permalink: /_docs/layers --- \ No newline at end of file diff --git a/_docs/releases/index.md b/_docs/releases/index.md index f0efca7f6..e139b4b7a 100644 --- a/_docs/releases/index.md +++ b/_docs/releases/index.md @@ -2,7 +2,7 @@ layout: default title: Release cycles & versioning nav_order: 2 -permalink: /changelog +permalink: /_docs/changelog --- _Target readers_ 👩🏽‍💻 🌍 From 04569e8fed477ecc645ab7958d039ff4757dffa0 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Mon, 31 May 2021 16:10:43 +0200 Subject: [PATCH 14/22] Update config --- _config.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_config.yml b/_config.yml index d32e13208..9b9636930 100644 --- a/_config.yml +++ b/_config.yml @@ -1,7 +1,7 @@ title: "Half-Earth map documentation" # theme: just-the-docs remote_theme: pmarsceill/just-the-docs -url: "https://vizzuality.github.io/half-earth-v3/" # the base hostname & protocol for your site, e.g. http://example.com +# url: "https://vizzuality.github.io/half-earth-v3/" # the base hostname & protocol for your site, e.g. http://example.com color_scheme: light # Aux links for the upper right navigation aux_links: From a0e9d6c7a35f089ed4b4d3c5c11b6068bd27c1ad Mon Sep 17 00:00:00 2001 From: weberjavi Date: Wed, 2 Jun 2021 12:42:52 +0200 Subject: [PATCH 15/22] Add favicon and restructure --- _docs/development/architecture/index.md | 11 +++++++++++ _docs/{layers => development}/index.md | 10 ++++++---- _docs/development/layers/index.md | 11 +++++++++++ .../layers/layers-update-flow.md | 5 ++++- _docs/development/scenes/index.md | 11 +++++++++++ _docs/external-resources/index.md | 2 +- _docs/index.md | 7 +++---- _docs/resigners.md | 8 ++++++++ _docs/scientists/index.md | 10 ++++++++++ _docs/stakeholders/index.md | 8 ++++++++ _docs/{ => stakeholders}/releases/index.md | 4 ++-- favicon.ico | Bin 0 -> 1947 bytes public/favicon.ico | Bin 3870 -> 1947 bytes 13 files changed, 75 insertions(+), 12 deletions(-) create mode 100644 _docs/development/architecture/index.md rename _docs/{layers => development}/index.md (52%) create mode 100644 _docs/development/layers/index.md rename _docs/{ => development}/layers/layers-update-flow.md (97%) create mode 100644 _docs/development/scenes/index.md create mode 100644 _docs/resigners.md create mode 100644 _docs/scientists/index.md create mode 100644 _docs/stakeholders/index.md rename _docs/{ => stakeholders}/releases/index.md (94%) create mode 100644 favicon.ico diff --git a/_docs/development/architecture/index.md b/_docs/development/architecture/index.md new file mode 100644 index 000000000..802f75ddf --- /dev/null +++ b/_docs/development/architecture/index.md @@ -0,0 +1,11 @@ +--- +layout: default +title: General architecture +nav_order: 1 +parent: Developers +has_children: true +has_toc: true +permalink: /_docs/dev/architecture +--- + +architecture iontro \ No newline at end of file diff --git a/_docs/layers/index.md b/_docs/development/index.md similarity index 52% rename from _docs/layers/index.md rename to _docs/development/index.md index 87d7124e4..38cd3b2be 100644 --- a/_docs/layers/index.md +++ b/_docs/development/index.md @@ -1,8 +1,10 @@ --- layout: default -title: Working with layers -nav_order: 3 +title: Developers has_children: true has_toc: true -permalink: /_docs/layers ---- \ No newline at end of file +permalink: /_docs/dev +nav_order: 3 +--- + +dev docs intro \ No newline at end of file diff --git a/_docs/development/layers/index.md b/_docs/development/layers/index.md new file mode 100644 index 000000000..25999e305 --- /dev/null +++ b/_docs/development/layers/index.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Working with layers +parent: Developers +has_children: true +has_toc: true +nav_order: 2 +permalink: /_docs/dev/layers +--- + +layers intro \ No newline at end of file diff --git a/_docs/layers/layers-update-flow.md b/_docs/development/layers/layers-update-flow.md similarity index 97% rename from _docs/layers/layers-update-flow.md rename to _docs/development/layers/layers-update-flow.md index d934fa822..1820e67ac 100644 --- a/_docs/layers/layers-update-flow.md +++ b/_docs/development/layers/layers-update-flow.md @@ -1,7 +1,10 @@ --- layout: default -title: Layers update flow +title: Add/update layers parent: Working with layers +grand_parent: Developers +nav_order: 1 +permalink: /_docs/dev/layers/add-update --- _Target readers_: 👩🏽‍💻 diff --git a/_docs/development/scenes/index.md b/_docs/development/scenes/index.md new file mode 100644 index 000000000..a3ad25eed --- /dev/null +++ b/_docs/development/scenes/index.md @@ -0,0 +1,11 @@ +--- +layout: default +title: Scenes +parent: Developers +has_children: true +has_toc: true +permalink: /_docs/dev/scenes +nav_order: 2 +--- + +scenes explanations \ No newline at end of file diff --git a/_docs/external-resources/index.md b/_docs/external-resources/index.md index 990304042..51dee77a5 100644 --- a/_docs/external-resources/index.md +++ b/_docs/external-resources/index.md @@ -1,7 +1,7 @@ --- layout: default title: Useful Resources -nav_order: 4 +nav_order: 6 permalink: /_docs/resources --- diff --git a/_docs/index.md b/_docs/index.md index 52f247e4f..50ba43fa1 100644 --- a/_docs/index.md +++ b/_docs/index.md @@ -5,19 +5,18 @@ nav_order: 1 permalink: / --- -# __The Half-Earth project__ 🐡 🦎 🦉 🐍 🐋 🌲 🦧 🌵 +# __The Half-Earth project__ 🐡 🦎 🦉 🐍 🐋 🌲 🦧 🌵 We are living in the sixth mass extinction. __Half-Earth is a call to protect half the land and sea in order to manage sufficient habitat to slow down the species extinction crisis and ensure the long-term health of our planet__. The Half-Earth Project is working to safeguard global biodiversity through detailed mapping of biodiversity, protected areas, and human activities. This information is then used to identify the places and species most in need of conservation action. -{: .fs-6 .fw-300 } -## __The Half-Earth Project Map__ 🌎 🌍 🌏 +## __The Half-Earth Project Map__ 🌎 🌍 🌏 It provides an interactive summary of progress toward this goal, offered as a tool to help contextualize global datasets of biodiversity, human encroachment, and protection. If you want to jump start into contributting to the repo go ahead and head to the __README.md__ of the project, where you'll find instructions to get started. Otherwise keep reading to beeter understand the context of the project and ins and outs related to its development. -[README](https://github.com/Vizzuality/half-earth-v3/blob/master/README.md){: .btn .btn-outline } +[README 👩🏽‍💻](https://github.com/Vizzuality/half-earth-v3/blob/master/README.md){: .btn .btn-outline } ## About this documentation. Who is it for, structure... diff --git a/_docs/resigners.md b/_docs/resigners.md new file mode 100644 index 000000000..ae49a7e32 --- /dev/null +++ b/_docs/resigners.md @@ -0,0 +1,8 @@ +--- +layout: default +title: Resigners +nav_order: 5 +permalink: /_docs/resigners +--- + +[User research 2020 docs](https://www.notion.so/2020-Half-Earth-User-Research-eead7c2575f44bb1b0ed4825a8265f1e) \ No newline at end of file diff --git a/_docs/scientists/index.md b/_docs/scientists/index.md new file mode 100644 index 000000000..d49294807 --- /dev/null +++ b/_docs/scientists/index.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Scientists +nav_order: 4 +has_children: true +has_toc: true +permalink: /_docs/science +--- + +move repo wiki here \ No newline at end of file diff --git a/_docs/stakeholders/index.md b/_docs/stakeholders/index.md new file mode 100644 index 000000000..7a44bf5ba --- /dev/null +++ b/_docs/stakeholders/index.md @@ -0,0 +1,8 @@ +--- +layout: default +title: Stakeholders +nav_order: 2 +has_children: true +has_toc: true +permalink: /_docs/general +--- \ No newline at end of file diff --git a/_docs/releases/index.md b/_docs/stakeholders/releases/index.md similarity index 94% rename from _docs/releases/index.md rename to _docs/stakeholders/releases/index.md index e139b4b7a..7551cf58d 100644 --- a/_docs/releases/index.md +++ b/_docs/stakeholders/releases/index.md @@ -1,8 +1,8 @@ --- layout: default title: Release cycles & versioning -nav_order: 2 -permalink: /_docs/changelog +parent: Stakeholders +permalink: /_docs/general/changelog --- _Target readers_ 👩🏽‍💻 🌍 diff --git a/favicon.ico b/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..8461691f142eec3bd07bf093e37b71ef6afb40cc GIT binary patch literal 1947 zcmV;M2W0q(P)T#Rmvuo{U=dXAUH}`3(I`%BOp9W@ zC1cx2n%cC}ncQr~h@bMQ>4#3+=>(H@CN@o@A3BqyHdCXujj$MXyd*VI%mu5&qTFu_ z!gASV&*kk0U|C?fO#d_I!+GB4eg6OFIq&nlM=($9JGIy8jvHE|DCSxu1;?s??p?S1 zvP%&bs%iwT-rCd_47=(O;;NL^O`~$FF`u}$xg4Ia*|ka)`irJHxaW3rQHp7)B*%AS z8Y}ABAUB%2#qYjFm33D z0{|&ub?!A9+E<{dx{~PbU2jv2@`v^nT>R`W_3cx+l&OaOH9LN+D*8VJGG*N6atu?p z_7qNgkouNF3`2{QFKjp%3MEXGR7e0et*XIyZ5KU(RD_V(HZ^=<|Jfa-Q~4%+f){Fb zY*!Wiq?mFx28I);Yh2Ax$jzPB0_1evQy_6@A)NLgWou93iSHS+GH96gM~-YceSMmM zXRCK-+SO345O|_PHFoB5_QrO?x^oWF$=LkB8Pbzm7z(-R8}v|+`NcS8Lr`};_~&gW z0uYtyV9@<)a(u|sHl6L8vM_*lu*#02Jd9*N$a2BxVJy!3l%lK~IP5_>dKXjs-}Q`yoqQwrdN?nm ze%YH_Pc@BK;6RewPhDd%QYzSOA#OFVqN^``3b{ClY5ZP){kv9lw))|+FmQ<<9KWJ1 zP4Y?PTltG`DQj0;MpH-UQC8YrveFs=FfG+Cgm@l!SiRZ1Xusj(g#mR$R{8GfvQ*ttnw%S{*+BYuu*{f zUsw0g+LMW04P#n1TK!p+6kH(Q6&TyA9OE}TXC{xrLU;dP$J=ox2qCi<#t*EtA=xlm z7L6-)o7q)zoQ96&^bVwO@ypVQmXp>It)lwIjH7c55Mu-n4qrq`n=z|B>`#UM#I!7 z%KDu6xPgeHs#tgvJIK$tOwy(yjB=gl+*?O>H%d+E%q zceetZmk^q|;176d?_CmkSA}u-nX1P-Fqu2$ijv3C`{a!W68X8Mv~ zIO;G8A@d!!;6ILT#g7jTf2ihZ3Uz6FbsSKq6?&((QIcJ)siP4eVYVVe}f?%Wk*U+-I-j0^RHMS zUX(Bxz0Dt(7$i+yx!h@68LiwU;9COueF58MCI^8e&M}N7MegU!*#bUoyRN zOTAX%`}yEU9qv%3cP835@7*8NhDf=0pW1L>wQh zgau$)HX1wg07-LK&i_RYqqC(akj97}hlCmduSM2kZO|%wdq5r&ke~>Yob<2p_j~Cd zns*n*ghad#@@c(tYvgp#SX1qgFBi${Aa_o7ihZ@tPD~$&m%;jzURgG2n$8(XJLLN& zQXWWf_3vE1xX$TK?BL>8-(e^ek5da`Nd;9g8POd$?IF?<+i2{{!?bKjXae!J5aNyS ztEK)}@#me&)2GWl?zq6W1=c1hMd5JBow*=xzyrcAC5CQl0lO{S0W{ofTwQyyZp(RT hnKz8XWwTyZ{{st_=9uzSjk5p%002ovPDHLkV1f@sshj`+ literal 0 HcmV?d00001 diff --git a/public/favicon.ico b/public/favicon.ico index a11777cc471a4344702741ab1c8a588998b1311a..8461691f142eec3bd07bf093e37b71ef6afb40cc 100644 GIT binary patch literal 1947 zcmV;M2W0q(P)T#Rmvuo{U=dXAUH}`3(I`%BOp9W@ zC1cx2n%cC}ncQr~h@bMQ>4#3+=>(H@CN@o@A3BqyHdCXujj$MXyd*VI%mu5&qTFu_ z!gASV&*kk0U|C?fO#d_I!+GB4eg6OFIq&nlM=($9JGIy8jvHE|DCSxu1;?s??p?S1 zvP%&bs%iwT-rCd_47=(O;;NL^O`~$FF`u}$xg4Ia*|ka)`irJHxaW3rQHp7)B*%AS z8Y}ABAUB%2#qYjFm33D z0{|&ub?!A9+E<{dx{~PbU2jv2@`v^nT>R`W_3cx+l&OaOH9LN+D*8VJGG*N6atu?p z_7qNgkouNF3`2{QFKjp%3MEXGR7e0et*XIyZ5KU(RD_V(HZ^=<|Jfa-Q~4%+f){Fb zY*!Wiq?mFx28I);Yh2Ax$jzPB0_1evQy_6@A)NLgWou93iSHS+GH96gM~-YceSMmM zXRCK-+SO345O|_PHFoB5_QrO?x^oWF$=LkB8Pbzm7z(-R8}v|+`NcS8Lr`};_~&gW z0uYtyV9@<)a(u|sHl6L8vM_*lu*#02Jd9*N$a2BxVJy!3l%lK~IP5_>dKXjs-}Q`yoqQwrdN?nm ze%YH_Pc@BK;6RewPhDd%QYzSOA#OFVqN^``3b{ClY5ZP){kv9lw))|+FmQ<<9KWJ1 zP4Y?PTltG`DQj0;MpH-UQC8YrveFs=FfG+Cgm@l!SiRZ1Xusj(g#mR$R{8GfvQ*ttnw%S{*+BYuu*{f zUsw0g+LMW04P#n1TK!p+6kH(Q6&TyA9OE}TXC{xrLU;dP$J=ox2qCi<#t*EtA=xlm z7L6-)o7q)zoQ96&^bVwO@ypVQmXp>It)lwIjH7c55Mu-n4qrq`n=z|B>`#UM#I!7 z%KDu6xPgeHs#tgvJIK$tOwy(yjB=gl+*?O>H%d+E%q zceetZmk^q|;176d?_CmkSA}u-nX1P-Fqu2$ijv3C`{a!W68X8Mv~ zIO;G8A@d!!;6ILT#g7jTf2ihZ3Uz6FbsSKq6?&((QIcJ)siP4eVYVVe}f?%Wk*U+-I-j0^RHMS zUX(Bxz0Dt(7$i+yx!h@68LiwU;9COueF58MCI^8e&M}N7MegU!*#bUoyRN zOTAX%`}yEU9qv%3cP835@7*8NhDf=0pW1L>wQh zgau$)HX1wg07-LK&i_RYqqC(akj97}hlCmduSM2kZO|%wdq5r&ke~>Yob<2p_j~Cd zns*n*ghad#@@c(tYvgp#SX1qgFBi${Aa_o7ihZ@tPD~$&m%;jzURgG2n$8(XJLLN& zQXWWf_3vE1xX$TK?BL>8-(e^ek5da`Nd;9g8POd$?IF?<+i2{{!?bKjXae!J5aNyS ztEK)}@#me&)2GWl?zq6W1=c1hMd5JBow*=xzyrcAC5CQl0lO{S0W{ofTwQyyZp(RT hnKz8XWwTyZ{{st_=9uzSjk5p%002ovPDHLkV1f@sshj`+ literal 3870 zcma);c{J4h9>;%nil|2-o+rCuEF-(I%-F}ijC~o(k~HKAkr0)!FCj~d>`RtpD?8b; zXOC1OD!V*IsqUwzbMF1)-gEDD=A573Z-&G7^LoAC9|WO7Xc0Cx1g^Zu0u_SjAPB3vGa^W|sj)80f#V0@M_CAZTIO(t--xg= z!sii`1giyH7EKL_+Wi0ab<)&E_0KD!3Rp2^HNB*K2@PHCs4PWSA32*-^7d{9nH2_E zmC{C*N*)(vEF1_aMamw2A{ZH5aIDqiabnFdJ|y0%aS|64E$`s2ccV~3lR!u<){eS` z#^Mx6o(iP1Ix%4dv`t@!&Za-K@mTm#vadc{0aWDV*_%EiGK7qMC_(`exc>-$Gb9~W!w_^{*pYRm~G zBN{nA;cm^w$VWg1O^^<6vY`1XCD|s_zv*g*5&V#wv&s#h$xlUilPe4U@I&UXZbL z0)%9Uj&@yd03n;!7do+bfixH^FeZ-Ema}s;DQX2gY+7g0s(9;`8GyvPY1*vxiF&|w z>!vA~GA<~JUqH}d;DfBSi^IT*#lrzXl$fNpq0_T1tA+`A$1?(gLb?e#0>UELvljtQ zK+*74m0jn&)5yk8mLBv;=@}c{t0ztT<v;Avck$S6D`Z)^c0(jiwKhQsn|LDRY&w(Fmi91I7H6S;b0XM{e zXp0~(T@k_r-!jkLwd1_Vre^v$G4|kh4}=Gi?$AaJ)3I+^m|Zyj#*?Kp@w(lQdJZf4 z#|IJW5z+S^e9@(6hW6N~{pj8|NO*>1)E=%?nNUAkmv~OY&ZV;m-%?pQ_11)hAr0oAwILrlsGawpxx4D43J&K=n+p3WLnlDsQ$b(9+4 z?mO^hmV^F8MV{4Lx>(Q=aHhQ1){0d*(e&s%G=i5rq3;t{JC zmgbn5Nkl)t@fPH$v;af26lyhH!k+#}_&aBK4baYPbZy$5aFx4}ka&qxl z$=Rh$W;U)>-=S-0=?7FH9dUAd2(q#4TCAHky!$^~;Dz^j|8_wuKc*YzfdAht@Q&ror?91Dm!N03=4=O!a)I*0q~p0g$Fm$pmr$ zb;wD;STDIi$@M%y1>p&_>%?UP($15gou_ue1u0!4(%81;qcIW8NyxFEvXpiJ|H4wz z*mFT(qVx1FKufG11hByuX%lPk4t#WZ{>8ka2efjY`~;AL6vWyQKpJun2nRiZYDij$ zP>4jQXPaP$UC$yIVgGa)jDV;F0l^n(V=HMRB5)20V7&r$jmk{UUIe zVjKroK}JAbD>B`2cwNQ&GDLx8{pg`7hbA~grk|W6LgiZ`8y`{Iq0i>t!3p2}MS6S+ zO_ruKyAElt)rdS>CtF7j{&6rP-#c=7evGMt7B6`7HG|-(WL`bDUAjyn+k$mx$CH;q2Dz4x;cPP$hW=`pFfLO)!jaCL@V2+F)So3}vg|%O*^T1j>C2lx zsURO-zIJC$^$g2byVbRIo^w>UxK}74^TqUiRR#7s_X$e)$6iYG1(PcW7un-va-S&u zHk9-6Zn&>T==A)lM^D~bk{&rFzCi35>UR!ZjQkdSiNX*-;l4z9j*7|q`TBl~Au`5& z+c)*8?#-tgUR$Zd%Q3bs96w6k7q@#tUn`5rj+r@_sAVVLqco|6O{ILX&U-&-cbVa3 zY?ngHR@%l{;`ri%H*0EhBWrGjv!LE4db?HEWb5mu*t@{kv|XwK8?npOshmzf=vZA@ zVSN9sL~!sn?r(AK)Q7Jk2(|M67Uy3I{eRy z_l&Y@A>;vjkWN5I2xvFFTLX0i+`{qz7C_@bo`ZUzDugfq4+>a3?1v%)O+YTd6@Ul7 zAfLfm=nhZ`)P~&v90$&UcF+yXm9sq!qCx3^9gzIcO|Y(js^Fj)Rvq>nQAHI92ap=P z10A4@prk+AGWCb`2)dQYFuR$|H6iDE8p}9a?#nV2}LBCoCf(Xi2@szia7#gY>b|l!-U`c}@ zLdhvQjc!BdLJvYvzzzngnw51yRYCqh4}$oRCy-z|v3Hc*d|?^Wj=l~18*E~*cR_kU z{XsxM1i{V*4GujHQ3DBpl2w4FgFR48Nma@HPgnyKoIEY-MqmMeY=I<%oG~l!f<+FN z1ZY^;10j4M4#HYXP zw5eJpA_y(>uLQ~OucgxDLuf}fVs272FaMxhn4xnDGIyLXnw>Xsd^J8XhcWIwIoQ9} z%FoSJTAGW(SRGwJwb=@pY7r$uQRK3Zd~XbxU)ts!4XsJrCycrWSI?e!IqwqIR8+Jh zlRjZ`UO1I!BtJR_2~7AbkbSm%XQqxEPkz6BTGWx8e}nQ=w7bZ|eVP4?*Tb!$(R)iC z9)&%bS*u(lXqzitAN)Oo=&Ytn>%Hzjc<5liuPi>zC_nw;Z0AE3Y$Jao_Q90R-gl~5 z_xAb2J%eArrC1CN4G$}-zVvCqF1;H;abAu6G*+PDHSYFx@Tdbfox*uEd3}BUyYY-l zTfEsOqsi#f9^FoLO;ChK<554qkri&Av~SIM*{fEYRE?vH7pTAOmu2pz3X?Wn*!ROX ztd54huAk&mFBemMooL33RV-*1f0Q3_(7hl$<#*|WF9P!;r;4_+X~k~uKEqdzZ$5Al zV63XN@)j$FN#cCD;ek1R#l zv%pGrhB~KWgoCj%GT?%{@@o(AJGt*PG#l3i>lhmb_twKH^EYvacVY-6bsCl5*^~L0 zonm@lk2UvvTKr2RS%}T>^~EYqdL1q4nD%0n&Xqr^cK^`J5W;lRRB^R-O8b&HENO||mo0xaD+S=I8RTlIfVgqN@SXDr2&-)we--K7w= zJVU8?Z+7k9dy;s;^gDkQa`0nz6N{T?(A&Iz)2!DEecLyRa&FI!id#5Z7B*O2=PsR0 zEvc|8{NS^)!d)MDX(97Xw}m&kEO@5jqRaDZ!+%`wYOI<23q|&js`&o4xvjP7D_xv@ z5hEwpsp{HezI9!~6O{~)lLR@oF7?J7i>1|5a~UuoN=q&6N}EJPV_GD`&M*v8Y`^2j zKII*d_@Fi$+i*YEW+Hbzn{iQk~yP z>7N{S4)r*!NwQ`(qcN#8SRQsNK6>{)X12nbF`*7#ecO7I)Q$uZsV+xS4E7aUn+U(K baj7?x%VD!5Cxk2YbYLNVeiXvvpMCWYo=by@ From d5082d9c3ffde8847c96862ebb9bbb1ba70c4335 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Wed, 2 Jun 2021 13:58:47 +0200 Subject: [PATCH 16/22] First wip version --- _docs/development/architecture/index.md | 4 +- _docs/development/index.md | 2 +- _docs/development/layers/index.md | 2 +- .../development/layers/layers-update-flow.md | 2 +- _docs/development/scenes/index.md | 2 +- _docs/index.md | 45 ++++++++++++++----- _docs/resigners.md | 5 ++- .../index.md => resources.md} | 2 +- _docs/scientists/index.md | 9 ++-- _docs/stakeholders/index.md | 22 ++++++--- _docs/stakeholders/releases/index.md | 2 +- 11 files changed, 67 insertions(+), 30 deletions(-) rename _docs/{external-resources/index.md => resources.md} (89%) diff --git a/_docs/development/architecture/index.md b/_docs/development/architecture/index.md index 802f75ddf..8b1438bdf 100644 --- a/_docs/development/architecture/index.md +++ b/_docs/development/architecture/index.md @@ -2,10 +2,10 @@ layout: default title: General architecture nav_order: 1 -parent: Developers +parent: Developers 👩🏽‍💻 has_children: true has_toc: true permalink: /_docs/dev/architecture --- -architecture iontro \ No newline at end of file +architecture intro \ No newline at end of file diff --git a/_docs/development/index.md b/_docs/development/index.md index 38cd3b2be..30705c0f0 100644 --- a/_docs/development/index.md +++ b/_docs/development/index.md @@ -1,6 +1,6 @@ --- layout: default -title: Developers +title: Developers 👩🏽‍💻 has_children: true has_toc: true permalink: /_docs/dev diff --git a/_docs/development/layers/index.md b/_docs/development/layers/index.md index 25999e305..5c2f53d1d 100644 --- a/_docs/development/layers/index.md +++ b/_docs/development/layers/index.md @@ -1,7 +1,7 @@ --- layout: default title: Working with layers -parent: Developers +parent: Developers 👩🏽‍💻 has_children: true has_toc: true nav_order: 2 diff --git a/_docs/development/layers/layers-update-flow.md b/_docs/development/layers/layers-update-flow.md index 1820e67ac..c87841121 100644 --- a/_docs/development/layers/layers-update-flow.md +++ b/_docs/development/layers/layers-update-flow.md @@ -2,7 +2,7 @@ layout: default title: Add/update layers parent: Working with layers -grand_parent: Developers +grand_parent: Developers 👩🏽‍💻 nav_order: 1 permalink: /_docs/dev/layers/add-update --- diff --git a/_docs/development/scenes/index.md b/_docs/development/scenes/index.md index a3ad25eed..269465b8c 100644 --- a/_docs/development/scenes/index.md +++ b/_docs/development/scenes/index.md @@ -1,7 +1,7 @@ --- layout: default title: Scenes -parent: Developers +parent: Developers 👩🏽‍💻 has_children: true has_toc: true permalink: /_docs/dev/scenes diff --git a/_docs/index.md b/_docs/index.md index 50ba43fa1..3658d2c36 100644 --- a/_docs/index.md +++ b/_docs/index.md @@ -4,23 +4,46 @@ title: Welcome nav_order: 1 permalink: / --- +## Intro +{: .no_toc } + +This documentation is mainly an onboarding document to the Half Earth project for Vizzuality members. +It is fundamentally focused on developers, although there are general subjects that could benefit any stakeholder on providing them with some useful context on project's jargon and current state. + +You will find emojis here and there on the buttons/links of this documentation. The intention is to clarify target reader of the documentation piece those links redirect to. General useful content pieces would be tagged as Stakeholder focused, that is, any functional area or individual could benefit somehow of reading those pieces. +Target readers: +- Stakeholders 🌍 +- Developers 👩🏽‍💻 +- Scientists 🧑‍🔬 +- Resigners 🧑‍🎨 + +______ + +
+ + Table of contents + + {: .text-delta } +- TOC +{:toc} +
+ +## About the Half-Earth project + +🐡 🦎 🦉 🐍 🐋 🌲 🦧 🌵 -# __The Half-Earth project__ 🐡 🦎 🦉 🐍 🐋 🌲 🦧 🌵 We are living in the sixth mass extinction. __Half-Earth is a call to protect half the land and sea in order to manage sufficient habitat to slow down the species extinction crisis and ensure the long-term health of our planet__. The Half-Earth Project is working to safeguard global biodiversity through detailed mapping of biodiversity, protected areas, and human activities. This information is then used to identify the places and species most in need of conservation action. -## __The Half-Earth Project Map__ 🌎 🌍 🌏 -It provides an interactive summary of progress toward this goal, offered as a tool to help contextualize global datasets of biodiversity, human encroachment, and protection. +## About the Half-Earth Project Map -If you want to jump start into contributting to the repo go ahead and head to the __README.md__ of the project, where you'll find instructions to get started. +🌎 🌍 🌏 -Otherwise keep reading to beeter understand the context of the project and ins and outs related to its development. +The map provides an interactive summary of progress toward Half-Earth goal, offered as a tool to help contextualize global datasets of biodiversity, human encroachment, and protection. -[README 👩🏽‍💻](https://github.com/Vizzuality/half-earth-v3/blob/master/README.md){: .btn .btn-outline } +## Where should I go now -## About this documentation. -Who is it for, structure... +If you are a technician and want to jump start into contributting to the repo go ahead and head to the README of the project, where you'll find instructions to get started. + +[README 👩🏽‍💻](https://github.com/Vizzuality/half-earth-v3/blob/master/README.md){: .btn .btn-outline } -Target readers -devs 👩🏽‍💻 -stakeholders 🌍 diff --git a/_docs/resigners.md b/_docs/resigners.md index ae49a7e32..8a6af2020 100644 --- a/_docs/resigners.md +++ b/_docs/resigners.md @@ -1,8 +1,9 @@ --- layout: default -title: Resigners +title: Resigners 🧑‍🎨 nav_order: 5 permalink: /_docs/resigners --- - +TO DO 👇 +Add intro and point to resigners documentation [User research 2020 docs](https://www.notion.so/2020-Half-Earth-User-Research-eead7c2575f44bb1b0ed4825a8265f1e) \ No newline at end of file diff --git a/_docs/external-resources/index.md b/_docs/resources.md similarity index 89% rename from _docs/external-resources/index.md rename to _docs/resources.md index 51dee77a5..a915362cd 100644 --- a/_docs/external-resources/index.md +++ b/_docs/resources.md @@ -1,6 +1,6 @@ --- layout: default -title: Useful Resources +title: Useful Resources 📚 nav_order: 6 permalink: /_docs/resources --- diff --git a/_docs/scientists/index.md b/_docs/scientists/index.md index d49294807..c2c7cfedf 100644 --- a/_docs/scientists/index.md +++ b/_docs/scientists/index.md @@ -1,10 +1,11 @@ --- layout: default -title: Scientists +title: Scientists 🧑‍🔬 nav_order: 4 -has_children: true -has_toc: true +# has_children: true +# has_toc: true permalink: /_docs/science --- +TO DO 👇 -move repo wiki here \ No newline at end of file +Migrate [project wiki](https://github.com/Vizzuality/half-earth-v3/wiki) here \ No newline at end of file diff --git a/_docs/stakeholders/index.md b/_docs/stakeholders/index.md index 7a44bf5ba..312c3f765 100644 --- a/_docs/stakeholders/index.md +++ b/_docs/stakeholders/index.md @@ -1,8 +1,20 @@ --- layout: default -title: Stakeholders +title: Stakeholders 🌍 nav_order: 2 -has_children: true -has_toc: true -permalink: /_docs/general ---- \ No newline at end of file +# has_children: true +# has_toc: true +permalink: /_docs/stakeholders +--- +## Intro +{: .no_toc } +This Stakeholders section will hold pointers to useful general resources and explanations that would provide an overview of the project. + +
+ + Table of contents + + {: .text-delta } +- TOC +{:toc} +
\ No newline at end of file diff --git a/_docs/stakeholders/releases/index.md b/_docs/stakeholders/releases/index.md index 7551cf58d..4d84b29f1 100644 --- a/_docs/stakeholders/releases/index.md +++ b/_docs/stakeholders/releases/index.md @@ -1,7 +1,7 @@ --- layout: default title: Release cycles & versioning -parent: Stakeholders +parent: Stakeholders 🌍 permalink: /_docs/general/changelog --- From 219058189bb5939dfd7ccecfb14f6219bd48c605 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Wed, 2 Jun 2021 14:14:35 +0200 Subject: [PATCH 17/22] Add science wiki content --- _docs/scientists/index.md | 7 +++--- _docs/scientists/metadata-service.md | 26 +++++++++++++++++++++++ _docs/scientists/pr-reviewing.md | 12 +++++++++++ _docs/scientists/services-whitelisting.md | 10 +++++++++ 4 files changed, 51 insertions(+), 4 deletions(-) create mode 100644 _docs/scientists/metadata-service.md create mode 100644 _docs/scientists/pr-reviewing.md create mode 100644 _docs/scientists/services-whitelisting.md diff --git a/_docs/scientists/index.md b/_docs/scientists/index.md index c2c7cfedf..e76cb4d8c 100644 --- a/_docs/scientists/index.md +++ b/_docs/scientists/index.md @@ -2,10 +2,9 @@ layout: default title: Scientists 🧑‍🔬 nav_order: 4 -# has_children: true -# has_toc: true +has_children: true +has_toc: true permalink: /_docs/science --- -TO DO 👇 +# Intro -Migrate [project wiki](https://github.com/Vizzuality/half-earth-v3/wiki) here \ No newline at end of file diff --git a/_docs/scientists/metadata-service.md b/_docs/scientists/metadata-service.md new file mode 100644 index 000000000..b231d6198 --- /dev/null +++ b/_docs/scientists/metadata-service.md @@ -0,0 +1,26 @@ +--- +layout: default +title: Metadata service +parent: Scientists 🧑‍🔬 +permalink: /_docs/science/metadata-service +--- + +# Metadata service + +The metadata from the info buttons is controlled from a service in arcgis online ([item url](https://eowilson.maps.arcgis.com/home/item.html?id=d899a4364fe5431b8c5bef826ad4430d#data) and [service url](https://services9.arcgis.com/IkktFdUAcY3WrH25/arcgis/rest/services/Metadata2/FeatureServer)). The service can be updated through the arcgis interface or through the python api. +## create new entries +Ask the Front End for the `slug` they will be using to refer to the layer. Then you will provide the information for each field: slug, title (text), description (text), source (markdown text), mol Logo (boolean). +### if using the python api (currently not working, probably because there are new fields created... Should move this information to a table service) +use the [notebook](https://github.com/Vizzuality/he-scratchfolder/blob/master/Metadata_publishing.ipynb) with the code to access the service (you will need appropriate admin permissions): +- access the service +- download the information as csv +- in an editor provide the information for each field: slug, title (text), description (text), source (markdown text), mol Logo (boolean). +- merge the new information to the downloaded csv +- overwrite the service with the complete csv +### if using the arcgis online IDE +Use the append data button and select a file with the new rows. +## edit existing entries +### if using the python api +Same as above but with the updated csv, no need to merge new rows. +### if using the arcgis online IDE +Open the data view and manually edit. **ATTENTION** there is not an undo button. diff --git a/_docs/scientists/pr-reviewing.md b/_docs/scientists/pr-reviewing.md new file mode 100644 index 000000000..53147569e --- /dev/null +++ b/_docs/scientists/pr-reviewing.md @@ -0,0 +1,12 @@ +--- +layout: default +title: Science PR reviewing +parent: Scientists 🧑‍🔬 +permalink: /_docs/science/PRs +--- + +# Science `Pull Requests` reviewing + +The metadata is controlled by the back end (arcGIS online), but some elements of the data are in the FE code. Most of the code reviews from Science involve checking the name of the layers that are shown on the sidebar and the legend. When reviewing follow the `suggest` approach described in [this article](https://haacked.com/archive/2019/06/03/suggested-changes/). +### Code files to check +- The file that contains the layers config that shows information on the side bar and legend is `src/constants/biodiversity-layers-constants.js`. diff --git a/_docs/scientists/services-whitelisting.md b/_docs/scientists/services-whitelisting.md new file mode 100644 index 000000000..c7618cffd --- /dev/null +++ b/_docs/scientists/services-whitelisting.md @@ -0,0 +1,10 @@ +--- +layout: default +title: Services whitelisting +parent: Scientists 🧑‍🔬 +permalink: /_docs/science/whitelisting +--- + +# Services whitelisting + +Map of Life is the data provider of the biodiversity data. Some layers are hosted in the Living Atlas, but those that are not yet published are either provided by the MOL API or as transition into any of those two hosting services they are in the arcgis online organisation page. When the data is served from arcgis online a set of links have to be whitelisted. Reach to the dev team to get the list. To whitelist follow the instructions in the [science wiki](https://github.com/Vizzuality/sci-team-wiki/wiki/ESRI---ArcGIS-Online#whitelisting-services-see-here-for-the-step-by-step-esri-help). From 506f20090f3e3518e1b9d8ca5a3e7c1716414873 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Wed, 2 Jun 2021 14:31:53 +0200 Subject: [PATCH 18/22] Update script and readme --- README.md | 41 ++-------------- .../architecture/index.md | 0 _docs/dev/architecture/state-management.md | 47 +++++++++++++++++++ _docs/{development => dev}/index.md | 0 _docs/{development => dev}/layers/index.md | 0 .../layers/layers-update-flow.md | 0 _docs/{development => dev}/scenes/index.md | 0 package.json | 2 +- 8 files changed, 52 insertions(+), 38 deletions(-) rename _docs/{development => dev}/architecture/index.md (100%) create mode 100644 _docs/dev/architecture/state-management.md rename _docs/{development => dev}/index.md (100%) rename _docs/{development => dev}/layers/index.md (100%) rename _docs/{development => dev}/layers/layers-update-flow.md (100%) rename _docs/{development => dev}/scenes/index.md (100%) diff --git a/README.md b/README.md index 9cefe3925..161ef8457 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,10 @@ Open [http://localhost:3000](http://localhost:3000) to view it in the browser. The page will reload if you make edits.
You will also see any lint errors in the console. +### `yarn docs:serve` + + + ### `yarn test` Launches the test runner in the interactive watch mode.
@@ -39,44 +43,7 @@ This file is ised to override/extend the default `create-react-app` webpack conf Since `create-react-app` version 2 is used under the hoods no configuration to allow the use of [`CSSModules`](https://facebook.github.io/create-react-app/docs/adding-a-css-modules-stylesheet) is needed. Just have in mind that for it to work the file naming convention `file-name.module.scss` should be followed. -## State Management - -### `ReduceRegistry` - -For state management we are using `Redux`. -To avoid loading all redux modules on the first load when we initialize the `store` (for detailed implementation check out `store.js` file) we introduced code-splitting as indicated in this [`article`](http://nicolasgallagher.com/redux-modules-and-code-splitting/). There are few files that make it possible: -* `reducerRegistry` - class that enables adding redux reducers to the store's reducer after the store has been already created - loading on-demand. This class has a `register` method that we use for adding reducers to the store on-demand. -* `store` - * first we register reducers that we need on first load - ``` - import reducerRegistry from 'reducerRegistry'; - reducerRegistry.register('location', router.reducer); - ``` - * we add a listener that listens for new reducers to be registered and replace store's reducer whenever that happens (whenever `register` method from `reducerRegistry` class is called). -* `some-example-redux-module` - we split redux code into self-contained modules that comprise of a reducer, actions and initial state. In their index files that combine all of them together (we give them module's name, i.e. `dataGlobeSpec.js`) we register module into redux's store: - ``` - reducerRegistry.registerModule('dataGlobeSpec', { - actions, - reducers, - initialState - }); - ``` - - ![`dataGlobeSpec` on the `store`](public/store-example2.png) - -### Redux-modules and `location` state - -As described before we create dedicated `store` keys by registering `reducers` through the `reducerRegistry` `class`. We do that to store the data that would back the different components of the app; so content of modals, charts or even the ArcGIS Online portal items specs would be stored that way. -A dedicated folder under `redux-modules` should be created to take care of this flow. -On the other hand, reliyng on [redux-first-router](https://www.npmjs.com/package/redux-first-router/v/0.0.9-rudy) `location` key inside `redux` store, we are using a kind of mixed approach to state management. Beyond _bussiness_ data (stored through `redux-modules`) we want to have a shareable _current_ state of the app in every momment; to do that we are updating `location` `query` params each time a change to the app state is triggered. This changes are handled through `selectors` to update components state. More or less this is how it works: - -- Have separated keys inside `location` to reference different types of app state. We've created the `globe` key to store app state related to the globe (things like `activeLayers`, `landscapeMode`, `zoom` level, globe `extent`, camera centre `coordinates`... would go inside that key). We've also set a `ui` key to store other states that do not directly reference globe internals but have influence on layout and widgets state. - -- We've shamelessly stolen the `utils/stateToUrl` folder from Global Forest Watch. It has some utilities to `parse` and `stringify` query params (doing some `atob` encoding, and also have the `setComponentStateToUrl` function that gets used inside components `actions` to update `location` state). - -- So inside the pages `selectors` we merge the `location` state with the `initial state` defined for each page to get the _actual_ state of the app and pass it to page components to define the way they should be displayed (both `globe` and `ui` state). - ![`location` with UI and GLOBE keys](public/store-example1.png) diff --git a/_docs/development/architecture/index.md b/_docs/dev/architecture/index.md similarity index 100% rename from _docs/development/architecture/index.md rename to _docs/dev/architecture/index.md diff --git a/_docs/dev/architecture/state-management.md b/_docs/dev/architecture/state-management.md new file mode 100644 index 000000000..1467dd03b --- /dev/null +++ b/_docs/dev/architecture/state-management.md @@ -0,0 +1,47 @@ +--- +layout: default +title: State Management +parent: General architecture +grand_parent: Developers 👩🏽‍💻 +nav_order: 1 +permalink: /_docs/dev/architecture/state-management +--- + +# State Management + +## `reducerRegistry` + +For state management we are using `Redux`. +To avoid loading all redux modules on the first load when we initialize the `store` (for detailed implementation check out `store.js` file) we introduced code-splitting as indicated in this [`article`](http://nicolasgallagher.com/redux-modules-and-code-splitting/). There are few files that make it possible: +* `reducerRegistry` - class that enables adding redux reducers to the store's reducer after the store has been already created - loading on-demand. This class has a `register` method that we use for adding reducers to the store on-demand. +* `store` + * first we register reducers that we need on first load + ```js + import reducerRegistry from 'reducerRegistry'; + reducerRegistry.register('location', router.reducer); + ``` + * we add a listener that listens for new reducers to be registered and replace store's reducer whenever that happens (whenever `register` method from `reducerRegistry` class is called). +* `some-example-redux-module` - we split redux code into self-contained modules that comprise of a reducer, actions and initial state. In their index files that combine all of them together (we give them module's name, i.e. `dataGlobeSpec.js`) we register module into redux's store: + ```js + reducerRegistry.registerModule('dataGlobeSpec', { + actions, + reducers, + initialState + }); + ``` + + ![`dataGlobeSpec` on the `store`](/public/store-example2.png) + +## Redux-modules and `location` state + +As described before we create dedicated `store` keys by registering `reducers` through the `reducerRegistry` `class`. We do that to store the data that would back the different components of the app; so content of modals, charts or even the ArcGIS Online portal items specs would be stored that way. +A dedicated folder under `redux-modules` should be created to take care of this flow. +On the other hand, reliyng on [redux-first-router](https://www.npmjs.com/package/redux-first-router/v/0.0.9-rudy) `location` key inside `redux` store, we are using a kind of mixed approach to state management. Beyond _bussiness_ data (stored through `redux-modules`) we want to have a shareable _current_ state of the app in every momment; to do that we are updating `location` `query` params each time a change to the app state is triggered. This changes are handled through `selectors` to update components state. More or less this is how it works: + +- Have separated keys inside `location` to reference different types of app state. We've created the `globe` key to store app state related to the globe (things like `activeLayers`, `landscapeMode`, `zoom` level, globe `extent`, camera centre `coordinates`... would go inside that key). We've also set a `ui` key to store other states that do not directly reference globe internals but have influence on layout and widgets state. + +- We've shamelessly stolen the `utils/stateToUrl` folder from Global Forest Watch. It has some utilities to `parse` and `stringify` query params (doing some `atob` encoding, and also have the `setComponentStateToUrl` function that gets used inside components `actions` to update `location` state). + +- So inside the pages `selectors` we merge the `location` state with the `initial state` defined for each page to get the _actual_ state of the app and pass it to page components to define the way they should be displayed (both `globe` and `ui` state). + + ![`location` with UI and GLOBE keys](/public/store-example1.png) \ No newline at end of file diff --git a/_docs/development/index.md b/_docs/dev/index.md similarity index 100% rename from _docs/development/index.md rename to _docs/dev/index.md diff --git a/_docs/development/layers/index.md b/_docs/dev/layers/index.md similarity index 100% rename from _docs/development/layers/index.md rename to _docs/dev/layers/index.md diff --git a/_docs/development/layers/layers-update-flow.md b/_docs/dev/layers/layers-update-flow.md similarity index 100% rename from _docs/development/layers/layers-update-flow.md rename to _docs/dev/layers/layers-update-flow.md diff --git a/_docs/development/scenes/index.md b/_docs/dev/scenes/index.md similarity index 100% rename from _docs/development/scenes/index.md rename to _docs/dev/scenes/index.md diff --git a/package.json b/package.json index c74e61432..5afa7ad56 100644 --- a/package.json +++ b/package.json @@ -54,7 +54,7 @@ "build-service-worker": "node ./src/service-worker-build.js", "build": "react-app-rewired build && npm run build-service-worker && npm run clean-cra-sw", "cypress:open": "cypress open", - "docs": "bundle exec jekyll serve", + "docs:serve": "bundle exec jekyll serve", "eject": "react-scripts eject" }, "eslintConfig": { From 4dd8978adf1331921b807d1e87c2e9f1724867a7 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Fri, 4 Jun 2021 12:31:37 +0200 Subject: [PATCH 19/22] Open links in new tab --- _docs/dev/architecture/state-management.md | 4 ++-- _docs/dev/layers/layers-update-flow.md | 5 +---- _docs/index.md | 2 +- _docs/resigners.md | 2 +- _docs/resources.md | 2 +- _docs/scientists/metadata-service.md | 4 ++-- _docs/scientists/pr-reviewing.md | 2 +- _docs/scientists/services-whitelisting.md | 2 +- _docs/stakeholders/index.md | 11 +---------- _docs/stakeholders/releases/index.md | 12 +++++++++--- 10 files changed, 20 insertions(+), 26 deletions(-) diff --git a/_docs/dev/architecture/state-management.md b/_docs/dev/architecture/state-management.md index 1467dd03b..2f0203f0a 100644 --- a/_docs/dev/architecture/state-management.md +++ b/_docs/dev/architecture/state-management.md @@ -12,7 +12,7 @@ permalink: /_docs/dev/architecture/state-management ## `reducerRegistry` For state management we are using `Redux`. -To avoid loading all redux modules on the first load when we initialize the `store` (for detailed implementation check out `store.js` file) we introduced code-splitting as indicated in this [`article`](http://nicolasgallagher.com/redux-modules-and-code-splitting/). There are few files that make it possible: +To avoid loading all redux modules on the first load when we initialize the `store` (for detailed implementation check out `store.js` file) we introduced code-splitting as indicated in [this article](http://nicolasgallagher.com/redux-modules-and-code-splitting/){:target="_blank"}. There are few files that make it possible: * `reducerRegistry` - class that enables adding redux reducers to the store's reducer after the store has been already created - loading on-demand. This class has a `register` method that we use for adding reducers to the store on-demand. * `store` * first we register reducers that we need on first load @@ -36,7 +36,7 @@ To avoid loading all redux modules on the first load when we initialize the `sto As described before we create dedicated `store` keys by registering `reducers` through the `reducerRegistry` `class`. We do that to store the data that would back the different components of the app; so content of modals, charts or even the ArcGIS Online portal items specs would be stored that way. A dedicated folder under `redux-modules` should be created to take care of this flow. -On the other hand, reliyng on [redux-first-router](https://www.npmjs.com/package/redux-first-router/v/0.0.9-rudy) `location` key inside `redux` store, we are using a kind of mixed approach to state management. Beyond _bussiness_ data (stored through `redux-modules`) we want to have a shareable _current_ state of the app in every momment; to do that we are updating `location` `query` params each time a change to the app state is triggered. This changes are handled through `selectors` to update components state. More or less this is how it works: +On the other hand, reliyng on [redux-first-router](https://www.npmjs.com/package/redux-first-router/v/0.0.9-rudy){:target="_blank"} `location` key inside `redux` store, we are using a kind of mixed approach to state management. Beyond _bussiness_ data (stored through `redux-modules`) we want to have a shareable _current_ state of the app in every momment; to do that we are updating `location` `query` params each time a change to the app state is triggered. This changes are handled through `selectors` to update components state. More or less this is how it works: - Have separated keys inside `location` to reference different types of app state. We've created the `globe` key to store app state related to the globe (things like `activeLayers`, `landscapeMode`, `zoom` level, globe `extent`, camera centre `coordinates`... would go inside that key). We've also set a `ui` key to store other states that do not directly reference globe internals but have influence on layout and widgets state. diff --git a/_docs/dev/layers/layers-update-flow.md b/_docs/dev/layers/layers-update-flow.md index c87841121..757fed7be 100644 --- a/_docs/dev/layers/layers-update-flow.md +++ b/_docs/dev/layers/layers-update-flow.md @@ -7,9 +7,6 @@ nav_order: 1 permalink: /_docs/dev/layers/add-update --- -_Target readers_: 👩🏽‍💻 -_What you'll get from this page_: - # Layers update flow. Adding layers to the project is just a matter of following some steps to create the proper entry in the `layersConfig` object. This config will be consumed by the code that will take care of creating and adding the layers to the globe (that is the `createLayer` and `addLayerToMap` functions on `utils/layer-manager-utils`). @@ -32,7 +29,7 @@ Lets explain the steps with an example on how we would add a layer with fishes p } ``` - First of all we need to know if the type of layer we want to add is already present on the `LAYER_TYPES` constant on the `constants/layers-config` file. -Find [in this link](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html) the list of the available layer types on the ArcGIS js API. +Find [in this link](https://developers.arcgis.com/javascript/latest/api-reference/esri-layers-Layer.html){:target="_blank"} the list of the available layer types on the ArcGIS js API. These are the layer types we are currently using in the platform: ```js const LAYER_TYPES = { diff --git a/_docs/index.md b/_docs/index.md index 3658d2c36..99bcfc745 100644 --- a/_docs/index.md +++ b/_docs/index.md @@ -45,5 +45,5 @@ The map provides an interactive summary of progress toward Half-Earth goal, offe If you are a technician and want to jump start into contributting to the repo go ahead and head to the README of the project, where you'll find instructions to get started. -[README 👩🏽‍💻](https://github.com/Vizzuality/half-earth-v3/blob/master/README.md){: .btn .btn-outline } +[README 👩🏽‍💻](https://github.com/Vizzuality/half-earth-v3/blob/master/README.md){:target="_blank" .btn .btn-outline } diff --git a/_docs/resigners.md b/_docs/resigners.md index 8a6af2020..d63a735e2 100644 --- a/_docs/resigners.md +++ b/_docs/resigners.md @@ -6,4 +6,4 @@ permalink: /_docs/resigners --- TO DO 👇 Add intro and point to resigners documentation -[User research 2020 docs](https://www.notion.so/2020-Half-Earth-User-Research-eead7c2575f44bb1b0ed4825a8265f1e) \ No newline at end of file +[User research 2020 docs](https://www.notion.so/2020-Half-Earth-User-Research-eead7c2575f44bb1b0ed4825a8265f1e){:target="_blank"} \ No newline at end of file diff --git a/_docs/resources.md b/_docs/resources.md index a915362cd..5dd020209 100644 --- a/_docs/resources.md +++ b/_docs/resources.md @@ -7,4 +7,4 @@ permalink: /_docs/resources ## Resources outside the docs -- [Build a 3D globe app with the ArcGIS JS API](https://learn.arcgis.com/en/projects/build-a-3d-globe-app-with-the-arcgis-api-for-javascript/) \ No newline at end of file +- [Build a 3D globe app with the ArcGIS JS API](https://learn.arcgis.com/en/projects/build-a-3d-globe-app-with-the-arcgis-api-for-javascript/){:target="_blank"} \ No newline at end of file diff --git a/_docs/scientists/metadata-service.md b/_docs/scientists/metadata-service.md index b231d6198..021102ea2 100644 --- a/_docs/scientists/metadata-service.md +++ b/_docs/scientists/metadata-service.md @@ -7,11 +7,11 @@ permalink: /_docs/science/metadata-service # Metadata service -The metadata from the info buttons is controlled from a service in arcgis online ([item url](https://eowilson.maps.arcgis.com/home/item.html?id=d899a4364fe5431b8c5bef826ad4430d#data) and [service url](https://services9.arcgis.com/IkktFdUAcY3WrH25/arcgis/rest/services/Metadata2/FeatureServer)). The service can be updated through the arcgis interface or through the python api. +The metadata from the info buttons is controlled from a service in arcgis online ([item url](https://eowilson.maps.arcgis.com/home/item.html?id=d899a4364fe5431b8c5bef826ad4430d#data){:target="_blank"} and [service url](https://services9.arcgis.com/IkktFdUAcY3WrH25/arcgis/rest/services/Metadata2/FeatureServer){:target="_blank"}). The service can be updated through the arcgis interface or through the python api. ## create new entries Ask the Front End for the `slug` they will be using to refer to the layer. Then you will provide the information for each field: slug, title (text), description (text), source (markdown text), mol Logo (boolean). ### if using the python api (currently not working, probably because there are new fields created... Should move this information to a table service) -use the [notebook](https://github.com/Vizzuality/he-scratchfolder/blob/master/Metadata_publishing.ipynb) with the code to access the service (you will need appropriate admin permissions): +use the [notebook](https://github.com/Vizzuality/he-scratchfolder/blob/master/Metadata_publishing.ipynb){:target="_blank"} with the code to access the service (you will need appropriate admin permissions): - access the service - download the information as csv - in an editor provide the information for each field: slug, title (text), description (text), source (markdown text), mol Logo (boolean). diff --git a/_docs/scientists/pr-reviewing.md b/_docs/scientists/pr-reviewing.md index 53147569e..09dd344af 100644 --- a/_docs/scientists/pr-reviewing.md +++ b/_docs/scientists/pr-reviewing.md @@ -7,6 +7,6 @@ permalink: /_docs/science/PRs # Science `Pull Requests` reviewing -The metadata is controlled by the back end (arcGIS online), but some elements of the data are in the FE code. Most of the code reviews from Science involve checking the name of the layers that are shown on the sidebar and the legend. When reviewing follow the `suggest` approach described in [this article](https://haacked.com/archive/2019/06/03/suggested-changes/). +The metadata is controlled by the back end (arcGIS online), but some elements of the data are in the FE code. Most of the code reviews from Science involve checking the name of the layers that are shown on the sidebar and the legend. When reviewing follow the `suggest` approach described in [this article](https://haacked.com/archive/2019/06/03/suggested-changes/){:target="_blank"}. ### Code files to check - The file that contains the layers config that shows information on the side bar and legend is `src/constants/biodiversity-layers-constants.js`. diff --git a/_docs/scientists/services-whitelisting.md b/_docs/scientists/services-whitelisting.md index c7618cffd..37159d6e8 100644 --- a/_docs/scientists/services-whitelisting.md +++ b/_docs/scientists/services-whitelisting.md @@ -7,4 +7,4 @@ permalink: /_docs/science/whitelisting # Services whitelisting -Map of Life is the data provider of the biodiversity data. Some layers are hosted in the Living Atlas, but those that are not yet published are either provided by the MOL API or as transition into any of those two hosting services they are in the arcgis online organisation page. When the data is served from arcgis online a set of links have to be whitelisted. Reach to the dev team to get the list. To whitelist follow the instructions in the [science wiki](https://github.com/Vizzuality/sci-team-wiki/wiki/ESRI---ArcGIS-Online#whitelisting-services-see-here-for-the-step-by-step-esri-help). +Map of Life is the data provider of the biodiversity data. Some layers are hosted in the Living Atlas, but those that are not yet published are either provided by the MOL API or as transition into any of those two hosting services they are in the arcgis online organisation page. When the data is served from arcgis online a set of links have to be whitelisted. Reach to the dev team to get the list. To whitelist follow the instructions in the [science wiki](https://github.com/Vizzuality/sci-team-wiki/wiki/ESRI---ArcGIS-Online#whitelisting-services-see-here-for-the-step-by-step-esri-help){:target="_blank"}. diff --git a/_docs/stakeholders/index.md b/_docs/stakeholders/index.md index 312c3f765..525ba35f2 100644 --- a/_docs/stakeholders/index.md +++ b/_docs/stakeholders/index.md @@ -2,19 +2,10 @@ layout: default title: Stakeholders 🌍 nav_order: 2 -# has_children: true +has_children: true # has_toc: true permalink: /_docs/stakeholders --- ## Intro {: .no_toc } This Stakeholders section will hold pointers to useful general resources and explanations that would provide an overview of the project. - -
- - Table of contents - - {: .text-delta } -- TOC -{:toc} -
\ No newline at end of file diff --git a/_docs/stakeholders/releases/index.md b/_docs/stakeholders/releases/index.md index 4d84b29f1..118e5046e 100644 --- a/_docs/stakeholders/releases/index.md +++ b/_docs/stakeholders/releases/index.md @@ -8,23 +8,29 @@ permalink: /_docs/general/changelog _Target readers_ 👩🏽‍💻 🌍 -[Current release](https://github.com/Vizzuality/half-earth-v3/releases){: .btn .btn-outline} +[Current release](https://github.com/Vizzuality/half-earth-v3/releases){: target="_blank" .btn .btn-outline} # Releases and changelog What we want to accomplish through releases and changelog (share the state of the project with stake holders, allow dev to have ) - Folowing [Keep a changelog structure](https://keepachangelog.com/en/1.0.0/) + Folowing [Keep a changelog structure](https://keepachangelog.com/en/1.0.0/){:target="_blank"} ## Semantic versioning on Half Earth -We do our own flavour of [Semantic Versioning](https://semver.org), in order to fulfill the specificities of a data intensive user facing project. +We do our own flavour of [Semantic Versioning](https://semver.org){:target="_blank"}, in order to fulfill the specificities of a data intensive user facing project. In short, updates on version number will increase depending on the type of change that has been done to the codebase. +This should be the structure of the version number: `major.minor.patch` + +Find below the types of changes that fit in each category: + ### Major - New Features (like in Jira epics) - New data layers - Higher scale data layers + ### Minor - Data layers updates - Metadata updates (in case anything needs to be deployed from the platform) - Js API upgrades - Chore implementation for internal use - Design iterations on existing features + ### Patch - Bug fixes - Typos \ No newline at end of file From 647b06a55f62222fbe2d106f6e961e0e401dafc0 Mon Sep 17 00:00:00 2001 From: weberjavi Date: Thu, 3 Jun 2021 11:15:32 +0200 Subject: [PATCH 20/22] Add _site folder to gitignore --- .gitignore | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.gitignore b/.gitignore index f9d277aa1..d4bf1f220 100644 --- a/.gitignore +++ b/.gitignore @@ -22,3 +22,5 @@ npm-debug.log* yarn-debug.log* yarn-error.log* + +/_site From 17a7d0f31296ad5470a5dc28bc9e77fbe6361eeb Mon Sep 17 00:00:00 2001 From: weberjavi Date: Fri, 4 Jun 2021 11:45:29 +0200 Subject: [PATCH 21/22] Remove animation from foreignObject --- .../scatter-plot/scatter-plot-component.jsx | 77 +++++++++---------- .../scatter-plot-styles.module.scss | 2 +- 2 files changed, 36 insertions(+), 43 deletions(-) diff --git a/src/components/charts/scatter-plot/scatter-plot-component.jsx b/src/components/charts/scatter-plot/scatter-plot-component.jsx index b0640f3bd..2dae255b1 100644 --- a/src/components/charts/scatter-plot/scatter-plot-component.jsx +++ b/src/components/charts/scatter-plot/scatter-plot-component.jsx @@ -129,8 +129,6 @@ const ScatterPlot = ({ fill={bubble.color} /> } - - - - { - setTooltipState({ - x:getX(e, chartSurfaceRef), - y:getY(e, chartSurfaceRef), - name: bubble.name, - continent: bubble.continent, - color: bubble.color - }) - setTickLine(bubble.iso); - setXAxisValue(bubble.xAxisValues[countryChallengesSelectedKey]); - setYAxisValue(bubble.yAxisValue); - } - } - onMouseLeave={() => { - setTooltipState(null); - setTickLine(null); - setXAxisValue(null); - setYAxisValue(null); - }} - > -
- - {bubble.iso} - -
- - + { + setTooltipState({ + x:getX(e, chartSurfaceRef), + y:getY(e, chartSurfaceRef), + name: bubble.name, + continent: bubble.continent, + color: bubble.color + }) + setTickLine(bubble.iso); + setXAxisValue(bubble.xAxisValues[countryChallengesSelectedKey]); + setYAxisValue(bubble.yAxisValue); + } + } + onMouseLeave={() => { + setTooltipState(null); + setTickLine(null); + setXAxisValue(null); + setYAxisValue(null); + }} + > +
+ + {bubble.iso} + +
+ ))} diff --git a/src/components/charts/scatter-plot/scatter-plot-styles.module.scss b/src/components/charts/scatter-plot/scatter-plot-styles.module.scss index 712626ce1..b8e83388b 100644 --- a/src/components/charts/scatter-plot/scatter-plot-styles.module.scss +++ b/src/components/charts/scatter-plot/scatter-plot-styles.module.scss @@ -31,7 +31,7 @@ $chart-margin: 14px; .bubbleText { @extend %title; - color: $dark-text; + color: #040E14; } .bubbleValue { @extend %title; From 7868fce6ffd5fae8303cc206636191f3abec0f7b Mon Sep 17 00:00:00 2001 From: weberjavi Date: Fri, 4 Jun 2021 12:04:22 +0200 Subject: [PATCH 22/22] Add variable for color --- .../charts/scatter-plot/scatter-plot-styles.module.scss | 2 +- src/scenes/country-scene/country-scene-styles.module.scss | 2 +- src/styles/settings.scss | 1 + 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/src/components/charts/scatter-plot/scatter-plot-styles.module.scss b/src/components/charts/scatter-plot/scatter-plot-styles.module.scss index b8e83388b..52f26791d 100644 --- a/src/components/charts/scatter-plot/scatter-plot-styles.module.scss +++ b/src/components/charts/scatter-plot/scatter-plot-styles.module.scss @@ -31,7 +31,7 @@ $chart-margin: 14px; .bubbleText { @extend %title; - color: #040E14; + color: $challenges-view-background; } .bubbleValue { @extend %title; diff --git a/src/scenes/country-scene/country-scene-styles.module.scss b/src/scenes/country-scene/country-scene-styles.module.scss index 00bfdbc4c..6ea440da7 100644 --- a/src/scenes/country-scene/country-scene-styles.module.scss +++ b/src/scenes/country-scene/country-scene-styles.module.scss @@ -11,7 +11,7 @@ position: absolute; top: 0; left: 0; - background-color: #040E14; + background-color: $challenges-view-background; opacity: 0; width: 100vw; height: 100vh; diff --git a/src/styles/settings.scss b/src/styles/settings.scss index bc1f51185..750400822 100644 --- a/src/styles/settings.scss +++ b/src/styles/settings.scss @@ -68,6 +68,7 @@ $human-pressure-high: #F3E0F7; $human-pressure-mid: #9F82CE; $human-pressure-low: #282052; $human-pressures-gradient: linear-gradient(270deg, $human-pressure-high 0%, $human-pressure-mid 50%, $human-pressure-low 100%); +$challenges-view-background: #040E14; // country ranking $endemic-species: #F8D300; $non-endemic-species: #F87200;