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.

Sign up for GitHub

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 aliases to 3.x #129

Closed
wants to merge 2 commits into from
Closed

Add aliases to 3.x #129

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fa89f3e
started with aliases for 3.x
rsill-neo4j Mar 18, 2024
b1e4776
added more aliases, perspective '5->3'
rsill-neo4j Mar 19, 2024
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
1 change: 1 addition & 0 deletions modules/ROOT/pages/authentication-and-authorization/configuration.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
= Configuration
:page-aliases: authentication-and-authorization/index.adoc
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think it's necessary to do this here? If you see the live website, this page already has options to the other versions https://neo4j.com/docs/graphql/3/authentication-and-authorization/configuration/

Copy link
Contributor Author

Choose a reason for hiding this comment

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

it's going to the deprecated "Auth" page instead of "Authentication and Authorization" (which is just the nav entry, the first actual page is "Configuration")

checked locally, adding the page-alias unfortunately doesn't get rid of the deprecated "Auth" alias (it's not explicitly stated in that file - how does it work then?)

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah yes, you are right about it taking to the deprecated Auth page... but then this was set in the aliases in version 5 already --> https://github.com/neo4j/docs-graphql/edit/5.x/modules/ROOT/pages/authentication-and-authorization/index.adoc

Copy link
Contributor

Choose a reason for hiding this comment

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

I might be missing some information here, but this page exists in all versions (3.x, 4.x. 5.x) so adding this alias has no effect on the version selector.

(This alias would also add a redirect from https://neo4j.com/docs/graphql/3/authentication-and-authorization/ to https://neo4j.com/docs/graphql/3/authentication-and-authorization/configuration/ but we discard the redirect files that Antora adds, and use our own redirects, so this also has no effect.)


== Instantiation

Expand Down
1 change: 1 addition & 0 deletions modules/ROOT/pages/directives.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[[directives]]
= Directives
:page-aliases: type-definitions/directives/index.adoc

== `@alias`

Expand Down
1 change: 1 addition & 0 deletions modules/ROOT/pages/getting-started.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[[getting-started]]
= Getting Started
:page-aliases: getting-started/index.adoc

This tutorial walks you through creating a new project with the Neo4j GraphQL Library.

Expand Down
1 change: 1 addition & 0 deletions modules/ROOT/pages/ogm/api-reference/index.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[[ogm-api-reference]]
= API Reference
:page-aliases: ogm/reference.adoc
Copy link
Contributor

Choose a reason for hiding this comment

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

This page is already linked, it has the three versions options in the dropdown menu

Copy link
Contributor Author

Choose a reason for hiding this comment

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

true, but it's the "aggregate" page at the bottom of the navigation in 3.x, instead of the first (which is this API reference).

Checked locally, there's no explicit page-alias for "aggregate" either, so adding the page-alias here won't change anything (again, why is that?)

Copy link
Contributor

Choose a reason for hiding this comment

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

It might be the same as the previous comment, that in 5.x this page is already an alias to another one... so that's why I think we should only work in the most recent branch and the older ones will catch up? Or they should, like we were discussing... otherwise it might create a conflict between branches


- xref::ogm/api-reference/ogm.adoc[`OGM`]
- xref::ogm/api-reference/model/index.adoc[`Model`]
Expand Down
1 change: 1 addition & 0 deletions modules/ROOT/pages/type-definitions/cypher.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
[[type-definitions-cypher]]
= `@cypher` directive
:page-aliases: type-definitions/directives/cypher.adoc

The `@cypher` directive binds a GraphQL field to the result(s) of a Cypher query.

Expand Down
2 changes: 2 additions & 0 deletions modules/ROOT/pages/type-definitions/types.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
[[type-definitions-types]]
= Types
:page-aliases: type-definitions/types/index.adoc, type-definitions/types/scalar.adoc, type-definitions/types/temporal.adoc, \
type-definitions/types/spatial.adoc

Neo4j GraphQL supports all of the default GraphQL https://graphql.org/learn/schema/#scalar-types[scalar types] as well as additional scalar and object types specific to the Neo4j database.

Expand Down
Loading