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

Add description to each page (#1639) #1672

Merged
merged 3 commits into from
Nov 3, 2024

Conversation

rehmansheikh222
Copy link
Contributor

Added concise descriptions to each page in the en folder.

Copy link

netlify bot commented Oct 28, 2024

Deploy Preview for expressjscom-preview ready!

Name Link
🔨 Latest commit 9a17a36
🔍 Latest deploy log https://app.netlify.com/sites/expressjscom-preview/deploys/672333f418287700086ffc7c
😎 Deploy Preview https://deploy-preview-1672--expressjscom-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@bjohansebas bjohansebas requested a review from a team October 28, 2024 20:30
@@ -1,5 +1,6 @@
---
title: Welcome to The Express Blog!
title: Welcome to The Express Blog!
description: Introducing the new Express blog—a primary platform for announcements, updates, and communication from the Express technical committee.
Copy link
Contributor

Choose a reason for hiding this comment

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

Introducing the new Express blog — a primary platform for announcements, updates, and communication from the Express technical committee.

en/3x/api.md Outdated
@@ -1,6 +1,7 @@
---
layout: 3x-api
title: Express 3.x - API Reference
description: Access the API reference for Express.js version 3.x, noting that this version is end-of-life and no longer maintained; includes details on modules and methods.
Copy link
Contributor

Choose a reason for hiding this comment

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

maintained - includes details on mod

en/4x/api.md Outdated
@@ -1,6 +1,7 @@
---
layout: 4x-api
title: Express 4.x - API Reference
description: Access the comprehensive API reference for Express.js 4.x, detailing all modules, methods, and properties for building web applications with this version.
Copy link
Contributor

Choose a reason for hiding this comment

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

Access the API reference for Express.js 4.x, detailing all modules, methods, and properties for building web applications with this version.

en/5x/api.md Outdated
@@ -1,6 +1,7 @@
---
layout: 5x-api
title: Express 5.x - API Reference
description: Access the comprehensive API reference for Express.js 5.x, detailing all modules, methods, and properties for building web applications with this latest version.
Copy link
Contributor

Choose a reason for hiding this comment

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

Access the API reference for Express.js 5.x, detailing all modules, methods, and properties for building web applications with this latest version.

en/api.md Outdated
@@ -1,6 +1,7 @@
---
layout: 4x-api
title: Express 4.x - API Reference
description: Access the comprehensive API reference for Express.js 4.x, detailing all modules, methods, and properties for building web applications with this version.
Copy link
Contributor

Choose a reason for hiding this comment

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

Access the API reference for Express.js detailing all modules, methods, and properties for building web applications with this version.

@@ -1,6 +1,7 @@
---
layout: page
title: Express routing
description: Learn how to define and use routes in Express.js applications, including route methods, route paths, parameters, and using express.Router for modular routing.
Copy link
Contributor

Choose a reason for hiding this comment

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

Learn how to define and use routes in Express.js applications, including route methods, route paths, parameters, and using Router for modular routing.

@@ -1,6 +1,7 @@
---
layout: page
title: Serving static files in Express
description: Understand how to serve static files like images, CSS, and JavaScript in Express.js applications using the built-in express.static middleware.
Copy link
Contributor

Choose a reason for hiding this comment

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

Understand how to serve static files like images, CSS, and JavaScript in Express.js applications using the built-in 'static' middleware.

@carlosstenzel
Copy link
Contributor

We would have to add a description page in other languages, even if it is in English.

@carlosstenzel
Copy link
Contributor

before
Captura de Tela 2024-10-28 às 19 01 51

after
Captura de Tela 2024-10-28 às 19 10 30

@rehmansheikh222
Copy link
Contributor Author

We would have to add a description page in other languages, even if it is in English.

Hi @carlosstenzel , can you please elaborate what you mean by that? Does this mean adding description tag (like I did in the en folder) in all other language folders? @bjohansebas , please let me know your thoughts

@rehmansheikh222
Copy link
Contributor Author

before Captura de Tela 2024-10-28 às 19 01 51

after Captura de Tela 2024-10-28 às 19 10 30

Hi @carlosstenzel , do you want me to remove description tag from /en/blog/posts.md file?

@chrisdel101
Copy link
Contributor

@carlosstenzel For the blog posts, the description was in the original page design but was removed before it was released.
It was originally removed since it did not look good in the posts themselves, so I don't think we'd want to add it to the markup.
Is this only for use in outside sites? That would seem okay, like for SEO, etc?

@carlosstenzel
Copy link
Contributor

I looked at the metadata, and I didn't find the description
Captura de Tela 2024-10-29 às 19 27 01

but when searching on google. I was confused.
Captura de Tela 2024-10-29 às 19 28 11

** the description tag would be for better SEO

@carlosstenzel
Copy link
Contributor

before Captura de Tela 2024-10-28 às 19 01 51
after Captura de Tela 2024-10-28 às 19 10 30

Hi @carlosstenzel , do you want me to remove description tag from /en/blog/posts.md file?

I added the images just for viewing and analysis by others. tks

@bjohansebas
Copy link
Member

We would have to add a description page in other languages, even if it is in English.

Hi @carlosstenzel , can you please elaborate what you mean by that? Does this mean adding description tag (like I did in the en folder) in all other language folders? @bjohansebas , please let me know your thoughts

@rehmansheikh222 please do it, exactly as you said—doing the same in the other folders

@rehmansheikh222
Copy link
Contributor Author

We would have to add a description page in other languages, even if it is in English.

Hi @carlosstenzel , can you please elaborate what you mean by that? Does this mean adding description tag (like I did in the en folder) in all other language folders? @bjohansebas , please let me know your thoughts

@rehmansheikh222 please do it, exactly as you said—doing the same in the other folders

Hi @bjohansebas , just one last thing, does the description need to be in english (for other languages folder)?

@bjohansebas
Copy link
Member

@rehmansheikh222 Yes, in English

@rehmansheikh222
Copy link
Contributor Author

@rehmansheikh222 Yes, in English

@carlosstenzel please check and let me know if there is anything else you would like me to change/add

@carlosstenzel
Copy link
Contributor

@rehmansheikh222 Yes, in English

@carlosstenzel please check and let me know if there is anything else you would like me to change/add

I don't think it's ok ;)

