Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use external markdown for the governance #71

Merged
merged 1 commit into from
Nov 20, 2023

Conversation

richfab
Copy link
Contributor

@richfab richfab commented Nov 17, 2023

Similar to #66

Problem

Every time we make a change to the governance in the gbfs.md file, we also need to update the governance 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 governance.md from the gbfs repository.

With this solution, every time a change is made in the governance.md file, it is automatically reflected on gbfs.org (no action needed).

Before After
image Screenshot 2023-11-17 at 12 45 24

Copy link
Member

@davidgamez davidgamez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💪

@richfab richfab merged commit d5ee6d7 into master Nov 20, 2023
2 checks passed
@richfab richfab deleted the feat/external-markdown-governance branch November 20, 2023 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants