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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

website: Tabula rasa #16

Merged
merged 7 commits into from
Dec 21, 2022
Merged

website: Tabula rasa #16

merged 7 commits into from
Dec 21, 2022

Conversation

Eomm
Copy link
Member

@Eomm Eomm commented Dec 11, 2022

Since the new site project has been stuck for 1 year, I'm volunteering to take ownership to complete it.

I tried to do some cherry-picking to keep the good work made by @lachlancollins and @Xhale1, but it is too much effort. So I hope they will get the chance to submit a new commit 馃槅

What does "complete" mean? - Required features

The website MVP will be considered completed when:

  • the website shows these pages:
    • the index page (project and team forward)
    • the ecosystem page
    • the benchmarks page
    • the contribute page
  • the docs pages show:
    • the fastify v1 docs (only the latest version): no embellishment here
    • the fastify v2 docs (only the latest version): no embellishment here
    • the fastify v3 docs (only the latest version): no embellishment here
    • the fastify v4.x docs:
      • every semver minor version has its own docs/ page
      • upgrade the docs to be more readable
  • the user can search through the docs
  • SEO optimized
  • Handle old website links

Nice to have

These features are not going to be done - but we will try to implement the required features keeping in mind the following list:

What are the new website constraints?

The constraints are:

  1. we must ship fastify with the latest docs
  2. we must deal with the old links (eg: redirect)
  3. a fastify contributor must update the docs on the main repo fastify/fastify
  4. we can't include any doc changes to fastify <=3

What do I mean by "ownership"?

I think this project has been starving because the decisions and feedback cycle were slow and we brought many more doubts than solutions.

So I'm asking to @fastify/collaborators, is to define constraints and required features
now. Then the people willing to work on this project will be able to work efficiently till things are done.

Using or not docusaurus can't be a constraint. I think I can guarantee that the new website team will not deliver some unmaintainable website and if the team has chosen docusaurus, I can say that, after using it a bit, it is very usable and well documented. (I tried ELEVENTY and I did not enjoy it). Let me be pragmatic: in any case, whatever tech would be better than the actual metalsmith aged solution.

I hope @lachlancollins and @Xhale1 are willing to work on this project revamp too.

What does this PR?

This PR is useful for me: I learnt docusaurus and I understood its mechanics.
This PR bump all the deps to the non-beta ones and set up the configuration in the most stable and complete way.

Copy link
Member

@mcollina mcollina left a comment

Choose a reason for hiding this comment

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

lgtm

@Eomm Eomm mentioned this pull request Dec 21, 2022
4 tasks
@Eomm
Copy link
Member Author

Eomm commented Dec 21, 2022

Here all the info to help with the project: #32

@Eomm Eomm merged commit 4e3f356 into main Dec 21, 2022
@Eomm Eomm deleted the tabula-rasa branch January 18, 2023 16:20
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.

None yet

2 participants