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

EOL v3.6 #718

Merged
merged 2 commits into from
Jul 24, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 13 additions & 2 deletions snooty.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
eol = true
name = "node"
title = "Node.js"
intersphinx = ["https://mongodb.com/docs/manual/objects.inv",
"https://mongodb.com/docs/drivers/objects.inv"]
intersphinx = [
"https://mongodb.com/docs/manual/objects.inv",
"https://mongodb.com/docs/drivers/objects.inv",
]

toc_landing_pages = [
"/fundamentals/authentication",
Expand All @@ -23,3 +26,11 @@ driver = "node"
driver-long = "MongoDB Node.js driver"
driver-short = "Node.js driver"
mdb-server = "MongoDB Server"
current-url-base = "https://www.mongodb.com/docs/drivers/node/current"

[[banners]]
targets = ["*"]
variant = "info"
value = """\
This version of the documentation is archived and no longer supported. View the `current documentation <{+current-url-base+}>`__ to learn how to `upgrade your version of the {+driver-long+} <{+current-url-base+}/upgrade/>`__.\
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
This version of the documentation is archived and no longer supported. View the `current documentation <{+current-url-base+}>`__ to learn how to `upgrade your version of the {+driver-long+} <{+current-url-base+}/upgrade/>`__.\
This version of the documentation is archived and no longer supported. View the `documentation for the current driver version <{+current-url-base+}>`__ to learn how to `upgrade your version of the {+driver-long+} <{+current-url-base+}/upgrade/>`__.\

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The verbiage here is provided in the Wiki (under step 2) and I think is supposed to be standard for all pages that will have this banner, so I'm not sure if we should change it.

"""
Comment on lines +34 to +36
Copy link
Collaborator

Choose a reason for hiding this comment

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

Q: the upgrade guide doesn't tell users how to upgrade to new driver versions, it is a guide on breaking changes. Could you instead link to here/some other content to show users how to install newer versions?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I think if they're upgrading from one of these older versions it's important for them to see the breaking changes first. Especially since we have the "Before you upgrade..." part in the top section.

That being said I do agree that it's a little confusing that a page called Upgrade Driver Versions doesn't actually tell how to perform the upgrade. Maybe we should add a section on that page stating (or linking to somewhere that states) how to actually install the new version.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Could you create a ticket to add this section to the upgrade page?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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