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

Migration to Astro #220

Merged
merged 8 commits into from
Jan 8, 2025

Conversation

JBBianchi
Copy link
Member

@JBBianchi JBBianchi commented Jan 7, 2025

Many thanks for submitting your Pull Request ❤️!

What this PR does / why we need it:
This PR migrate the website building technologies from Hugo/Docsy to Astro.

It adds a bit of complexity in the templating but we have full control over the output.

Special notes for reviewers:
Astro comes with an additional layer specifically designed for documentation, similar to how Docsy works for Hugo: Starlight.

At first glance, it offers a simpler and more user-friendly template for creating documentation, but at the cost of abstracting certain aspects (like routing, content configuration, etc.). If we decide to create documentation in the future, we have a few options: we can use the vanilla version, which would require implementing some features ourselves (such as "previous/next" buttons at the bottom of the page or a Table of Contents); we can deploy a separate website using Starlight; or we could port the current version to Starlight, which might involve some challenges with its preconfigured routing and other built-in settings.

Additional information (if needed):

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>
Copy link
Member

@cdavernas cdavernas left a comment

Choose a reason for hiding this comment

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

Looks great to me! Thanks man! ❤️

Copy link
Member

@ricardozanini ricardozanini left a comment

Choose a reason for hiding this comment

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

Looks solid! Two Qs though:

@JBBianchi
Copy link
Member Author

JBBianchi commented Jan 7, 2025

Why removing .github files?

I didn't mean to, I'll readd them, good catch.

Is this how the new website looks like? https://deploy-preview-220--serverlessworkflow.netlify.app/ Or maybe it's mixing the old files? 🤔

Kind of but it seems broken ATM (missing padding, bad alignments and so on), I must admit I open this PR in a rush because I was late for something else. I'll fix this tomorrow.

I think these spaces might break the config file.

I looks like it was deployed properly but I'll remove them too.

@JBBianchi JBBianchi changed the title Migrated website to Astro [WIP]Migration to Astro Jan 7, 2025
@JBBianchi JBBianchi marked this pull request as draft January 7, 2025 19:21
- readded .github folder
- changed netlify.toml indentation
- fixed usage of dynamic Tailwind class not being present in the css output

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>
@JBBianchi JBBianchi marked this pull request as ready for review January 7, 2025 20:19
@JBBianchi JBBianchi changed the title [WIP]Migration to Astro Migration to Astro Jan 7, 2025
Signed-off-by: Jean-Baptiste Bianchi <[email protected]>
Signed-off-by: Jean-Baptiste Bianchi <[email protected]>
Signed-off-by: Jean-Baptiste Bianchi <[email protected]>
@cdavernas
Copy link
Member

@JBBianchi would it be possible to add the logo left to the headers title, too? What fo you guys think?

- added SW logo in the header
- renamed favicons folder to icons and fixed manifest/browserconfig
- added svg logo

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>
@ricardozanini
Copy link
Member

Hey now it looks fantastic! Great work, @JBBianchi

Just one nitpick, the logo seems not vertically aligned with the title:
Screenshot 2025-01-08 at 9 16 57 AM

- Added a "star our GitHub Repo" CTA above the footer
- Links and buttons are now "accent"
- Other minor style changes

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>
@JBBianchi
Copy link
Member Author

Hey now it looks fantastic! Great work, @JBBianchi

Just one nitpick, the logo seems not vertically aligned with the title: Screenshot 2025-01-08 at 9 16 57 AM

It should be better now. I also added a call to action above the footer for people to give a star and other little changes.

Copy link
Member

@ricardozanini ricardozanini left a comment

Choose a reason for hiding this comment

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

I might have to change RHT logo: https://www.redhat.com/en/about/brand/standards/logo

I can do it in a follow-up PR.

Thanks again, JB! This work looks awesome. Way better than what I did! hahaha

@JBBianchi
Copy link
Member Author

I might have to change RHT logo: https://www.redhat.com/en/about/brand/standards/logo

I can do it in a follow-up PR.

Thanks again, JB! This work looks awesome. Way better than what I did! hahaha

I can do it, no worries.

You already did a great job, I'm just building on top ;)

Signed-off-by: Jean-Baptiste Bianchi <[email protected]>
@ricardozanini
Copy link
Member

Oh that's so nice what you did!

redhat_logo

@cdavernas
Copy link
Member

@JBBianchi @ricardozanini let's merge?

@ricardozanini ricardozanini merged commit 86a7501 into serverlessworkflow:main Jan 8, 2025
5 checks passed
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