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

Closed
wants to merge 2 commits into from
Closed

Add aliases to 3.x #129

wants to merge 2 commits into from

Conversation

rsill-neo4j
Copy link
Contributor

No description provided.

@@ -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.)

@@ -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

@rsill-neo4j
Copy link
Contributor Author

closing this PR since 3.x is the earliest version and there should not be aliases in that version for later versions

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.

3 participants