[
https://issues.apache.org/jira/browse/IGNITE-13853?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Denis A. Magda updated IGNITE-13853:
------------------------------------
Description:
There is user feedback that suggests we need to rework our navigation menus of
the website and docs to improve the discoverability of APIs and examples. Let's
do the following.
*Ignite Website Top-Level Navigation Menu
([https://ignite.apache.org)|https://ignite.apache.org)/]*
* Add the "Docs" menu item before the "Features" item. The "Docs" _is a single
link_ (not a dropdown menu) that directs to the root of the latest technical
documentation: [https://ignite.apache.org/docs/latest/]
* Rename "Resources" to "Learn More". Remove "Documentation", "Documentation
(Chinese)" and "APIs" from this menu section.
* Remove "Events" from the top-level menu. Add the items/links from the menu
to the "Community"
*Technical Documentation Top-Level Navigation Menu
([https://ignite.apache.org/docs/latest/])*
* Remove the Github icon from the menu
* Add "APIs" after the "version" selector. The menu lists "Java", "C#/.NET",
"C++", "Scala". The "version" selector defines what version of an API is to be
opened. For instance, if a user chooses version "2.9.1" (to be released soon)
then "Java" of that version is to be opened. If instead, the user wants to see
the docs and APIs for "2.9.0", he just needs to selects that version from the
version menu.
* Add "Examples" after the "APIs". Add the following menu items:
** "Java": [https://github.com/apache/ignite/tree/master/examples]
** "C#/.NET":
[https://github.com/apache/ignite/tree/master/modules/platforms/dotnet/examples]
** "C++":
[https://github.com/apache/ignite/tree/master/modules/platforms/cpp/examples]
** "Python":
[https://github.com/apache/ignite/tree/master/modules/platforms/python/examples]
** "Node.JS":
[https://github.com/apache/ignite/tree/master/modules/platforms/nodejs/examples]
** "PHP":
[https://github.com/apache/ignite/tree/master/modules/platforms/php/examples]
* Add a language selector drop-down list after the "search" text box. See how
it's implemented here: [https://www.confluent.io.|https://www.confluent.io./]
We'll have just two menu items there:
** "English": points out to the root of the main docs
[https://ignite.apache.org/docs/latest/]
** "Chinese": [https://www.ignite-service.cn/doc/java/]
was:
There is user feedback that suggests we need to rework our navigation menus of
the website and docs to improve the discoverability of APIs and examples. Let's
do the following.
*Ignite Website Top-Level Navigation Menu
([https://ignite.apache.org)|https://ignite.apache.org)/]*
* Add the "Docs" menu item before the "Features" item. The "Docs" _is a single
link_ (not a dropdown menu) that directs to the root of the latest technical
documentation: [https://ignite.apache.org/docs/latest/]
* Rename "Resources" to "Learn More". Remove "Documentation", "Documentation
(Chinese)" and "APIs" from this menu section.
* Remove "Events" from the top-level menu. Add the items/links from the menu
to the "Community"
*Technical Documentation Top-Level Navigation Menu
([https://ignite.apache.org/docs/latest/])*
* Remove the Github icon from the menu
* Add "APIs" after the "version" selector. The menu lists "JavaDocs",
"C#/.NET", "C++", "Scala". The "version" selector defines what version of an
API is to be opened. For instance, if a user chooses version "2.9.1" (to be
released soon) then "JavaDocs" of that version is to be opened. If instead, the
user wants to see the docs and APIs for "2.9.0", he just needs to selects that
version from the version menu.
* Add "Examples" after the "APIs". Add the following menu items:
** "Java": [https://github.com/apache/ignite/tree/master/examples]
** "C#/.NET":
[https://github.com/apache/ignite/tree/master/modules/platforms/dotnet/examples]
** "C++":
[https://github.com/apache/ignite/tree/master/modules/platforms/cpp/examples]
** "Python":
[https://github.com/apache/ignite/tree/master/modules/platforms/python/examples]
** "Node.JS":
[https://github.com/apache/ignite/tree/master/modules/platforms/nodejs/examples]
** "PHP":
[https://github.com/apache/ignite/tree/master/modules/platforms/php/examples]
* Add a language selector drop-down list after the "search" text box. See how
it's implemented here: [https://www.confluent.io.|https://www.confluent.io./]
We'll have just two menu items there:
** "English": points out to the root of the main docs
[https://ignite.apache.org/docs/latest/]
** "Chinese": [https://www.ignite-service.cn/doc/java/]
> Add APIs, examples, language selector to the docs menu
> ------------------------------------------------------
>
> Key: IGNITE-13853
> URL: https://issues.apache.org/jira/browse/IGNITE-13853
> Project: Ignite
> Issue Type: Improvement
> Components: documentation, website
> Reporter: Denis A. Magda
> Priority: Major
> Fix For: 2.9.1
>
>
> There is user feedback that suggests we need to rework our navigation menus
> of the website and docs to improve the discoverability of APIs and examples.
> Let's do the following.
>
> *Ignite Website Top-Level Navigation Menu
> ([https://ignite.apache.org)|https://ignite.apache.org)/]*
> * Add the "Docs" menu item before the "Features" item. The "Docs" _is a
> single link_ (not a dropdown menu) that directs to the root of the latest
> technical documentation: [https://ignite.apache.org/docs/latest/]
> * Rename "Resources" to "Learn More". Remove "Documentation", "Documentation
> (Chinese)" and "APIs" from this menu section.
> * Remove "Events" from the top-level menu. Add the items/links from the menu
> to the "Community"
>
> *Technical Documentation Top-Level Navigation Menu
> ([https://ignite.apache.org/docs/latest/])*
> * Remove the Github icon from the menu
> * Add "APIs" after the "version" selector. The menu lists "Java", "C#/.NET",
> "C++", "Scala". The "version" selector defines what version of an API is to
> be opened. For instance, if a user chooses version "2.9.1" (to be released
> soon) then "Java" of that version is to be opened. If instead, the user wants
> to see the docs and APIs for "2.9.0", he just needs to selects that version
> from the version menu.
> * Add "Examples" after the "APIs". Add the following menu items:
> ** "Java": [https://github.com/apache/ignite/tree/master/examples]
> ** "C#/.NET":
> [https://github.com/apache/ignite/tree/master/modules/platforms/dotnet/examples]
> ** "C++":
> [https://github.com/apache/ignite/tree/master/modules/platforms/cpp/examples]
> ** "Python":
> [https://github.com/apache/ignite/tree/master/modules/platforms/python/examples]
> ** "Node.JS":
> [https://github.com/apache/ignite/tree/master/modules/platforms/nodejs/examples]
> ** "PHP":
> [https://github.com/apache/ignite/tree/master/modules/platforms/php/examples]
> * Add a language selector drop-down list after the "search" text box. See
> how it's implemented here:
> [https://www.confluent.io.|https://www.confluent.io./] We'll have just two
> menu items there:
> ** "English": points out to the root of the main docs
> [https://ignite.apache.org/docs/latest/]
> ** "Chinese": [https://www.ignite-service.cn/doc/java/]
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
