Skip to content

Conversation

NataliaIvakina
Copy link
Contributor

No description provided.

@recrwplay
Copy link
Contributor

recrwplay commented Mar 13, 2025

I think this should apply to links to the Cypher manual, but I don't know if links to the Operations manual or HTTP API should be updated.

I'm thinking of the case where LTS docs are published. Would a user reading LTS docs want a link to go to the same LTS version in those other manuals, rather than current?

@NataliaIvakina
Copy link
Contributor Author

I think this should apply to links to the Cypher manual, but I don't know if links to the Operations manual or HTTP API should be updated.

You might be right. Most of the links to the Ops manual work. But I found the broken link to the Procedures page and decided it's broken because of using the page-version attribute. Probably it is broken because of the non-working redirect. We have the redirect for the Procedures page for sure. But how do redirects work with all this new versioning stuff?

The link to the HTTP API docs does not work now.

I'm thinking of the case where LTS docs are published. Would a user reading LTS docs want a link to go to the same LTS version in those other manuals, rather than current?

Yeah, I was asking myself same questions when in the Operations manual we updated links to the Cypher manual. I'm not sure but in future we may need to update all current links to the specific LTS version.

@recrwplay
Copy link
Contributor

I think the issue with the link to the HTTP API docs is that the target page existed in 4.4 but not from version 5 onwards. If the content was moved to another URL then there should be a redirect in place to that new URL. If the content was removed because the feature is no longer available then a redirect to the best alternative could be used. At the moment it looks like https://neo4j.com/docs/http-api/5/actions/ redirects to https://neo4j.com/docs/http-api/current/ which might not be perfect, but at least there's no 404.

What I think this means is that this link to the HTTP API docs makes no sense after 4.4 - it's a link to something that doesn't exist - so it should be removed.

@NataliaIvakina
Copy link
Contributor Author

I think the issue with the link to the HTTP API docs is that the target page existed in 4.4 but not from version 5 onwards. If the content was moved to another URL then there should be a redirect in place to that new URL. If the content was removed because the feature is no longer available then a redirect to the best alternative could be used. At the moment it looks like https://neo4j.com/docs/http-api/5/actions/ redirects to https://neo4j.com/docs/http-api/current/ which might not be perfect, but at least there's no 404.

What I think this means is that this link to the HTTP API docs makes no sense after 4.4 - it's a link to something that doesn't exist - so it should be removed.

Sounds reasonable. @recrwplay, thank you for investigating. 🙂

@renetapopova
Copy link
Collaborator

renetapopova commented Mar 19, 2025

I think the issue with the link to the HTTP API docs is that the target page existed in 4.4 but not from version 5 onwards. If the content was moved to another URL then there should be a redirect in place to that new URL. If the content was removed because the feature is no longer available, then a redirect to the best alternative could be used. At the moment, it looks like https://neo4j.com/docs/http-api/5/actions/ redirects to https://neo4j.com/docs/http-api/current/ which might not be perfect, but at least there's no 404.
What I think this means is that this link to the HTTP API docs makes no sense after 4.4 - it's a link to something that doesn't exist - so it should be removed.

Sounds reasonable. @recrwplay, thank you for investigating. 🙂

I quickly looked at the HTTP API docs, and all the pages of the Cypher transaction API in 4.4 are labeled with Deprecated in 5.26, but they have no alternative pages in 5.x. So, this redirect "https://neo4j.com/docs/http-api/5/actions/` redirects to https://neo4j.com/docs/http-api/current/" looks to me as some kind of a quick fix, when actually we are missing page aliases. The same applies to the Introduction, Discovery API, and Authentication and authorization pages.

Copy link
Collaborator

@renetapopova renetapopova 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 to me. Thanks, @NataliaIvakina!

@neo-technology-commit-status-publisher
Copy link
Collaborator

neo-technology-commit-status-publisher commented Mar 20, 2025

Thanks for the documentation updates.

The preview documentation has now been torn down - reopening this PR will republish it.

@NataliaIvakina NataliaIvakina merged commit aac58bb into neo4j:dev Mar 20, 2025
4 checks passed
@NataliaIvakina NataliaIvakina deleted the dev-fix-links branch March 20, 2025 14:29
NataliaIvakina added a commit to NataliaIvakina/docs-java-reference that referenced this pull request Mar 20, 2025
* Replace `page-version` with `current` in links

* Put back `page-version` for the Ops manual and fix links on locks/deadlocks

* Update modules/ROOT/pages/java-embedded/unique-nodes.adoc

* Update modules/ROOT/pages/extending-neo4j/unmanaged-extensions.adoc
NataliaIvakina added a commit that referenced this pull request Mar 20, 2025
* Replace `page-version` with `current` in links

* Put back `page-version` for the Ops manual and fix links on locks/deadlocks

* Update modules/ROOT/pages/java-embedded/unique-nodes.adoc

