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

fastify docs #233

Merged
merged 2 commits into from
Aug 20, 2024
Merged

fastify docs #233

merged 2 commits into from
Aug 20, 2024

Conversation

Tudor-Ang
Copy link
Member

No description provided.

Copy link

👋 Your preview is ready! https://genezio-landing-page-pr-fe83aa71.app.genez.io/docs/

Copy link
Member

@andreia-oca andreia-oca left a comment

Choose a reason for hiding this comment

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

Looks good!

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';

# Fastify.js
Copy link
Member

Choose a reason for hiding this comment

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

From their landing page[1] it doesn't seem that Fastify has the suffix .js .

I would remove .js or js terminations from this page to align with their branding.

https://fastify.dev/


# Deployment

Learn how to deploy an existing Fastify.js app using Genezio, a serverless deployment platform that simplifies app management and reduces costs
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Learn how to deploy an existing Fastify.js app using Genezio, a serverless deployment platform that simplifies app management and reduces costs
Learn how to deploy an existing Fastify.js app using Genezio, a serverless deployment platform that simplifies app management and reduces costs.

<details>
<summary>**Create a Hello World Fastify.js App**</summary>

### 1. Initialize a New Node.js Project
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
### 1. Initialize a New Node.js Project
<h3> 1. Initialize a New Node.js Project </h3>

Copy link
Member

Choose a reason for hiding this comment

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

This looks a bit weird in the table of contents on the right side because docusaurus doesn't detect that this is an expandable section.

To fix this we should hide this headers from the ToC.

I researched a bit and we can do that by changing the markdown headers (###) to html header tags.

Please to this change for all the headers in the expandable section.

image

Comment on lines 299 to 300
# The compatibility of the function handler.
type: aws
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
# The compatibility of the function handler.
type: aws

This field is not required and it might confuse the user. You can remove it.

```

:::info
You need to deploy your environment variables single time.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
You need to deploy your environment variables single time.
You need to deploy your environment variables only once.


### Do I Need to Modify My Fastify App Code?

Your fastify code will only require the above [adjustments](#deployment-guide), as long as it is written in a **stateless** manner. [Read more](https://stackoverflow.com/questions/5329618/stateless-vs-stateful)
Copy link
Member

@andreia-oca andreia-oca Aug 20, 2024

Choose a reason for hiding this comment

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

Suggested change
Your fastify code will only require the above [adjustments](#deployment-guide), as long as it is written in a **stateless** manner. [Read more](https://stackoverflow.com/questions/5329618/stateless-vs-stateful)
Your Fastify project will only require the above [adjustments](#deployment-guide), as long as it is written in a **stateless** manner. To find out more about [stateless vs. stateful follow this link](https://stackoverflow.com/questions/5329618/stateless-vs-stateful).

sidebars.js Outdated
@@ -29,6 +29,7 @@ const sidebars = {
"frameworks/expressjs",
"frameworks/react-admin",
"frameworks/refine",
"frameworks/fastifyjs",
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
"frameworks/fastifyjs",
"frameworks/fastify",

Copy link
Member

Choose a reason for hiding this comment

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

This should also be just fastify without js.


Fastify.js is a popular Node.js web application framework that simplifies the development of server-side applications. It provides a robust set of features for building web servers and APIs.

<!-- TODO: change to fastify template -->
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<!-- TODO: change to fastify template -->

Copy link

👋 Your preview is ready! https://genezio-landing-page-pr-fe83aa71.app.genez.io/docs/

@Tudor-Ang Tudor-Ang merged commit 76465c5 into dev Aug 20, 2024
1 check 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.

2 participants