@rehmansheikh222
Copy link
Contributor Author

@rehmansheikh222 Yes, in English

@carlosstenzel please check and let me know if there is anything else you would like me to change/add

I don't think it's ok ;)

Can you please elaborate?

@carlosstenzel
Copy link
Contributor

@rehmansheikh222 Yes, in English

@carlosstenzel please check and let me know if there is anything else you would like me to change/add

I don't think it's ok ;)

Can you please elaborate?

sorry

*** I think it's ok

@rehmansheikh222
Copy link
Contributor Author

@rehmansheikh222 Yes, in English

@carlosstenzel please check and let me know if there is anything else you would like me to change/add

I don't think it's ok ;)

Can you please elaborate?

sorry

*** I think it's ok

Oh, okay. So, do you think you can approve the PR now?

@rehmansheikh222
Copy link
Contributor Author

@rehmansheikh222 Yes, in English

@carlosstenzel please check and let me know if there is anything else you would like me to change/add

I don't think it's ok ;)

Can you please elaborate?

sorry
*** I think it's ok

Oh, okay. So, do you think you can approve the PR now?

@carlosstenzel it still says one review is required for the merging :)

@carlosstenzel
Copy link
Contributor

carlosstenzel commented Nov 2, 2024

@bjohansebas @crandmck @UlisesGascon could you help?

Copy link
Member

@bjohansebas bjohansebas left a comment

Choose a reason for hiding this comment

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

LGTM

@bjohansebas bjohansebas merged commit fc401a5 into expressjs:gh-pages Nov 3, 2024
7 of 8 checks passed
@bjohansebas
Copy link
Member

@rehmansheikh222 thanks

@rehmansheikh222 rehmansheikh222 deleted the pages-description branch November 3, 2024 15:54
@rehmansheikh222
Copy link
Contributor Author

@rehmansheikh222 thanks

I'm glad I could contribute in some way, this was my first issue for open source and I plan to contribute more. Thanks all of you guys, you were really helpful.

chrisdel101 pushed a commit to chrisdel101/expressjs.com that referenced this pull request Nov 3, 2024
* Add description to each page (expressjs#1639)

* fix: rersolved description issues and also added the descriptions in the es folder

* feat: added descriptions in all the languages
@bjohansebas
Copy link
Member

@rehmansheikh222 we have a documentation group, maybe you want to join and help us. see #1506

@rehmansheikh222
Copy link
Contributor Author

@rehmansheikh222 we have a documentation group, maybe you want to join and help us. see #1506

Yes sure, I will keep an eye on it. Thanks bro

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.

4 participants