[
https://issues.apache.org/jira/browse/YUNIKORN-2274?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Yu-Lin Chen updated YUNIKORN-2274:
----------------------------------
Description:
When changing document version on YuniKorn document page, it alway redirects to
root page, ex:
* [https://yunikorn.apache.org/docs/next/] (Master/Next)
* [https://yunikorn.apache.org/docs/] (Current)
* [https://yunikorn.apache.org/docs/1.3.0] (Other version)
We can enable the build-in navbar item
‘[docsVersionDropdown|https://docusaurus.io/docs/next/versioning#navbar-items]’
in docusaurus, allowing the framework handle versioned routes.
For example:
# Go to any sub-page in the user_guide,
such as: [http://localhost:3000/docs/user_guide/sorting_policies] (1.4.0)
# Change version to 1.3.0 and it will route to:
Was: [http://localhost:3000/docs/1.3.0/]
Will be: [http://localhost:3000/docs/1.3.0/user_guide/sorting_policies]
Reference:
# You could try switching from '3.0.1' to '2.x' on this website:
[https://docusaurus.io/docs/api/themes/configuration]
# The source code of reference page.
[https://github.com/facebook/docusaurus/blob/main/website/docusaurus.config.ts#L575-L577]
was:
When changing document version on YuniKorn document page, it alway redirects to
root page, ex:
* [https://yunikorn.apache.org/docs/next/] (Master/Next)
* [https://yunikorn.apache.org/docs/(Current)]
* [https://yunikorn.apache.org/docs/1.3.0] (Other version)
We can enable the build-in navbar item
‘[docsVersionDropdown|https://docusaurus.io/docs/next/versioning#navbar-items]’
in docusaurus, allowing the framework handle versioned routes.
For example:
# Go to any sub-page in the user_guide, such as:
[http://localhost:3000/docs/user_guide/sorting_policies] (1.4.0)
# Change version to 1.3.0 and it will route to:
Was: [http://localhost:3000/docs/1.3.0/]
Will be: [http://localhost:3000/docs/1.3.0/user_guide/sorting_policies]
Reference:
# You could try switching from '3.0.1' to '2.x' on this website:
[https://docusaurus.io/docs/api/themes/configuration]
# The source code of reference page.
[https://github.com/facebook/docusaurus/blob/main/website/docusaurus.config.ts#L575-L577]
> Improve document version routing in YuniKorn documentation
> ----------------------------------------------------------
>
> Key: YUNIKORN-2274
> URL: https://issues.apache.org/jira/browse/YUNIKORN-2274
> Project: Apache YuniKorn
> Issue Type: Improvement
> Components: documentation
> Reporter: Yu-Lin Chen
> Assignee: Yu-Lin Chen
> Priority: Major
>
> When changing document version on YuniKorn document page, it alway redirects
> to root page, ex:
> * [https://yunikorn.apache.org/docs/next/] (Master/Next)
> * [https://yunikorn.apache.org/docs/] (Current)
> * [https://yunikorn.apache.org/docs/1.3.0] (Other version)
> We can enable the build-in navbar item
> ‘[docsVersionDropdown|https://docusaurus.io/docs/next/versioning#navbar-items]’
> in docusaurus, allowing the framework handle versioned routes.
> For example:
> # Go to any sub-page in the user_guide,
> such as: [http://localhost:3000/docs/user_guide/sorting_policies] (1.4.0)
> # Change version to 1.3.0 and it will route to:
> Was: [http://localhost:3000/docs/1.3.0/]
> Will be: [http://localhost:3000/docs/1.3.0/user_guide/sorting_policies]
> Reference:
> # You could try switching from '3.0.1' to '2.x' on this website:
> [https://docusaurus.io/docs/api/themes/configuration]
> # The source code of reference page.
> [https://github.com/facebook/docusaurus/blob/main/website/docusaurus.config.ts#L575-L577]
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
