fastify/website

[HOW TO CONTRIBUTE] Project target and management

Eomm opened this issue · 12 comments

Eomm commented

Hi,
If you are reading this, you want to contribute to the new Fastify website: thank you!
This message explains all you need to know to join.

Useful links

Contribute

If you want to contribute to this project, you can:

  • write a comment on an open issue to be assigned to it
  • open an issue with your suggestions

How to contribute

This repository follows the Fastify organization CONTRIBUTING and GOVERNANCE statements.

As a reminder: before working on an issue, be sure that:

  • the issue is assigned to your account: wait for an admin reply
  • the issue is clear to you: for any question you can drop a comment

To submit valuable changes to the project, you need to fork this repository and submit your code through a Pull Request. Here the step-by-step guides:

Project target

The target of this project is to redo the Fastify website: https://www.fastify.io/
Migrating to a new tech stack and new processes let the Fastify community contribute more easily to the documentation to let the Fastify web framework grow even more.

This journey was started by @Xhale1 and @luisorbaiceta, and all the credits till commit 3341dd3 and the work to sponsor this new project goes to them.

Tech Stack

The new website will be implemented with Docusaurus. It means that this project includes these topics:

  • JSX
  • bash scripting
  • GitHub Action automation
  • markdown manipulation

I'm not an expert on these topics. I'm just a "documentation reader" and a "pragmatic problem solver", so do not expect a TODO-LIST during a PR review, but a collaborative discussion 🤝

Project Boundaries

We can't just delete the old website and create a new one 😄 We must abide by these constraints:

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

Nice to have

TRACKING PROJECT: https://github.com/orgs/fastify/projects/7

These features are not in the scope of this specific project - but we will try to implement the required features while keeping in mind the following list:

For sure, we are going to do them in a follow-up project at least 💯

PS: if the issue you are looking at has an empty description, it means that I'm still writing down the requirements, be patient and, meanwhile, fork the repository and start playing with it.. does it work in your local environment?

Tasks
Beta Give feedback
HassanBahati commented

thank you @Eomm for this project breakdown.

jonnydgreen commented

Thanks for the breakdown @Eomm , I'll take a look at some issues I can help out with

AugustinMauroy commented

Why do you thinks about an Contributing.md ?

Eomm commented

Go for it!

Xhale1 commented

It's amazing to see this repo get the attention it deserves! I'll try to help out where I can (to which, I'm sorry for not carrying it over the finish line the first time around).

  • ❤️1
mcollina commented

I would recommend we scrap i18n from the plan.

Eomm commented

@mcollina I think we are good to start the fastify.dev domain redirect to this project.

I would use this setting tho:

image

Docs: https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site

I would propose these steps:

  • make this website available at fastify.dev
  • rename the https://github.com/fastify/website repository to website-metalsmith
  • add a website-metalsmith disclaimer
  • archive the website-metalsmith repo
  • rename this repository to website
mcollina commented

I agree. I'm still trying to get access to fastify.dev. Sigh.

Eomm commented

fastify.dev is online

@luisorbaiceta could you finalize this PR: #97 ?

Then I will proceed by archiving the old website!

Eomm commented

Updated the first post #32 (comment) with the task list.

Eomm commented

Renamed the old repo to https://github.com/fastify/website-metalsmith
I will archive it whenever I will upgrade this repository to website

@mcollina could we switch the fastify.io domain?

mcollina commented

that was done