Fix update mkdocs+plugins (#46)

* Updated versions of plugins

* fix: Updated multiple things, see below:

* match the updated plug in versions
* Added a cookie + privacy policy
* updated the URLs for the site and repo.
* prepare for localization.

* fix: email address + website url

* Replaced link by MobilityData short URL

Replaced a google short url by a MobilityData one.

* Fixed list

* Changed gbfs.mobilitydata.org to gbfs.org

* docs: Updated instructions

* Changed to `pip install --force-reinstall -r requirements.txt` as it forces to reinstall all plugins, fixes an issue when old plugins remain and causes errors when building or serving the site.
* Changed order of the first 2 items.
* Specified which command is for linux and which is for macOS.

* Update docs/participate.md

Co-authored-by: Fabien Richard-Allouard <[email protected]>

---------

Co-authored-by: Fabien Richard-Allouard <[email protected]>

README.md

@@ -15,14 +15,14 @@ Alternatively, you can provide feedback using this [form](https://mobilitydata.t
 ## Building the site locally
 
 1. In Terminal, change the directory to one where you wish to build the site.
+1. Ensure you have an up-to-date version of pip: 
+   - Linux: `pip install pip` or `pip install --upgrade pip`
+   - macOS: `pip3 install pip` or `pip3 install --upgrade pip`
 1. Clone this repository:
    - `git clone https://github.com/MobilityData/gbfs.org`
-1. Ensure you have an up-to-date version of pip: 
-   - `pip install pip`
-   - N.B.: on macOS, use `pip3 install pip` with Python 3.
 1. Change the directory to the cloned repository, and have [`requirements.txt`](requirements.txt) installed:
-   - `pip install -r requirements.txt`
-   - N.B.: on macOS, use `pip3 install -r requirements.txt` with Python 3.
+   - Linux: `pip install --force-reinstall -r requirements.txt`
+   - macOS: `pip3 install --force-reinstall -r requirements.txt`
 1. Assuming you are still in the cloned repository, run this command to update the content for the specification references and best practices:
    - `bash scripts/fetchdata.sh`
 1. To run the site locally: `mkdocs serve`

docs/learn/guide.md

@@ -202,7 +202,7 @@ We recommend specifying liberal terms of use (see list of [common licenses](http
 
 #### Adding your feeds to the catalog
 
-Add the [gbfs.json](https://github.com/MobilityData/gbfs/blob/master/gbfs.md#gbfsjson) file URL or API endpoint in the MobilityData [systems.csv](https://github.com/MobilityData/gbfs/blob/master/systems.csv) catalog. It allows developers to build software on top of it, provides a source for research projects, and demonstrates the reach of the specification worldwide. To add a system, please fork the [repository](https://github.com/MobilityData/gbfs) and submit a pull request. Please keep this list alphabetized by country and system name. Alternatively, fill out [this contribution form](https://forms.gle/WSXFuXx9k4PSTfbC9) for a Github-less contribution.
+Add the [gbfs.json](https://github.com/MobilityData/gbfs/blob/master/gbfs.md#gbfsjson) file URL or API endpoint in the MobilityData [systems.csv](https://github.com/MobilityData/gbfs/blob/master/systems.csv) catalog. It allows developers to build software on top of it, provides a source for research projects, and demonstrates the reach of the specification worldwide. To add a system, please fork the [repository](https://github.com/MobilityData/gbfs) and submit a pull request. Please keep this list alphabetized by country and system name. Alternatively, fill out [this contribution form](https://share.mobilitydata.org/gbfs-feed-contribution-form) for a Github-less contribution.
 
 All systems must have an entry in [systems.csv](https://github.com/MobilityData/gbfs/blob/master/systems.csv) to be compliant with GBFS. This catalog is public data that cannot be owned or sold by anyone, including MobilityData. The purpose of this catalog is to allow consumers of GBFS data to find multiple feeds in one place. You may also publish an announcement that makes your feeds available for use through whichever channel you prefer (ex: blog post, press release, newsletter, etc).
 

docs/participate.md

@@ -20,13 +20,13 @@ The full text of the [project governance process](https://github.com/MobilityDat
 
 Comments or questions can be addressed to the community by [opening an issue](https://github.com/MobilityData/gbfs/issues) on the project GitHub repository. Proposals for changes or additions to the specification can be made through GitHub [pull requests](https://github.com/MobilityData/gbfs/pulls).
 
-Questions can also be addressed to the community via the [public GBFS Slack channel](https://share.mobilitydata.org/slack) or to the shared mobility staff at MobilityData: <[email protected]>.
+Questions can also be addressed to the community via the [public GBFS Slack channel](https://share.mobilitydata.org/slack) or to the shared mobility staff at MobilityData: [[email protected]](mailto:[email protected]).
 
 <hr>
 
 ## Contributing to this site
 
-To propose changes or additions to this site, [open an issue](https://github.com/MobilityData/gbfs.mobilitydata.org/issues/new) on the [gbfs.mobilitydata.org repository](https://github.com/MobilityData/gbfs.mobilitydata.org).
+To propose changes or additions to this site, [open an issue](https://github.com/MobilityData/gbfs.org/issues/new) on the [gbfs.org repository](https://github.com/MobilityData/gbfs.org).
 
 Alternatively, you can provide feedback on this site by using the form below.
 

mkdocs.yml

@@ -1,6 +1,16 @@
 site_name: General Bikeshare Feed Specification
-site_url: https://gbfs.mobilitydata.org
-repo_url: https://github.com/nabsa/gbfs
+site_url: https://gbfs.org
+repo_url: https://github.com/MobilityData/gbfs
+
+validation:
+  nav:
+    omitted_files: info
+    not_found: warn
+    absolute_links: info
+  links:
+    not_found: warn
+    absolute_links: ignore
+    unrecognized_links: ignore
 
 theme:
   logo_light_mode: assets/venn.svg
@@ -17,17 +27,29 @@ theme:
     text: SF Pro
     code: SF Mono
   features:
-     - navigation.tabs
-     - navigation.indexes
-     - navigation.top
-     - toc.integrate
+      - navigation.tabs
+      - navigation.indexes
+      - navigation.top
+      # - navigation.instant
+      # - navigation.instant.progress
+      - toc.integrate
+      - content.tabs.link
+      - search.suggest
   custom_dir: theme_overrides
 extra_css:
   - assets/stylesheets/extra.css
 extra:
   analytics:
     provider: google
     property: G-N7RXJMH84M
+  consent:
+    title: Cookie Consent
+    description: >-
+      We use cookies to track visits, stored anonymously. With your consent, you're helping us to make our documentation better. See our <a href="https://mobilitydata.org/privacy-policy/">Privacy Policy</a>.
+    actions:
+        - accept
+        - reject
+        - manage
   social:
     - icon: fontawesome/brands/github
       link: https://github.com/MobilityData
@@ -49,14 +71,24 @@ markdown_extensions:
   - pymdownx.superfences
 
 plugins:
-  - search
+  - search:
+      lang: en
   - redirects:
       redirect_maps:
         'home.md': 'index.md'
         'major-change-proposals.md': 'specification/change-proposals.md'
         'tools-services.md': 'toolbox/index.md'
         'faq.md': 'learn/faq.md'
         'about.md': 'participate.md'
+  - i18n:
+      docs_structure: folder
+      reconfigure_search: false
+      reconfigure_material: true
+      languages:
+        - locale: en
+          name: English
+          build: true
+          default: true
 
 nav:
 - Home: index.md
@@ -77,4 +109,4 @@ nav:
     - Data Policy Europe: learn/white-papers/data-policy-europe.md
   - FAQ: learn/faq.md
 - Participate: participate.md
-- Implementation Guide: learn/guide.md
+- Implementation Guide: learn/guide.md

requirements.txt

@@ -1,5 +1,6 @@
-mkdocs==1.4.0
-mkdocs-material>=8.1.4
-mkdocs-static-i18n>=0.30
-mkdocs-simple-hooks>=0.1.3
-mkdocs-redirects>=1.2.1
+Markdown==3.3.7
+mkdocs==1.5.3
+mkdocs-material==9.4.4
+mkdocs-static-i18n==1.1.0
+mkdocs-simple-hooks>=0.1.5
+mkdocs-redirects==1.2.1