Lorenzo Nicora created FLINK-40383:
--------------------------------------

             Summary: Concept Glossary should be ordered alphabetically
                 Key: FLINK-40383
                 URL: https://issues.apache.org/jira/browse/FLINK-40383
             Project: Flink
          Issue Type: Improvement
          Components: Documentation
            Reporter: Lorenzo Nicora


The [Flink 
Glossary|https://nightlies.apache.org/flink/flink-docs-stable/docs/concepts/glossary/]
 entries are in alphabetical order.

A Glossary should be easily searchable for a specific term, with a ToC, or 
organized in subsection by theme, or in a predictable order (alphabetical).

In the Glossary, entries are organized with no clear criterial. There is some 
clustering by theme (e.g. {_}Flink Application Cluster{_}, {_}Flink Job 
Cluster{_}, {_}Flink Cluster{_}, but _Flink Session Cluster_ is elsewhere); 
other related concepts are ordered alphabetically (e.g. {_}Logical Graph{_}, 
{_}Physical Graph{_}); in some cases the prefix "Flink" is considered for the 
alphabetical ordering, in other is ignored.

The proposal is to order everything alphabetically, ignoring the prefix "Flink" 
to avoid a huge cluster around the "F".

Note: this issue was part of FLINK-40282, split to simplify reviewing



--
This message was sent by Atlassian Jira
(v8.20.10#820010)

Reply via email to