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

Move version 2 to a subdomain #1556

Open
bjohansebas opened this issue Aug 2, 2024 · 4 comments
Open

Move version 2 to a subdomain #1556

bjohansebas opened this issue Aug 2, 2024 · 4 comments

Comments

@bjohansebas
Copy link
Member

Just like other documentation practices, keeping this version on a separate branch with a different subdomain would be beneficial for historical purposes and to avoid cluttering the main documentation that is subject to changes.

@UlisesGascon
Copy link
Member

I think that is a good idea! We can have a look in our infra and try to do the settings for this. What do you think @crandmck?

@crandmck
Copy link
Member

By separate sub-domain, do you mean that all the 5.x doc would be at something like v4.expressjs.com? This is an interesting approach, but differs from what we've been doing, where each version's API reference is maintained separately, e.g. https://expressjs.com/en/4x/api.html and https://expressjs.com/en/3x/api.html while the rest of the documentation is for the current version (4.x now, and once v5 is released, it would be 5.x).

...to avoid cluttering the main documentation that is subject to changes.

To be clear, changes are primarily in the latest/upcoming version (5.x). The older version(s) that are in bug-fix/maintenance mode typically doesn't require doc updates so the docs docs are basically "frozen" (except for stuff like correcting existing errors).

This idea is worth considering, since of course we need to maintain 4.x docs to help people maintain existing v4 apps. However, once 5.x is released, we don't want to encourage anyone to install or use v4 as a "new user" so we'd want to remove all the v4 "Getting started" material. If there's an argument for keeping it, I'd like to understand it.

All the info under the "Resources" menu is not version-specific, and duplicating it is not a good idea. Exception: I'm not sure about the Middleware. I assume most middleware will be usable by either v4 or v5, but perhaps there are special cases?

Most of the info under the "Advanced" menu is best practices (e.g. security and performance) which are not likely to differ much between v4 and v5. I'm not sure about Developing template engines -- it may need updates for v5, but I presume we don't want to encourage people to create new template engines for v4, so I suspect we should keep only a version for v5.

So, for the most part, the only v4 doc that should be maintained/duplicated is the API doc and everything under the "Guide" menu (modulo the migration guides). Since we already version the API docs, this proposal boils down to also versioning most of the "Guide" material. Does it make sense to have a subdomain just for that?

@bjohansebas
Copy link
Member Author

bjohansebas commented Aug 25, 2024

@crandmck My idea was that this change should be only for version 2, since it’s a version that follows its own style, structure, and content (guides, screencasts, and applications) on the website. Version 3 and later should remain as they are

@crandmck
Copy link
Member

Ah, sorry I misread the title somehow...

Honestly, I would prefer if we could just remove the v2 docs. It's so outdated, and doubtful that anyone is even using it still. When v5 is released, it will be 3 major versions behind. I don't think it's worth spending much time to maintain it, so I'd vote to remove it altogether. We should get consent from the @expressjs/express-tc , though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants