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

SPIKE: Replace documentation framework with Astro #4232

Open
dlabaj opened this issue Aug 29, 2024 · 0 comments
Open

SPIKE: Replace documentation framework with Astro #4232

dlabaj opened this issue Aug 29, 2024 · 0 comments
Assignees
Labels
Milestone

Comments

@dlabaj
Copy link
Contributor

dlabaj commented Aug 29, 2024

Describe the enhancement

Currently the Pattern Fly team has to maintain it's own home grown framework to generate the patternfly documentation website. While this has serviced use well maintaining this comes with the caveat that the team needs to dedicated resources to update the framework. In 2022 Astro was introduced which is a highly extensible content delivery framework that uses the MD and MDX format. Looking at the current structure of our website, and how Astro works this would be a viable alternative to maintaining our own framework. I recommend doing a PoC / Spike to show the feasibility of this and determine if we would like to go ahead and migrate over to this framework.

Proposal: https://docs.google.com/document/d/1JXQGX2Ssis8WHI1pEaUeMbQ1nCUaZITIdapkOUmqBOQ/edit

CC: @nicolethoen @evwilkin @wise-king-sullyman @kmcfaul

@dlabaj dlabaj added the Spike label Aug 29, 2024
@dlabaj dlabaj added this to the 2024.Q4 milestone Aug 29, 2024
@github-project-automation github-project-automation bot moved this to Needs triage in PatternFly Issues Aug 29, 2024
@dlabaj dlabaj added the Post v6 label Sep 20, 2024
@dlabaj dlabaj self-assigned this Sep 26, 2024
@dlabaj dlabaj changed the title Replace documentation framework with Astro SPIKE: Replace documentation framework with Astro Sep 26, 2024
@dlabaj dlabaj moved this from Needs triage to In Progress in PatternFly Issues Sep 26, 2024
@kmcfaul kmcfaul removed the Post v6 label Oct 25, 2024
@dlabaj dlabaj moved this from In Progress to Parking lot in PatternFly Issues Nov 5, 2024
@dlabaj dlabaj moved this from Parking lot to Ready to assign in PatternFly Issues Nov 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: No status
Status: Ready to assign
Development

No branches or pull requests

2 participants