Use external markdown for the spec reference #66
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
richfab
changed the title
|
LGTM ! |
fredericsimard
approved these changes
Nov 15, 2023
richfab
added a commit
that referenced
this pull request
Nov 16, 2023
commit 6a49f60 Author: Fabien Richard-Allouard <[email protected]> Date: Thu Nov 16 11:19:08 2023 -0500 Adds roadmap page with Productboard portal embeded (#61) * Adds roadmap page with Productboard portal embeded * Removes Draft from v3.0-RC2 * Revert "Removes Draft from v3.0-RC2" This reverts commit d096251. * Replace portal * Add back the page header commit 2e033f9 Author: Fabien Richard-Allouard <[email protected]> Date: Wed Nov 15 17:06:04 2023 -0500 Use external markdown for the spec reference (#66) * Add mkdocs-embed-external-markdown plugin * Replace reference.md by the external file gbfs.md * Remove workflow create issue when gbfs.md changes commit d756b22 Author: Fabien Richard-Allouard <[email protected]> Date: Tue Nov 14 13:16:24 2023 -0500 Update extension tracker URL from wiki to gbfs.org (#60) * Adds Airtable for extensions * Update extension tracker URL from wiki to gbfs.org commit 1b84777 Author: Fabien Richard-Allouard <[email protected]> Date: Tue Nov 14 12:28:55 2023 -0500 Removes Draft from v3.0-RC2 (#64)
richfab
added a commit
that referenced
this pull request
Nov 16, 2023
* Adds roadmap page with Productboard portal embeded * Removes Draft from v3.0-RC2 * Revert "Removes Draft from v3.0-RC2" This reverts commit d096251. * Replace portal * Add back the page header * Squashed commit of the following: commit 6a49f60 Author: Fabien Richard-Allouard <[email protected]> Date: Thu Nov 16 11:19:08 2023 -0500 Adds roadmap page with Productboard portal embeded (#61) * Adds roadmap page with Productboard portal embeded * Removes Draft from v3.0-RC2 * Revert "Removes Draft from v3.0-RC2" This reverts commit d096251. * Replace portal * Add back the page header commit 2e033f9 Author: Fabien Richard-Allouard <[email protected]> Date: Wed Nov 15 17:06:04 2023 -0500 Use external markdown for the spec reference (#66) * Add mkdocs-embed-external-markdown plugin * Replace reference.md by the external file gbfs.md * Remove workflow create issue when gbfs.md changes commit d756b22 Author: Fabien Richard-Allouard <[email protected]> Date: Tue Nov 14 13:16:24 2023 -0500 Update extension tracker URL from wiki to gbfs.org (#60) * Adds Airtable for extensions * Update extension tracker URL from wiki to gbfs.org commit 1b84777 Author: Fabien Richard-Allouard <[email protected]> Date: Tue Nov 14 12:28:55 2023 -0500 Removes Draft from v3.0-RC2 (#64) * Move roadmap to participate.md page
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem
Every time we make a change to the spec in the gbfs.md file, we also need to update the reference on gbfs.org to reflect the change. This is a manual task that takes time and that is prone to human error.
Solution
This PR proposes to use the plugin mkdocs-embed-external-markdown to replace the static page by a dynamic import of the content from gbfs.md from the gbfs repository.
With this solution, every time a change is made in the gbfs.md file, it is automatically reflected on gbfs.org (no action needed).