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

Add release roadmap and news to introduce the page #363

Open
wants to merge 1 commit into
base: website
Choose a base branch
from

Conversation

acolombier
Copy link
Member

@acolombier acolombier commented Sep 21, 2024

Note that the CSS still needs to be cleaned up from some of the weird class name.

@JoergAtGithub
Copy link
Member

This looks nice, but I think we shouldn't publish future release dates, as our development model is not calendar based.
Can we add a text there like "60days after 2.5.0" or "minimum 90 days" instead of the artificial absolute dates?

@@ -2,3 +2,4 @@
/output
# python bytecode cache
__pycache__
.venv/
Copy link
Member

Choose a reason for hiding this comment

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

I think this rather belongs into your personal gitignore. There is no established convention on how call the venv directory (I just call it plain venv and have that in my gitignore).

{% block extra_head %}
<link rel="stylesheet" href="{{ SITEURL }}/theme/css/pages/release_roadmap.css">

<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/mermaid.min.js" integrity="sha384-7J/UM6Vde6cXqst3EI86P36213Jz5rooW1EEUvweQ3F3gQOHkTuSKAX67ANmYljn" crossorigin="anonymous"></script>
Copy link
Member

Choose a reason for hiding this comment

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

not a fan of having rendering the static content client side all the time. I'd be nice if there was a pelican plugin that rendered this inline at build time... Wrapping https://github.com/ouhammmourachid/mermaid-py may be feasible. We already have other plugins (such as the privacy-friendly youtube embed) that could be used as an example.

Copy link
Member Author

Choose a reason for hiding this comment

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

Unfortunatelly, this Python plugin doesn't support Timeline and Gitgraph. However, I agree it is definitely sub-optimal to address that on client side. One solution could be to use the (Node-based) mermaid-cli which allows you to generate SVG out of the diagram, so this could be added in a Makefile for example and/or the CI. WDYT?

Copy link
Member

Choose a reason for hiding this comment

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

yeah neither are great. I'd almost prefer the current client side solution then I guess.

@acolombier
Copy link
Member Author

This looks nice, but I think we shouldn't publish future release dates, as our development model is not calendar based.

The reason for me putting this document together is precisely because I am lost with these relative dates. My initial aim was to build a document that would help me to manage my time and efforts on various feature. This doesn't mean I want to create a surge of feature to review just before the release, but rather organise which one should be addresses together as they are closely linked (e.g STEM PRs and S4 Mk3 screens should ideally go together). We already have the milestone to group them, but there is no indication on calendar for that matter.

Note this is why I have added that large warning box to inform that these dates are only here as an indication. I guess to make it clearer, I could remove the day in it as this clearly is irrelevant (just year/month)

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.

3 participants