* Update modules/ROOT/pages/extending-neo4j/unmanaged-extensions.adoc
NataliaIvakina added a commit that referenced this pull request Mar 28, 2025
* bump version to 2025.02 (#248)

* Bump @neo4j-antora/antora-modify-sitemaps in the prod-dependencies group (#249)

Bumps the prod-dependencies group with 1 update: @neo4j-antora/antora-modify-sitemaps.


Updates `@neo4j-antora/antora-modify-sitemaps` from 0.6.1 to 0.7.0

---
updated-dependencies:
- dependency-name: "@neo4j-antora/antora-modify-sitemaps"
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: prod-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update dev version to 2025.03 (#252)

* Update version in antora.yml to 2025.03 (#254)

* Update Java driver version to 5.28.3 (#258)

* Packages workflows refine (#261)

* update workflow to 1.2.0

* update packages

* Replace `page-version` with `current` in links (#260)

* Replace `page-version` with `current` in links

* Put back `page-version` for the Ops manual and fix links on locks/deadlocks

* Update modules/ROOT/pages/java-embedded/unique-nodes.adoc

* Update modules/ROOT/pages/extending-neo4j/unmanaged-extensions.adoc

* Update docs-pr-checks.yml (#263)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Reneta Popova <reneta.popova@neo4j.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Neil Dewhurst <neil.dewhurst@neo4j.com>
renetapopova added a commit that referenced this pull request Apr 30, 2025
* bump version to 2025.02 (#248)

* Bump @neo4j-antora/antora-modify-sitemaps in the prod-dependencies group (#249)

Bumps the prod-dependencies group with 1 update: @neo4j-antora/antora-modify-sitemaps.


Updates `@neo4j-antora/antora-modify-sitemaps` from 0.6.1 to 0.7.0

---
updated-dependencies:
- dependency-name: "@neo4j-antora/antora-modify-sitemaps"
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: prod-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update dev version to 2025.03 (#252)

* Update version in antora.yml to 2025.03 (#254)

* Update Java driver version to 5.28.3 (#258)

* Packages workflows refine (#261)

* update workflow to 1.2.0

* update packages

* Replace `page-version` with `current` in links (#260)

* Replace `page-version` with `current` in links

* Put back `page-version` for the Ops manual and fix links on locks/deadlocks

* Update modules/ROOT/pages/java-embedded/unique-nodes.adoc

* Update modules/ROOT/pages/extending-neo4j/unmanaged-extensions.adoc

* Update docs-pr-checks.yml (#263)

* Update the version to 2025.04 (#268)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Neil Dewhurst <neil.dewhurst@neo4j.com>
Co-authored-by: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com>
renetapopova added a commit that referenced this pull request Jun 3, 2025
* bump version to 2025.02 (#248)

* Bump @neo4j-antora/antora-modify-sitemaps in the prod-dependencies group (#249)

Bumps the prod-dependencies group with 1 update: @neo4j-antora/antora-modify-sitemaps.


Updates `@neo4j-antora/antora-modify-sitemaps` from 0.6.1 to 0.7.0

---
updated-dependencies:
- dependency-name: "@neo4j-antora/antora-modify-sitemaps"
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: prod-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update dev version to 2025.03 (#252)

* Update version in antora.yml to 2025.03 (#254)

* Update Java driver version to 5.28.3 (#258)

* Packages workflows refine (#261)

* update workflow to 1.2.0

* update packages

* Replace `page-version` with `current` in links (#260)

* Replace `page-version` with `current` in links

* Put back `page-version` for the Ops manual and fix links on locks/deadlocks

* Update modules/ROOT/pages/java-embedded/unique-nodes.adoc

* Update modules/ROOT/pages/extending-neo4j/unmanaged-extensions.adoc

* Update docs-pr-checks.yml (#263)

* Update the version to 2025.04 (#268)

* Update version to 2025.05 (#271)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Neil Dewhurst <neil.dewhurst@neo4j.com>
Co-authored-by: NataliaIvakina <82437520+NataliaIvakina@users.noreply.github.com>
NataliaIvakina added a commit that referenced this pull request Jul 2, 2025
* bump version to 2025.02 (#248)

* Bump @neo4j-antora/antora-modify-sitemaps in the prod-dependencies group (#249)

Bumps the prod-dependencies group with 1 update: @neo4j-antora/antora-modify-sitemaps.


Updates `@neo4j-antora/antora-modify-sitemaps` from 0.6.1 to 0.7.0

---
updated-dependencies:
- dependency-name: "@neo4j-antora/antora-modify-sitemaps"
  dependency-type: direct:production
  update-type: version-update:semver-minor
  dependency-group: prod-dependencies
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

* Update dev version to 2025.03 (#252)

* Update version in antora.yml to 2025.03 (#254)

* Update Java driver version to 5.28.3 (#258)

* Packages workflows refine (#261)

* update workflow to 1.2.0

* update packages

* Replace `page-version` with `current` in links (#260)

* Replace `page-version` with `current` in links

* Put back `page-version` for the Ops manual and fix links on locks/deadlocks

* Update modules/ROOT/pages/java-embedded/unique-nodes.adoc

* Update modules/ROOT/pages/extending-neo4j/unmanaged-extensions.adoc

* Update docs-pr-checks.yml (#263)

* Update the version to 2025.04 (#268)

* Update version to 2025.05 (#271)

* Update version to 2025.06 (#277)

* Update Java driver version to 5.28.5 (#280)

* Update and fix several pages (#279)

* Update and fix several pages

* Change ClusterSettings to DiscoverySettings

* Update Java driver to 5.28.6 (#283)

---------

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: Reneta Popova <reneta.popova@neo4j.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Neil Dewhurst <neil.dewhurst@neo4j.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants